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

All Known Subinterfaces:

IKeyAspectDescriptor

public interface IAspectDescriptor

Describes the properties of an aspect.

Field Summary

static java.lang.String	ATTRIBUTE_EXTERNAL_KEYS The backend name of the system attribute ExternalKeys.
static java.lang.String	ATTRIBUTE_FIELDWISE_OPERATION The backend name of the system attribute FieldwiseOperation.
static java.lang.String	ATTRIBUTE_INSERT_RELATION The backend name of the system attribute InsertRelation.
static java.lang.String	ATTRIBUTE_INSERT_RELATION_REQUIRED The backend name of the system attribute InsertRelationRequired.
static java.lang.String	ATTRIBUTE_LOCKMODE_EXCLUSIVE The backend name of the system attribute LockmodeExclusive.
static java.lang.String	ATTRIBUTE_LOCKMODE_SHARED The backend name of the system attribute LockmodeShared.
static java.lang.String	ATTRIBUTE_LOCKMODE_SHARED_PROMOTABLE The backend name of the system attribute LockmodeSharedPromotable.
static java.lang.String	ATTRIBUTE_MULTI_INSTANCE_SUPPORT The backend name of the system attribute MultiInstanceSupport.
static java.lang.String	ATTRIBUTE_NO_CHANGE The backend name of the system attribute NoChange.
static java.lang.String	ATTRIBUTE_ROWWISE_OPERATION The backend name of the system attribute RowwiseOperation.

Method Summary

void	clearRowAttributes() Clears all dynamically set attribute values that are currently cached in this aspect descriptor for any rows.
void	clearRowAttributes(java.lang.String rowKey) Clears all dynamically set attribute values for the given aspect row.
int	getActionAttributeAffects(java.lang.String actionName) Returns which side effects are to be excpected when performing the given aspect action.
int	getActionAttributeAffects(java.lang.String rowKey, java.lang.String actionName) Returns which side effects are to be excpected when performing the given aspect action on the given aspect row.
java.lang.String[]	getActionAttributeNames(java.lang.String actionName) Returns an array with the names of all the attributes for a specified action.
java.lang.String[]	getActionAttributeNames(java.lang.String rowKey, java.lang.String actionName) Returns an array with the names of all the attributes which are set for an action of the given aspect row.
java.lang.String	getActionAttributeRelation(java.lang.String actionName) Returns the name of the relation whose target aspect the action can affect for the given aspect action.
java.lang.String	getActionAttributeStringValue(java.lang.String actionName, java.lang.String attributeName) Returns the value that is stored in the aspect for the given attribute of the given action.
java.lang.String	getActionAttributeStringValue(java.lang.String rowKey, java.lang.String actionName, java.lang.String attributeName) Returns the value that is stored for the given attribute for the given aspect row.
IAspectActionDescriptor	getAspectActionDescriptor(java.lang.String name) Returns the descriptor of the aspect action with the specified name
IAspectActionDescriptor[]	getAspectActionDescriptors() Returns an array with descriptors of all aspect actions.
IAspectGroupDescriptor	getAspectGroupDescriptor(java.lang.String name) Returns the descriptor of the aspect group with the specified name
IAspectGroupDescriptor[]	getAspectGroupDescriptors() Returns an array with descriptors of all aspect groups.
boolean	getAttributeExternalKeys() Returns whether externally provided keys can be provided at newly created objects.
boolean	getAttributeFieldwiseOperation() Returns whether field wise operations are available in this aspect.
java.lang.String	getAttributeInsertRelation() Returns the name of the relation to the aspect of which a record can be specified as related to records which are inserted in this aspect.
boolean	getAttributeInsertRelationRequired() Returns whether the insert operation of this aspect requires the object to which the inserted object(s) are related to be specified.
boolean	getAttributeLockmodeExclusive() Returns whether the exclusive lock mode is supported.
boolean	getAttributeLockmodeShared() Returns whether the shared lock mode is supported.
boolean	getAttributeLockmodeSharedPromotable() Returns whether the shared promotable lock mode is supported.
boolean	getAttributeMultiInstanceSupport() Returns whether Update/Insert/Actions can act on multiple instances.
java.lang.String[]	getAttributeNames() Returns an array with the names of all the attributes which are set for this aspect.
boolean	getAttributeNoChange() Returns whether Update/Insert/Delete or Action without COL_AFFECTS_NOTHING attribute being set is supported in this aspect.
boolean	getAttributeRowwiseOperation() Returns whether row wise operations are available in this aspect.
java.lang.String	getAttributeStringValue(java.lang.String attributeName) Returns the value that is stored in the aspect for the given attribute.
java.lang.String	getDescription() Returns the description of this aspect.
java.lang.String[]	getFieldAttributeNames(java.lang.String fieldName) Returns an array with the names of all the attributes for a specified field.
java.lang.String[]	getFieldAttributeNames(java.lang.String rowKey, java.lang.String fieldName) Returns an array with the names of all the attributes which are set for a structure field of given aspect row.
java.lang.String	getFieldAttributeStringValue(java.lang.String fieldName, java.lang.String attributeName) Returns the value that is stored in the aspect for the given attribute of the given field.
java.lang.String	getFieldAttributeStringValue(java.lang.String rowKey, java.lang.String fieldName, java.lang.String attributeName) Returns the value that is stored for the given attribute for the given aspect row.
IKeyAspectDescriptor	getKeyDescriptor() Returns the key aspect descriptor for this aspect.
java.lang.String	getName() Returns the name of the aspect.
IRelationDescriptor	getRelationDescriptor(java.lang.String name) Returns the descriptor for the relation with the specified name.
IRelationDescriptor[]	getRelationDescriptors() Returns an array with descriptors of all relations for which this aspect is the source aspect.
IServiceModuleDescriptor	getServiceModuleDescriptor() Returns the service module descriptor of the service module for which this aspect is cached in the repository.
IStructureDescriptor	getStructure() Returns the structure desciptor for aspect rows of this aspect.
IValueSetDescriptor	getValueSetDescriptor(java.lang.String fieldName) Returns the value set descriptor for the given field of the aspect structure.
boolean	isKeyAspect() Returns whether this aspect is a key aspect.
java.lang.String	toString() returns a string representation of this AspectDescriptor for test purposes only

