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

public interface IAspectActionDescriptor

Describes the properties of an aspect action.

Field Summary

static java.lang.String	ACTION_DELETE The name of the system action DELETE (Delete).
static java.lang.String	ACTION_INSERT The name of the system action INSERT (Insert).
static java.lang.String	ACTION_SELECT The name of the system action SELECT (Select).
static java.lang.String	ACTION_SELECT_BY_RELATION The name of the system action SELECT_BY_RELATION (SelectByRelation).
static java.lang.String	ACTION_UPDATE_FIELDS The name of the system action UPDATE_FIELDS (UpdateFields).
static java.lang.String	ACTION_UPDATE_ROW The name of the system action UPDATE (UpdateRow).
static int	AFFECTS_ALL Performing an action may have side effects on just about anything.
static int	AFFECTS_ASPECT Performing an action may only have side effects on any other records of an aspect (regardless of the records being included in the outrecords of the action).
static int	AFFECTS_NOTHING No side effects occur when performing an action.
static int	AFFECTS_OUTRECORDS Performing an action may only have side effects on other records which are in the outrecord table of an action.
static java.lang.String	ATTRIBUTE_ACTION_RELATION The backend name of the system attribute Action Relation.
static java.lang.String	ATTRIBUTE_AFFECTS The backend name of the system attribute Affects.

Method Summary

IAspectDescriptor	getAspectDescriptor() Returns the descriptor of the aspect of this aspect action.
int	getAttributeAffects() Returns which side effects are to be excpected when performing the action described by this descriptor.
int	getAttributeAffects(java.lang.String rowKey) Returns which side effects are to be excpected when performing the action described by this descriptor on the given aspect row.
java.lang.String[]	getAttributeNames() Returns an array with the names of all the attributes which are set for this aspect action.
java.lang.String[]	getAttributeNames(java.lang.String rowKey) Returns an array with the names of all the attributes which are set for this aspect action in the specified aspect row.
java.lang.String	getAttributeRelation() Returns the name of the relation whose target aspect the action can affect for this aspect action.
java.lang.String	getAttributeStringValue(java.lang.String attributeName) Returns the value that is stored in the aspect action for the given attribute.
java.lang.String	getAttributeStringValue(java.lang.String rowKey, java.lang.String attributeName) Returns the value that is stored in this aspect action for the given attribute in the specified aspect row.
java.lang.String	getDescription() Returns the description of this aspect action.
java.lang.String[]	getFieldAttributeNames(java.lang.String fieldName) Returns an array with the names of all the attributes for a specified field of the input parameter structure.
java.lang.String	getFieldAttributeStringValue(java.lang.String fieldName, java.lang.String attributeName) Returns the value that is stored in this aspect action for the given attribute of the given field (of the input parameter structure).
IKeyAspectDescriptor	getInputKeysDescriptor() Returns the descriptor of the input keys of this aspect action.
IStructureDescriptor	getInputParameters() Returns the input parameters for this aspect action.
java.lang.String	getName() Returns the name of the aspect action.
boolean	hasInputParameters() Returns whether the aspect action has input parameters.

Field Detail

AFFECTS_NOTHING

public static final int AFFECTS_NOTHING

No side effects occur when performing an action.

AFFECTS_OUTRECORDS

public static final int AFFECTS_OUTRECORDS

Performing an action may only have side effects on other records which are in the outrecord table of an action.

AFFECTS_ASPECT

public static final int AFFECTS_ASPECT

Performing an action may only have side effects on any other records of an aspect (regardless of the records being included in the outrecords of the action).

AFFECTS_ALL

public static final int AFFECTS_ALL

Performing an action may have side effects on just about anything. May wreak complete mayhem and chaos in the backend. You have been warned!

ATTRIBUTE_AFFECTS

public static final java.lang.String ATTRIBUTE_AFFECTS

The backend name of the system attribute Affects.

ATTRIBUTE_ACTION_RELATION

public static final java.lang.String ATTRIBUTE_ACTION_RELATION

