IDSSAttribute2 Interface Reference

Inherits IDSSAttribute.

Inherited by IDSSAttribute3.

List of all members.

---

Detailed Description

Specific interface implemented by attribute and attribute wrapper objects.

This is an extension of the IDSSAttribute interface. Attribute wrappers also implement the specific interface IDSSAttributeWrapper.

A DSS Attribute object specifies a classification of the data in the warehouse. This interface provides functionality related to the association of an attribute with other objects that define it. The association is done by objects called attribute wrappers. The association could not be done inside the attribute objects, since they may have multiple definitions in different defining contexts, e.g. an attribute may be supported by different tables.

See also:

IDSSAttribute

IDSSAttributeWrapper

Public Member Functions
HRESULT	AllForms ([out, retval] IDSSAttributeForms oppForms)
	Get a read-only collection of all forms in the attribute.
HRESULT	LocalBrowseForms ([out, retval] IDSSAttributeForms oppForms)
	Get the local browse forms in the attribute.
HRESULT	LocalTemplateForms ([out, retval] IDSSAttributeForms oppForms)
	Get the local template forms in the attribute.
HRESULT	LookupForm ([in] VARIANT *ipIndex,[out, retval] IDSSAttributeForm oppForm)
	Lookup the form in both the Forms and XDAForms collection.
HRESULT	NewWrapper ([out, retval] IDSSAttributeWrapper oppWrapper)
	Create and return a wrapper for the attribute.
HRESULT	UnusedBaseFormID ([out, retval] Int32 *opBaseFormID)
	Get the next unsued base form id in the attribute.
HRESULT	Wrapper ([out, retval] IDSSAttributeWrapper oppWrapper)
	Get the wrapper specific interface of a wrapper object.
HRESULT	XDAForms ([out, retval] IDSSAttributeForms oppForms)
	Get the xda forms in the attribute.

---

Member Function Documentation

HRESULT IDSSAttribute2::AllForms (  [out, retval] IDSSAttributeForms   oppForms  )

Get a read-only collection of all forms in the attribute. Parameters: oppForms  The forms in the attribute.

HRESULT IDSSAttribute2::LocalBrowseForms (  [out, retval] IDSSAttributeForms   oppForms  )

Get the local browse forms in the attribute. The local browse forms are the browse forms that are stored locally in the attribute. This is different than the get_BrowseForms in the IDSSAttribute interface, which returns the browse forms in the system dimension if the attribute exists in the system dimension. Parameters: oppForms  The local browse forms in the attribute.

HRESULT IDSSAttribute2::LocalTemplateForms (  [out, retval] IDSSAttributeForms   oppForms  )

Get the local template forms in the attribute. The local template forms are the template forms that are stored locally in the attribute. This is different than the get_TemplateForms in the IDSSAttribute interface, which returns the template forms in the system dimension if the attribute exists in the system dimension. Parameters: oppForms  The local template forms in the attribute.

HRESULT IDSSAttribute2::LookupForm (  [in] VARIANT *  ipIndex, [out, retval] IDSSAttributeForm   oppForm )

Lookup the form in both the Forms and XDAForms collection. This function will not log an error message if the form is not found. Parameters: ipIndex  The index of the form oppForm  The attribute form

HRESULT IDSSAttribute2::NewWrapper (  [out, retval] IDSSAttributeWrapper   oppWrapper  )

Create and return a wrapper for the attribute. This initial wrapper does not refer to any dimension or table. To set the defining objects (DSS Dimension, DSS Table) on the wrapper, use the methods of the specific interface ICDSSAttributeWrapper. Parameters: oppWrapper  An attribute wrapper. When called on an attribute wrapper, this method returns a new wrapper object over the same attribute.

HRESULT IDSSAttribute2::UnusedBaseFormID (  [out, retval] Int32 *  opBaseFormID  )

Get the next unsued base form id in the attribute. In other words this base form id is not used by any attribute form in the attribute. Parameters: opBaseFormID  The next base form ID in the attribute.

HRESULT IDSSAttribute2::Wrapper (  [out, retval] IDSSAttributeWrapper   oppWrapper  )

Get the wrapper specific interface of a wrapper object. This is to be used only for wrappers. For attribute objects it returns NULL. Parameters: oppWrapper  The attribute wrapper interface.

HRESULT IDSSAttribute2::XDAForms (  [out, retval] IDSSAttributeForms   oppForms  )

Get the xda forms in the attribute. The xda forms are the forms that are defined in the xda schemas. Parameters: oppForms  The xda forms in the attribute.

---