Field Detail

ATTRIBUTE_EXTERNAL_KEYS

public static final java.lang.String ATTRIBUTE_EXTERNAL_KEYS

The backend name of the system attribute ExternalKeys.

ATTRIBUTE_FIELDWISE_OPERATION

public static final java.lang.String ATTRIBUTE_FIELDWISE_OPERATION

The backend name of the system attribute FieldwiseOperation.

ATTRIBUTE_LOCKMODE_EXCLUSIVE

public static final java.lang.String ATTRIBUTE_LOCKMODE_EXCLUSIVE

The backend name of the system attribute LockmodeExclusive.

ATTRIBUTE_LOCKMODE_SHARED_PROMOTABLE

public static final java.lang.String ATTRIBUTE_LOCKMODE_SHARED_PROMOTABLE

The backend name of the system attribute LockmodeSharedPromotable.

ATTRIBUTE_LOCKMODE_SHARED

public static final java.lang.String ATTRIBUTE_LOCKMODE_SHARED

The backend name of the system attribute LockmodeShared.

ATTRIBUTE_MULTI_INSTANCE_SUPPORT

public static final java.lang.String ATTRIBUTE_MULTI_INSTANCE_SUPPORT

The backend name of the system attribute MultiInstanceSupport.

ATTRIBUTE_ROWWISE_OPERATION

public static final java.lang.String ATTRIBUTE_ROWWISE_OPERATION

The backend name of the system attribute RowwiseOperation.

ATTRIBUTE_INSERT_RELATION

public static final java.lang.String ATTRIBUTE_INSERT_RELATION