The backend name of the system attribute Action Relation.

ACTION_SELECT

public static final java.lang.String ACTION_SELECT

The name of the system action SELECT (Select).

ACTION_SELECT_BY_RELATION

public static final java.lang.String ACTION_SELECT_BY_RELATION

The name of the system action SELECT_BY_RELATION (SelectByRelation).

ACTION_INSERT

public static final java.lang.String ACTION_INSERT

The name of the system action INSERT (Insert).

ACTION_UPDATE_ROW

public static final java.lang.String ACTION_UPDATE_ROW

The name of the system action UPDATE (UpdateRow).

ACTION_UPDATE_FIELDS

public static final java.lang.String ACTION_UPDATE_FIELDS

The name of the system action UPDATE_FIELDS (UpdateFields).

ACTION_DELETE

public static final java.lang.String ACTION_DELETE

The name of the system action DELETE (Delete).

Method Detail

getName

public java.lang.String getName()

Returns the name of the aspect action.

Returns:

name of the aspect action.

getDescription

public java.lang.String getDescription()

Returns the description of this aspect action.

Returns:

String the short text description of the aspect action.

getAspectDescriptor

public IAspectDescriptor getAspectDescriptor()

Returns the descriptor of the aspect of this aspect action.

Returns:

the aspect descriptor

hasInputParameters

public boolean hasInputParameters()

Returns whether the aspect action has input parameters.

Returns:

true if the action has input parameters, otherwise false.

getInputParameters

public IStructureDescriptor getInputParameters()

Returns the input parameters for this aspect action.

Returns:

the input parameter descriptor or null

getInputKeysDescriptor

public IKeyAspectDescriptor getInputKeysDescriptor()

Returns the descriptor of the input keys of this aspect action.

Returns:

the key descriptor for the input parameters of this aspect action.

getAttributeStringValue

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

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

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 aspect action for the given attribute in the specified aspect row. Attribute names are case sensitive. If the attribute is not stored in this aspect action, null ist returned. This method will return the value that was dynamically set for the attribute of this aspect action for the given source aspect row. If no value was set dynamically, the attribute value which was statically set for this aspect action is returned.

Parameters:

rowKey - The key of the 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 aspect action in the specified aspect row. This method will return a full list of available attributes for this aspect action in the given aspect row, which can be accessed using getAttributeStringValue(String rowKey, String attributeName)

Parameters:

rowKey - The key of the aspect row

Returns:

the attribute names.

See Also:

getAttributeStringValue(String, String)

getAttributeRelation

public java.lang.String getAttributeRelation()

Returns the name of the relation whose target aspect the action can affect for this aspect action. If the action does not have a relation, an empty String is returned.

Returns:

the name of the relation

getAttributeAffects

public int getAttributeAffects()

Returns which side effects are to be excpected when performing the action described by this descriptor.

Returns:

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

See Also:

AFFECTS_NOTHING, AFFECTS_OUTRECORDS, AFFECTS_ASPECT, AFFECTS_ANYTHING

getAttributeAffects

public int getAttributeAffects(java.lang.String rowKey)

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

Parameters:

rowKey - The key of the aspect row

Returns:

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

See Also:

AFFECTS_NOTHING, AFFECTS_OUTRECORDS, AFFECTS_ASPECT, AFFECTS_ANYTHING

getFieldAttributeStringValue

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

Returns the value that is stored in this aspect action for the given attribute of the given field (of the input parameter structure). Field and attribute names are case sensitive. If the attribute is not stored for the given field, or if the field does not exist in the structure, 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 of the input parameter structure. The field names in the input parameter structure can be retrieved through with getInputParameters(). If no attributes are set for the given field, an empty array is returned.

Returns:

the attribute names.

Throws:

java.lang.IllegalArgumentException - if the field does not exist in the structure of the input parameter of this aspect action or if this aspect action does not have an input parameter.

See Also:

getInputParameters(), hasInputParameters(), IStructureDescriptor.getFieldDescriptor(int)