IDSSReportDefinition Interface Reference

Inherited by IDSSReportDefinition2.

List of all members.

---

Detailed Description

This interface is used to represent a definition of a report.

A report object represents a specific occasion in which information is retrieved from the data warehouse. A report can also give supplementary information about this retrieval process; for example, it can give the SQL that is needed to pull the required information from the warehouse.

A report definition is an object that can be stored in the metadata and which contains the information needed to generate a report object. Every report object also contains a report definition object. The report definition does not have to be stored in the metadata.

IDSSReportDefinition is the top-level interface used to represent a report definition. It exposes a report definition as a template (IDSSTemplate) and a filter (IDSSFilter) combination.

Public Member Functions
HRESULT	BaseReport ([in] IDSSReportDefinition *pBaseReport)
	The ID of the base report.
HRESULT	BaseReport ([out, retval] IDSSReportDefinition ppBaseReport)
	The ID of the base report.
HRESULT	DeclinePrompts ([in] VARIANT_BOOL DeclinePrompt)
	Whether the report should be ran without prompting by default.
HRESULT	DeclinePrompts ([out, retval] VARIANT_BOOL *pDeclinePrompt)
	Whether the report should be ran without prompting by default.
HRESULT	DisplayMode ([in] EnumDSSDisplayMode DisplayMode)
	Determines whether the report is displayed as a graph or a grid.
HRESULT	DisplayMode ([out, retval] EnumDSSDisplayMode *pDisplayMode)
	Determines whether the report is displayed as a graph or a grid.
HRESULT	Filter ([in] IDSSFilter *pFilter)
	The filter object that describes which data is used in the report.
HRESULT	Filter ([out, retval] IDSSFilter ppFilter)
	The filter object that describes which data is used in the report.
HRESULT	FilterPrompt ([in] IDSSPrompt *pPrompt)
	Prompt for the filter property The property records the prompt for the filter property.
HRESULT	FilterPrompt ([out, retval] IDSSPrompt ppPrompt)
	Prompt for the filter property The property records the prompt for the filter property.
HRESULT	HistoricalCost ([in] Int32 HistoricalCost)
	Cost of this report as determined by the system The property records the cost of this report as determined by the system.
HRESULT	HistoricalCost ([out, retval] Int32 *pHistoricalCost)
	Cost of this report as determined by the system The property records the cost of this report as determined by the system.
HRESULT	Info ([out, retval] IDSSObjectInfo ppInfo)
	The IDSSObjectInfo interface on this report.
HRESULT	Populate ([in] IDSSReportDefinition *pOriginal)
	Populates this report's value from an existing report.
HRESULT	PropertyTargets ([out, retval] IDSSFolder ppPropertyTargets)
	A collection of ObjectInfos to override the property values for objects that are embedded in the current object.
HRESULT	ReportType ([in] EnumDSSReportType ReportType)
	A base report or a view.
HRESULT	ReportType ([out, retval] EnumDSSReportType *pReportType)
	A base report or a view.
HRESULT	Resolution ([in] IDSSResolution *pResolution)
	Resolution object for prompts used in this report definition.
HRESULT	Resolution ([out, retval] IDSSResolution ppResolution)
	Resolution object for prompts used in this report definition.
HRESULT	Template ([in] IDSSTemplate *pTemplate)
	The template object that describes what data is to be displayed.
HRESULT	Template ([out, retval] IDSSTemplate ppTemplate)
	The template object that describes what data is to be displayed.
HRESULT	TemplatePrompt ([in] IDSSPrompt *pPrompt)
	Prompt for the template property The property records the prompt for the template property.
HRESULT	TemplatePrompt ([out, retval] IDSSPrompt ppPrompt)
	Prompt for the template property The property records the prompt for the template property.
HRESULT	UserSuppliedCost ([in] Int32 UserSuppliedCost)
	Cost of this report as specified by user The property records the cost of this report as specified by user.
HRESULT	UserSuppliedCost ([out, retval] Int32 *pUserSuppliedCost)
	Cost of this report as specified by user The property records the cost of this report as specified by user.
HRESULT	Views ([out, retval] IDSSTemplates ppViews)
	Collection of DSS Templates used to specify multiple possible views of this report The read-only property returns an IDSSTemplates interface which describes a collection of DSS Templates used to specify multiple possible views of this report.

---

Member Function Documentation

HRESULT IDSSReportDefinition::BaseReport (  [in] IDSSReportDefinition *  pBaseReport  )

The ID of the base report. This property gives the base report associated with this report. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::BaseReport (  [out, retval] IDSSReportDefinition   ppBaseReport  )

The ID of the base report. This property gives the base report associated with this report. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::DeclinePrompts (  [in] VARIANT_BOOL  DeclinePrompt  )