The backend name of the system attribute InsertRelation.

ATTRIBUTE_INSERT_RELATION_REQUIRED

public static final java.lang.String ATTRIBUTE_INSERT_RELATION_REQUIRED

The backend name of the system attribute InsertRelationRequired.

ATTRIBUTE_NO_CHANGE

public static final java.lang.String ATTRIBUTE_NO_CHANGE

The backend name of the system attribute NoChange.

Method Detail

getName

public java.lang.String getName()

Returns the name of the aspect.

Returns:

name of the aspect.

getDescription

public java.lang.String getDescription()

Returns the description of this aspect.

Returns:

String the short text description of the aspect.

getRelationDescriptor

public IRelationDescriptor getRelationDescriptor(java.lang.String name)

Returns the descriptor for the relation with the specified name.

Returns:

the relation descriptor

getRelationDescriptors

public IRelationDescriptor[] getRelationDescriptors()

Returns an array with descriptors of all relations for which this aspect is the source aspect. If no relations exist an empty array is returned.

Returns:

array with the relation descriptors

getAspectActionDescriptor

public IAspectActionDescriptor getAspectActionDescriptor(java.lang.String name)

Returns the descriptor of the aspect action with the specified name

Returns:

the aspect action descriptor

getAspectActionDescriptors

public IAspectActionDescriptor[] getAspectActionDescriptors()

Returns an array with descriptors of all aspect actions. If no actions exist an empty array is returned.

Returns:

array with the aspect action descriptors

getAspectGroupDescriptor

public IAspectGroupDescriptor getAspectGroupDescriptor(java.lang.String name)

Returns the descriptor of the aspect group with the specified name

Returns:

the aspect group descriptor

getAspectGroupDescriptors

public IAspectGroupDescriptor[] getAspectGroupDescriptors()

Returns an array with descriptors of all aspect groups. If no groups exist an empty array is returned.

Returns:

array with the aspect group descriptors

getValueSetDescriptor

public IValueSetDescriptor getValueSetDescriptor(java.lang.String fieldName)

Returns the value set descriptor for the given field of the aspect structure. If no value set descriptor is stored for the given field, or if the field does not exist in the aspect structure, null is returned.

Parameters:

fieldName - the name of the aspect structure field.

Returns:

the descriptor of the value set or null.

getAttributeStringValue

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

Returns the value that is stored in the aspect for the given attribute. Attribute names are case sensitive. If the attribute is not stored in the aspect, 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 aspect.

Returns:

the attribute names.

getAttributeNoChange

public boolean getAttributeNoChange()

Returns whether Update/Insert/Delete or Action without COL_AFFECTS_NOTHING attribute being set is supported in this aspect. Defaults to false.

Returns:

true if a change operation is not supported, otherwise false

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_NO_CHANGE' for this aspect.

getAttributeExternalKeys

public boolean getAttributeExternalKeys()

Returns whether externally provided keys can be provided at newly created objects. If this is set to false, keys are generated internally. In any cases keys cannot be updated. However, if this is set to true, the key fields can be filled in at the insert operation. Defaults to false.

Returns:

true if externally provided keys can be provided at newly created objects, otherwise false

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_EXTERNAL_KEYS' for this aspect.

getAttributeFieldwiseOperation

public boolean getAttributeFieldwiseOperation()

Returns whether field wise operations are available in this aspect. Defaults to false.

Returns:

true if field wise operations are available, otherwise false

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_FIELDWISE_OP' for this aspect.

getAttributeLockmodeExclusive

public boolean getAttributeLockmodeExclusive()

Returns whether the exclusive lock mode is supported. Defaults to false.

Returns:

true if the exclusive lock mode is supported, otherwise false

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_LOCKMODE_E' for this aspect.

getAttributeLockmodeSharedPromotable

public boolean getAttributeLockmodeSharedPromotable()

Returns whether the shared promotable lock mode is supported. Defaults to false.

Returns:

true if the shared promotable lock mode is supported, otherwise false

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_LOCKMODE_SP' for this aspect.

getAttributeLockmodeShared

public boolean getAttributeLockmodeShared()

Returns whether the shared lock mode is supported. Defaults to false.

Returns:

true if the shared lock mode is supported, otherwise false

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_LOCKMODE_S' for this aspect.

getAttributeMultiInstanceSupport

public boolean getAttributeMultiInstanceSupport()

Returns whether Update/Insert/Actions can act on multiple instances. If set to false, the update and insert methods as well as the action.execute method can only act on single rows. Defaults to false.

Returns:

true if Update/Insert/Actions can act on multiple instances, otherwise false

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_MULTIINSTANCE_SUPPORT' for this aspect.

getAttributeRowwiseOperation

public boolean getAttributeRowwiseOperation()

Returns whether row wise operations are available in this aspect. Defaults to false.

Returns:

true if row wise operations are available, otherwise false

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_ROWWISE_OP' for this aspect.

getAttributeInsertRelationRequired

public boolean getAttributeInsertRelationRequired()

Returns whether the insert operation of this aspect requires the object to which the inserted object(s) are related to be specified. This can only be true, if getAttributeInsertRelation() does not return an empty string.

Returns:

true if the insert operation on this aspect requires a related object to be specified, otherwise false

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_ROWWISE_OP' for this aspect.

See Also:

getAttributeInsertRelation()

getAttributeInsertRelation

public java.lang.String getAttributeInsertRelation()

Returns the name of the relation to the aspect of which a record can be specified as related to records which are inserted in this aspect.

Returns:

The name of the relation for the insert operation

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_ROWWISE_OP' for this aspect.

See Also:

getAttributeInsertRelationRequired()

getFieldAttributeStringValue

public java.lang.String getFieldAttributeStringValue(java.lang.String fieldName,
                                                     java.lang.String attributeName)

Returns the value that is stored in the aspect for the given attribute of the given field. Field and attribute names are case sensitive. If the attribute is not stored in the aspect, null ist returned.

Parameters:

fieldName - The name of the field for which the attribute is stored.

attributeName - The name of the attribute.

Returns:

The value of the attribute or null.

getFieldAttributeNames

public java.lang.String[] getFieldAttributeNames(java.lang.String fieldName)

Returns an array with the names of all the attributes for a specified field. The field names in this aspect can be retrieved through the structure descriptor for this aspect. If no attributes are set for this field, an empty array is returned.

Returns:

the attribute names.

Throws:

java.lang.IllegalArgumentException - if the field does not exist in this aspect.

See Also:

getStructure(), IStructureDescriptor.getFieldDescriptor(int)

getFieldAttributeStringValue

public java.lang.String getFieldAttributeStringValue(java.lang.String rowKey,
                                                     java.lang.String fieldName,
                                                     java.lang.String attributeName)

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

Parameters:

rowKey - The key of the aspect row

fieldName - The name of the field for which the attribute is stored.

attributeName - The name of the attribute.

Returns:

The value of the attribute or null.

getFieldAttributeNames

public java.lang.String[] getFieldAttributeNames(java.lang.String rowKey,
                                                 java.lang.String fieldName)

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

Parameters:

rowKey - The key of the aspect row

Returns:

the attribute names.

See Also:

getFieldAttributeStringValue(String, String, String)

getActionAttributeStringValue

public java.lang.String getActionAttributeStringValue(java.lang.String rowKey,
                                                      java.lang.String actionName,
                                                      java.lang.String attributeName)

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

Parameters:

rowKey - The key of the aspect row

actionName - The name of the action for which the attribute is stored.

attributeName - The name of the attribute.

Returns:

The value of the attribute or null.

getActionAttributeNames

public java.lang.String[] getActionAttributeNames(java.lang.String rowKey,
                                                  java.lang.String actionName)

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

Parameters:

rowKey - The key of the aspect row

actionName - The name of the action

Returns:

the attribute names.

See Also:

getActionAttributeStringValue(String, String, String)

getActionAttributeStringValue

public java.lang.String getActionAttributeStringValue(java.lang.String actionName,
                                                      java.lang.String attributeName)

Returns the value that is stored in the aspect for the given attribute of the given action. Action and attribute names are case sensitive. If the attribute is not stored in the aspect, null ist returned.

Parameters:

actionName - The name of the field for which the attribute is stored.

attributeName - The name of the attribute.

Returns:

The value of the attribute or null.

getActionAttributeNames

public java.lang.String[] getActionAttributeNames(java.lang.String actionName)

Returns an array with the names of all the attributes for a specified action. The field names in this aspect can be retrieved through the structure descriptor for this aspect. If no attributes are set for this action, an empty array is returned.

Parameters:

actionName - The name of the action

Returns:

the attribute names.

Throws:

java.lang.IllegalArgumentException - if the action does not exist in this aspect.

getActionAttributeRelation

public java.lang.String getActionAttributeRelation(java.lang.String actionName)

Returns the name of the relation whose target aspect the action can affect for the given aspect action.

Parameters:

actionName - The name of the action

Returns:

the name of the relation

getActionAttributeAffects

public int getActionAttributeAffects(java.lang.String actionName)

Returns which side effects are to be excpected when performing the given aspect action.

Parameters:

actionName - The name of the action

Returns:

a value which describes the side effects that may occur when performing the action.

See Also:

IAspectActionDescriptor.AFFECTS_NOTHING, IAspectActionDescriptor.AFFECTS_OUTRECORDS, IAspectActionDescriptor.AFFECTS_ASPECT, IAspectActionDescriptor#AFFECTS_ANYTHING

getActionAttributeAffects

public int getActionAttributeAffects(java.lang.String rowKey,
                                     java.lang.String actionName)

Returns which side effects are to be excpected when performing the given aspect action on the given aspect row.

Parameters:

rowKey - The key of the aspect row

actionName - The name of the action

Returns:

a value which describes the side effects that may occur when performing the action.

See Also:

IAspectActionDescriptor.AFFECTS_NOTHING, IAspectActionDescriptor.AFFECTS_OUTRECORDS, IAspectActionDescriptor.AFFECTS_ASPECT, IAspectActionDescriptor#AFFECTS_ANYTHING

clearRowAttributes

public void clearRowAttributes(java.lang.String rowKey)

Clears all dynamically set attribute values for the given aspect row. This includes attributes which are dynamically set in the aspect action and relation descriptors for the given aspect row. After a call to this method, getFieldAttributeStringValue(String rowKey, String fieldName, String attributeName) will return only the statically set attributes for the aspects

Parameters:

rowKey - The key of the aspect row

See Also:

getFieldAttributeStringValue(String, String, String)

clearRowAttributes

public void clearRowAttributes()

Clears all dynamically set attribute values that are currently cached in this aspect descriptor for any rows. This includes attributes which are dynamically set in the aspect action and relation descriptors.

isKeyAspect

public boolean isKeyAspect()

Returns whether this aspect is a key aspect. This is false for all aspect descriptors which are not an instance of IKeyDescriptor

Returns:

true if the aspect is a key aspect, false otherwise.

See Also:

IKeyAspectDescriptor

getStructure

public IStructureDescriptor getStructure()

Returns the structure desciptor for aspect rows of this aspect.

Returns:

the structure of the aspect rows.

getServiceModuleDescriptor

public IServiceModuleDescriptor getServiceModuleDescriptor()

Returns the service module descriptor of the service module for which this aspect is cached in the repository.

getKeyDescriptor

public IKeyAspectDescriptor getKeyDescriptor()

Returns the key aspect descriptor for this aspect. If the aspect described by this descriptor is a key aspect, this descriptor itself is returned.

Returns:

the key aspect descriptor.

toString

public java.lang.String toString()

returns a string representation of this AspectDescriptor for test purposes only

Overrides:

toString in class java.lang.Object