com.sap.tc.cmi.metadata

Interface ICMIAbstractInfo

All Known Subinterfaces:

ICMIAnnotatedClassInfo, ICMIModelClassInfo, ICMIModelClassPropertyInfo, ICMIModelInfo, ICMIModelObjectCollectionInfo, ICMIRelationInfo, ICMIRelationRoleInfo

public interface ICMIAbstractInfo

Represents an common super interface for runtime meta data of a model element. It is therefore extended by ICMIModelInfo, ICMIModelClassInfo, ICMIModelClassPropertyInfo, ICMIRelationInfo and ICMIRelationRoleInfo. This type can be called, extended or implemented by applications or frameworks using CMI.

See Also:

ICMIModelInfo, ICMIModelClassInfo, ICMIModelClassPropertyInfo, ICMIRelationInfo, ICMIRelationRoleInfo

Type Classification:

This interface is part of the Common Model Interface and is intended to be implemented by applications.

Method Summary

void	addSupportedOption(String option) Deprecated. Usually it makes no sense to allow the modification of the set of supported options of a given model implementation. Therefore the possibility to add options has been deprecated and might be removed in the first new NetWeaver release in 2007. Model implementations are free to define their own way of adding options whereas model consumers should either not rely on this feature or must adhere to a model type specific API.
String	getName() Returns the name of the metadata entity.
CMISetting	getSetting(CMISettingDefinition settingDef) Returns the setting of the given settingDef.
Map	getSettings() Returns a map with all actual settings.
void	setSetting(CMISettingDefinition settingDef, String value) Set the setting of the given settingDef to the given value.
Collection	supportedOptions() Returns a collection of all supported options.
boolean	supports(String option) Returns true, if the given option is supported by the model element.

Method Detail

getName

String getName()

Returns the name of the metadata entity.

getSetting

CMISetting getSetting(CMISettingDefinition settingDef)

Returns the setting of the given settingDef.

setSetting

void setSetting(CMISettingDefinition settingDef,
                String value)

Set the setting of the given settingDef to the given value.

getSettings

Map getSettings()

Returns a map with all actual settings. The map must be immutable.

supports

boolean supports(String option)

Returns true, if the given option is supported by the model element.

supportedOptions

Collection supportedOptions()

Returns a collection of all supported options. The collection must be immutable.

addSupportedOption

void addSupportedOption(String option)

Deprecated. Usually it makes no sense to allow the modification of the set of supported options of a given model implementation. Therefore the possibility to add options has been deprecated and might be removed in the first new NetWeaver release in 2007. Model implementations are free to define their own way of adding options whereas model consumers should either not rely on this feature or must adhere to a model type specific API.

Adds option to the supported options of the model element.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] FRAMEWORK	[sap.com] tc/cm/ejb/api	api	BC-JAS-EJB
[sap.com] FRAMEWORK	[sap.com] tc/cmi	default	BC-WD-JAV-RUN