Whether the report should be ran without prompting by default. True = User will not be asked prompts found in report. DeclinePrompts is a Boolean property. The DeclinePrompts property is used to record the desire of the designer of the report. This property allows a designer to save a report with a fixed resolution. When the report is executed, the user does not see the prompts; however, if the user asks to re-prompt the report, the user sees the prompts. This property defaults to False on a newly created report instance. Parameters: DeclinePrompt  New value for the DeclinePrompts property. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::DeclinePrompts (  [out, retval] VARIANT_BOOL *  pDeclinePrompt  )

Whether the report should be ran without prompting by default. True = User will not be asked prompts found in report. DeclinePrompts is a Boolean property. The DeclinePrompts property is used to record the desire of the designer of the report. This property allows a designer to save a report with a fixed resolution. When the report is executed, the user does not see the prompts; however, if the user asks to re-prompt the report, the user sees the prompts. This property defaults to False on a newly created report instance. Parameters: pDeclinePrompt  Existing value for the DeclinePrompts property. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::DisplayMode (  [in] EnumDSSDisplayMode  DisplayMode  )

Determines whether the report is displayed as a graph or a grid. DisplayMode is an enumeration property that records the preferred display (i.e., grid, graph, engine, or text) of the report definition. When a report instance based on this definition is executed, it is displayed in this mode by False. This property is used to define the subtype of a report definition. This allows a GUI to distinguish between grid and graph reports without having to load in the report definition. The following table lists the values in the enumeration. Symbol Value Meaning DssDisplayModeReserved 0 Never used. DssDisplayModeGrid 1 The report is displayed as a grid (by default). DssDisplayModeGraph 2 The report is displayed as a graph (by default). DssDisplayModeEngine 3 The report is displayed as SQL (by default). DssDisplayModeText 4 The report should be displayed as text (not implemented). DssDisplayModeDatamart 5 The report should be considered as a datamart report. DssDisplayModeBase 6 This report is a designated base report. It's only used as a base report, never shown to the user. Parameters: DisplayMode  The new display mode of this report. Returns: Usual COM result code: S_OK DSS_COM_E_RESERVED_VALUE Specific error returned if DisplayMode is set to DssDisplayModeReserved on entry. E_INVALIDARG DisplayMode is not a value in the enumeration.

HRESULT IDSSReportDefinition::DisplayMode (  [out, retval] EnumDSSDisplayMode *  pDisplayMode  )

Determines whether the report is displayed as a graph or a grid. DisplayMode is an enumeration property that records the preferred display (i.e., grid, graph, engine, or text) of the report definition. When a report instance based on this definition is executed, it is displayed in this mode by False. This property is used to define the subtype of a report definition. This allows a GUI to distinguish between grid and graph reports without having to load in the report definition. The following table lists the values in the enumeration. Symbol Value Meaning DssDisplayModeReserved 0 Never used. DssDisplayModeGrid 1 The report is displayed as a grid (by default). DssDisplayModeGraph 2 The report is displayed as a graph (by default). DssDisplayModeEngine 3 The report is displayed as SQL (by default). DssDisplayModeText 4 The report should be displayed as text (not implemented). DssDisplayModeDatamart 5 The report should be considered as a datamart report. DssDisplayModeBase 6 This report is a designated base report. It's only used as a base report, never shown to the user. Parameters: pDisplayMode  The current display mode of this report. Returns: Usual COM result code: S_OK DSS_COM_E_RESERVED_VALUE Specific error returned if DisplayMode is set to DssDisplayModeReserved on entry. E_INVALIDARG DisplayMode is not a value in the enumeration.

HRESULT IDSSReportDefinition::Filter (  [in] IDSSFilter *  pFilter  )

The filter object that describes which data is used in the report. This property gives the filter associated with this report. The report considers only data that passes this filter (although individual metrics can supply a filter). The filter is stored by storing its DSS_ID. Parameters: pFilter  Pointer to a persisted filter object. If NULL, then the empty filter is used. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::Filter (  [out, retval] IDSSFilter   ppFilter  )

The filter object that describes which data is used in the report. This property gives the filter associated with this report. The report considers only data that passes this filter (although individual metrics can supply a filter). The filter is stored by storing its DSS_ID. Parameters: ppFilter  The filter associated with this report definition. NULL if there is none. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::FilterPrompt (  [in] IDSSPrompt *  pPrompt  )

Prompt for the filter property The property records the prompt for the filter property. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::FilterPrompt (  [out, retval] IDSSPrompt   ppPrompt  )

Prompt for the filter property The property records the prompt for the filter property. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::HistoricalCost (  [in] Int32  HistoricalCost  )

Cost of this report as determined by the system The property records the cost of this report as determined by the system. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::HistoricalCost (  [out, retval] Int32 *  pHistoricalCost  )

Cost of this report as determined by the system The property records the cost of this report as determined by the system. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::Info (  [out, retval] IDSSObjectInfo   ppInfo  )

The IDSSObjectInfo interface on this report. This property returns the IDSSObjectInfo interface associated with the current object. This interface contains many standard properties and methods. For example, it contains a Name property and a Comments property, and it contains methods to Save the object. The implementation must determine whether the same interface could be obtained by calling QueryInterface(IID_DSSObjectInfo, ...). Parameters: ppInfo  The standard Info interface of the current object. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::Populate (  [in] IDSSReportDefinition *  pOriginal  )

