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

public interface IAspectGroupDescriptor

Describes aspect groups; an aspect group may contain FieldDescriptors, RelationDescriptors, and AspectActionDescriptors.

Method Summary

IAspectActionDescriptor	getAspectActionDescriptor(java.lang.String actionname) Returns the aspect action descriptor for the given name, if it is a member of this group, otherwise null.
IAspectActionDescriptor[]	getAspectActionDescriptors() Returns an array with all the aspect action descriptors in this group.
IFieldDescriptor	getFieldDescriptor(java.lang.String fieldname) Returns the field descriptor with the given name, if it is a member of this group, otherwise null.
IFieldDescriptor[]	getFieldDescriptors() Returns an array with all the field descriptors in this group.
java.lang.String	getName() Returns the name of the aspect group.
IRelationDescriptor	getRelationDescriptor(java.lang.String relationname) Returns the relation descriptor with the given name, if it is a member of this group, otherwise null.
IRelationDescriptor[]	getRelationDescriptors() Returns an array with all the relation descriptors in this group.

Method Detail

getName

public java.lang.String getName()

Returns the name of the aspect group.

Returns:

name of the aspect group.

getFieldDescriptor

public IFieldDescriptor getFieldDescriptor(java.lang.String fieldname)

Returns the field descriptor with the given name, if it is a member of this group, otherwise null.

Parameters:

fieldname - The name of the requested field descriptor

Returns:

the field descriptor or null

getFieldDescriptors

public IFieldDescriptor[] getFieldDescriptors()

Returns an array with all the field descriptors in this group. If the group has no field descriptors, an empty array is returned.

Returns:

the array with the field descriptors

getRelationDescriptor

public IRelationDescriptor getRelationDescriptor(java.lang.String relationname)

Returns the relation descriptor with the given name, if it is a member of this group, otherwise null.

Parameters:

relationname - The name of the requested relation descriptor

Returns:

the relation descriptor or null

getRelationDescriptors

public IRelationDescriptor[] getRelationDescriptors()

Returns an array with all the relation descriptors in this group. If the group has no relation descriptors, an empty array is returned.

Returns:

the array with the relation descriptors

getAspectActionDescriptor

public IAspectActionDescriptor getAspectActionDescriptor(java.lang.String actionname)

Returns the aspect action descriptor for the given name, if it is a member of this group, otherwise null.

Parameters:

actionname - The name of the requested aspect action descriptor

Returns:

the aspect action descriptor or null

getAspectActionDescriptors

public IAspectActionDescriptor[] getAspectActionDescriptors()

Returns an array with all the aspect action descriptors in this group. If the group has no aspect action descriptors, an empty array is returned.

Returns:

the array with the aspect action descriptors