com.sap.tc.col.client.metadata.api
Interface IRelationDescriptor

public interface IRelationDescriptor

Describes the properties of a relation between two aspects.

Field Summary

static java.lang.String	ATTRIBUTE_PAGING_MODE The backend name of the system attribute PagingMode.
static java.lang.String	ATTRIBUTE_TARGET_CARDINALITY The backend name of the system attribute TargetCardinality.
static java.lang.String	PAGING_MODE_FORWARD_PAGING Possible value for attribute PagingMode: forward paging is switched on.
static java.lang.String	PAGING_MODE_NO_PAGING Possible value for attribute PagingMode: paging is switched off.

Method Summary

java.lang.String[]	getAttributeNames() Returns an array with the names of all the attributes which are set for this relation.
java.lang.String[]	getAttributeNames(java.lang.String rowKey) Returns an array with the names of all the attributes which are set for this relation in the specified source aspect row.
java.lang.String	getAttributePagingMode() Returns the paging mode supported by this relation.
java.lang.String	getAttributeStringValue(java.lang.String attributeName) Returns the value that is stored in this relation for the given attribute.
java.lang.String	getAttributeStringValue(java.lang.String rowKey, java.lang.String attributeName) Returns the value that is stored in this relation for the given attribute in the specified source aspect row.
com.sap.tc.cmi.metadata.CMICardinality	getAttributeTargetCardinality() Returns the cardinality of the target.
IStructureDescriptor	getInputOptions() Returns the input options structure for this relation.
java.lang.String	getName() Returns the name of the relation.
IStructureDescriptor	getSelections() Returns the selections structure for this relation.
IServiceModuleDescriptor	getServiceModuleDescriptor() Returns the descriptor of the service module in which this relation is cached.
IStructureDescriptor	getSortingOptions() Returns the sorting options structure for this relation.
IAspectDescriptor	getSourceAspectDescriptor() Returns the descriptor of the source aspect of this relation.
IAspectDescriptor	getTargetAspectDescriptor() Returns the descriptor of the target aspect of this relation.

Field Detail

ATTRIBUTE_PAGING_MODE

public static final java.lang.String ATTRIBUTE_PAGING_MODE

The backend name of the system attribute PagingMode.

ATTRIBUTE_TARGET_CARDINALITY

public static final java.lang.String ATTRIBUTE_TARGET_CARDINALITY

The backend name of the system attribute TargetCardinality.

PAGING_MODE_NO_PAGING

public static final java.lang.String PAGING_MODE_NO_PAGING

Possible value for attribute PagingMode: paging is switched off.

PAGING_MODE_FORWARD_PAGING

public static final java.lang.String PAGING_MODE_FORWARD_PAGING

Possible value for attribute PagingMode: forward paging is switched on.

Method Detail

getName

public java.lang.String getName()

Returns the name of the relation.

Returns:

name of the relation.

getSourceAspectDescriptor

public IAspectDescriptor getSourceAspectDescriptor()

Returns the descriptor of the source aspect of this relation.

Returns:

the source aspect descriptor

getTargetAspectDescriptor

public IAspectDescriptor getTargetAspectDescriptor()

Returns the descriptor of the target aspect of this relation.

Returns:

the target aspect descriptor

getServiceModuleDescriptor

public IServiceModuleDescriptor getServiceModuleDescriptor()

Returns the descriptor of the service module in which this relation is cached.

Returns:

the service module descriptor

getInputOptions

public IStructureDescriptor getInputOptions()

Returns the input options structure for this relation.

Returns:

the input options structure descriptor or null

getSortingOptions

public IStructureDescriptor getSortingOptions()

Returns the sorting options structure for this relation.

Returns:

the sorting options structure descriptor or null

getSelections

public IStructureDescriptor getSelections()

Returns the selections structure for this relation.

Returns:

the selections structure descriptor or null

getAttributeStringValue

public java.lang.String getAttributeStringValue(java.lang.String attributeName)

Returns the value that is stored in this relation for the given attribute. Attribute names are case sensitive. If the attribute is not stored in this relation, null ist returned.

Parameters:

attributeName - The name of the attribute.

Returns:

The value of the attribute or null.

getAttributeNames

public java.lang.String[] getAttributeNames()

Returns an array with the names of all the attributes which are set for this relation.

Returns:

the attribute names.

getAttributeStringValue

public java.lang.String getAttributeStringValue(java.lang.String rowKey,
                                                java.lang.String attributeName)

Returns the value that is stored in this relation for the given attribute in the specified source aspect row. Attribute names are case sensitive. If the attribute is not stored in this relation, null ist returned. This method will return the value that was dynamically set for the attribute of this relation for the given source aspect row. If no value was set dynamically, the attribute value which was statically set for this relation is returned.

Parameters:

rowKey - The key of the source aspect row

attributeName - The name of the attribute.

Returns:

The value of the attribute or null.

getAttributeNames

public java.lang.String[] getAttributeNames(java.lang.String rowKey)

Returns an array with the names of all the attributes which are set for this relation in the specified source aspect row. This method will return a full list of available attributes for this relation in the given aspect row, which can be accessed using getAttributeStringValue(String rowKey, String attributeName)

Parameters:

rowKey - The key of the source aspect row

Returns:

the attribute names.

See Also:

getAttributeStringValue(String, String)

getAttributePagingMode

public java.lang.String getAttributePagingMode()

Returns the paging mode supported by this relation. See the Paging section of the Cool SPI specs for more details on the meaning of this attribute. Supported values:

• initial (blank)
• FORWARD

Default value: blank You are advised to use the constants provided in this interface instead of literal string values.

Returns:

the paging mode supported by this query

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_PAGING_MODE' for this relation.

See Also:

PAGING_MODE_NO_PAGING, PAGING_MODE_FORWARD_PAGING

getAttributeTargetCardinality

public com.sap.tc.cmi.metadata.CMICardinality getAttributeTargetCardinality()

Returns the cardinality of the target. If the target cardinality is unspecified, the method returns null

Returns:

Target Cardinality or null

See Also:

CMICardinality#CARDINALITY_ZERO_TO_ONE, CMICardinality#CARDINALITY_ONE, CMICardinality#CARDINALITY_MANY, CMICardinality#CARDINALITY_ONE_TO_MANY