Populates this report's value from an existing report. This method acts like an assignment operator in C++. It replaces the definition of the current object with the definition of the argument. It is used to clone the argument object. Parameters: pOriginal  The original object. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::PropertyTargets (  [out, retval] IDSSFolder   ppPropertyTargets  )

A collection of ObjectInfos to override the property values for objects that are embedded in the current object. Supports targeted property values. Returns a collection of ObjectInfos to override the property values for objects embedded in the current object. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::ReportType (  [in] EnumDSSReportType  ReportType  )

A base report or a view. This is an enumeration property that records what type this report is. The put method is obsolete. This property should be read-only. The following table lists the symbols in the enumeration. Symbol Value Meaning DssReportTypeReserved 0 Never used. DssReportTypeBase 1 This report is an ordinary or designated base report. We use the display mode (or subtype) to distinguish whether this is a regular or designated-base report. DssReportTypeSubset 2 This report is a designated subset report. DssReportTypePrivateBase 3 This report is the base of a working set report. DssReportTypePrivateSubset 4 This report is the subset (view) of a working set report. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::ReportType (  [out, retval] EnumDSSReportType *  pReportType  )

A base report or a view. This is an enumeration property that records what type this report is. The put method is obsolete. This property should be read-only. The following table lists the symbols in the enumeration. Symbol Value Meaning DssReportTypeReserved 0 Never used. DssReportTypeBase 1 This report is an ordinary or designated base report. We use the display mode (or subtype) to distinguish whether this is a regular or designated-base report. DssReportTypeSubset 2 This report is a designated subset report. DssReportTypePrivateBase 3 This report is the base of a working set report. DssReportTypePrivateSubset 4 This report is the subset (view) of a working set report. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::Resolution (  [in] IDSSResolution *  pResolution  )

Resolution object for prompts used in this report definition. Resolution is an IDSSResolution valued property that records a reference to a DSS Resolution object. A DSS Resolution object is used to store a list of prompt answers. If this property is not Nothing and if the report is executed without its executor providing an explicit reference to a different resolution object, then the report server will use this resolution to provide answers to prompts found in the report. When a report definition is created. This property is set to Nothing. The Resolution object may be embedded in the report definition. When a user calls IDSSReportInstance::SaveAs to save a report definition based on a report instance, the new report definition might contain a resolution object. There is no resolution object if there are no prompts. Parameters: pResolution  Pointer to a persisted resolution object. May be NULL. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::Resolution (  [out, retval] IDSSResolution   ppResolution  )

Resolution object for prompts used in this report definition. Resolution is an IDSSResolution valued property that records a reference to a DSS Resolution object. A DSS Resolution object is used to store a list of prompt answers. If this property is not Nothing and if the report is executed without its executor providing an explicit reference to a different resolution object, then the report server will use this resolution to provide answers to prompts found in the report. When a report definition is created. This property is set to Nothing. The Resolution object may be embedded in the report definition. When a user calls IDSSReportInstance::SaveAs to save a report definition based on a report instance, the new report definition might contain a resolution object. There is no resolution object if there are no prompts. Parameters: ppResolution  An instance of the resolution associated with this report definition. May be NULL. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::Template (  [in] IDSSTemplate *  pTemplate  )

The template object that describes what data is to be displayed. This property gives the template associated with this report. The report returns only the data that is requested in this template. The data is sorted in the database to agree with the template as much as possible. The template is stored by storing its ObjectID. There is no natural default choice for a template. Parameters: pTemplate  Reference to a template object. May not be NULL. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::Template (  [out, retval] IDSSTemplate   ppTemplate  )

The template object that describes what data is to be displayed. This property gives the template associated with this report. The report returns only the data that is requested in this template. The data is sorted in the database to agree with the template as much as possible. The template is stored by storing its ObjectID. There is no natural default choice for a template. Parameters: ppTemplate  Reference to the current template object. Initially NULL but not NULL on a well-defined report. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::TemplatePrompt (  [in] IDSSPrompt *  pPrompt  )

Prompt for the template property The property records the prompt for the template property. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::TemplatePrompt (  [out, retval] IDSSPrompt   ppPrompt  )

Prompt for the template property The property records the prompt for the template property. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::UserSuppliedCost (  [in] Int32  UserSuppliedCost  )

Cost of this report as specified by user The property records the cost of this report as specified by user. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::UserSuppliedCost (  [out, retval] Int32 *  pUserSuppliedCost  )

Cost of this report as specified by user The property records the cost of this report as specified by user. Returns: Usual COM result code: S_OK

HRESULT IDSSReportDefinition::Views (  [out, retval] IDSSTemplates   ppViews  )

Collection of DSS Templates used to specify multiple possible views of this report The read-only property returns an IDSSTemplates interface which describes a collection of DSS Templates used to specify multiple possible views of this report. Returns: Usual COM result code: S_OK

---