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

public interface IServiceModuleDescriptor

Provides information about service modules which are cached in the service manager repository. A service module is uniquely identified by its name within a given service manager instance. Service modules contain a number of queries, key and non-key aspects, and relations between aspects, whose descriptors can be accessed through service module descriptor objects. Also, service modules can contain groups of queries, aspects, and relations to allow group operations on them.

See Also:

IAspectDescriptor, IQueryDescriptor, IRelationDescriptor, IServiceModuleGroupDescriptor

Method Summary

void	clearAspectRowAttributes() Clears all dynamically set aspect row attributes that are currently cached in the aspect descriptors of the aspects of this service module.
IAspectDescriptor	getAspectDescriptor(java.lang.String aspectName) Returns the aspect descriptor with the given name or null, if the aspect doesn't exist in this service module.
IAspectDescriptor[]	getAspectDescriptors() Returns an array with the descriptors of all aspects in this service module.
java.lang.String[]	getAttributeNames() Returns an array with the names of all the attributes which are stored in this service module.
java.lang.String	getAttributeStringValue(java.lang.String attributeName) Returns the value that is stored in the service module for the given attribute.
java.lang.String	getConfigurationDescription() Returns a textual description for the active configuration of the this service module.
java.lang.String	getConfigurationName() Returns the name of the active configuration of the service module.
java.lang.String	getDescription() Returns a textual description for this service module.
IKeyAspectDescriptor	getKeyAspectDescriptor(java.lang.String aspectName) Returns the key aspect descriptor with the given name or null, if the key aspect doesn't exist in this service module.
IKeyAspectDescriptor[]	getKeyAspectDescriptors() Returns an array with the descriptors of all key aspects in this service module.
java.lang.String	getName() Returns the name of the service module.
IQueryDescriptor	getQueryDescriptor(java.lang.String name) Returns the query descriptor with the given name or null, if the query doesn't exist in this service module.
IQueryDescriptor[]	getQueryDescriptors() Returns an array with the descriptors of all queries in this service module.
IRelationDescriptor	getRelationDescriptor(java.lang.String name) Deprecated. Obsolete as of Beta4, relations are now local to aspects, use IAspectDescriptor.getRelationDescriptor(String) instead.
IRelationDescriptor[]	getRelationDescriptors() Deprecated. Obsolete as of Beta4, relations are now local to aspects, use IAspectDescriptor.getRelationDescriptors() instead.
IServiceModuleGroupDescriptor	getServiceModuleGroupDescriptor(java.lang.String name) Returns the service module group descriptor with the given name or null, if the service module group doesn't exist in this service module.
IServiceModuleGroupDescriptor[]	getServiceModuleGroupDescriptors() Returns an array with the descriptors of all service module groups in this service module.

Method Detail

getName

public java.lang.String getName()

Returns the name of the service module.

Returns:

name of the service module.

getDescription

public java.lang.String getDescription()

Returns a textual description for this service module.

Returns:

the short text description of the service module

getConfigurationName

public java.lang.String getConfigurationName()

Returns the name of the active configuration of the service module.

Returns:

configuration name.

getConfigurationDescription

public java.lang.String getConfigurationDescription()

Returns a textual description for the active configuration of the this service module.

Returns:

configuration description

getQueryDescriptors

public IQueryDescriptor[] getQueryDescriptors()

Returns an array with the descriptors of all queries in this service module.

Returns:

the array of query descriptors

getQueryDescriptor

public IQueryDescriptor getQueryDescriptor(java.lang.String name)

Returns the query descriptor with the given name or null, if the query doesn't exist in this service module.

Returns:

the requested query descriptor or null

getRelationDescriptors

public IRelationDescriptor[] getRelationDescriptors()

Deprecated. Obsolete as of Beta4, relations are now local to aspects, use IAspectDescriptor.getRelationDescriptors() instead.

Returns an array with the descriptors of all relations in this service module.

Returns:

the array of relation descriptors

See Also:

IAspectDescriptor.getRelationDescriptors()

getRelationDescriptor

public IRelationDescriptor getRelationDescriptor(java.lang.String name)

Deprecated. Obsolete as of Beta4, relations are now local to aspects, use IAspectDescriptor.getRelationDescriptor(String) instead.

Returns the relation descriptor with the given name or null, if the relation doesn't exist in this service module.

Returns:

the requested relation descriptor or null

See Also:

IAspectDescriptor.getRelationDescriptor(String)

getAspectDescriptors

public IAspectDescriptor[] getAspectDescriptors()

Returns an array with the descriptors of all aspects in this service module.

Returns:

the array of aspect descriptors

getAspectDescriptor

public IAspectDescriptor getAspectDescriptor(java.lang.String aspectName)

Returns the aspect descriptor with the given name or null, if the aspect doesn't exist in this service module.

Returns:

the requested aspect descriptor or null

getKeyAspectDescriptors

public IKeyAspectDescriptor[] getKeyAspectDescriptors()

Returns an array with the descriptors of all key aspects in this service module.

Returns:

the array of key aspect descriptors

getKeyAspectDescriptor

public IKeyAspectDescriptor getKeyAspectDescriptor(java.lang.String aspectName)

Returns the key aspect descriptor with the given name or null, if the key aspect doesn't exist in this service module.

Returns:

the requested key aspect descriptor or null

getServiceModuleGroupDescriptors

public IServiceModuleGroupDescriptor[] getServiceModuleGroupDescriptors()

Returns an array with the descriptors of all service module groups in this service module.

Returns:

the array of service module group descriptors

getServiceModuleGroupDescriptor

public IServiceModuleGroupDescriptor getServiceModuleGroupDescriptor(java.lang.String name)

Returns the service module group descriptor with the given name or null, if the service module group doesn't exist in this service module.

Returns:

the requested service module group descriptor or null

getAttributeNames

public java.lang.String[] getAttributeNames()

Returns an array with the names of all the attributes which are stored in this service module.

Returns:

the attribute names.

getAttributeStringValue

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

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

Parameters:

attributeName - The name of the attribute.

Returns:

The value of the attribute or null.

clearAspectRowAttributes

public void clearAspectRowAttributes()

Clears all dynamically set aspect row attributes that are currently cached in the aspect descriptors of the aspects of this service module. This includes attributes which are dynamically set in the aspect action and relation descriptors.