com.sap.tc.cmi.metadata

Interface ICMIModelInfo

All Superinterfaces:

ICMIAbstractInfo

public interface ICMIModelInfo
extends ICMIAbstractInfo

Represents the root of runtime meta data of a CMI model This type can be called, extended or implemented by applications or frameworks using CMI.

Type Classification:

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

Field Summary

static CMIModelType	TYPE_GENERIC This model type means that the CMI model consists only of usually few generic model classes to which no typed access is possible or desirable
static CMIModelType	TYPE_REVERSEENGINEERED This model type means that the CMI model was created (at design time) by a XMI import into the SAP Netweaver Developer Studio.
static CMIModelType	TYPE_RFCADAPTER This model type means that the CMI model was created out of the import of an RFC model

Method Summary

ICMIModelClassInfo	getModelClassInfo(String name) Returns the model class infos for the model class with the given (full qualified) name.
Collection	getModelClassInfos() Returns a collection of all model class infos of this model.
Collection	getModelRelationInfo(String name) Returns a collection of all model class relation infos with the given name or null, if the model implementation doesn't support relation infos.
Collection	getModelRelationInfos() Returns a collection of all model class relation infos or null, if the model implementation doesn't support relation infos.
CMIModelType	getModelType() Returns the model type of the model according to the defined TYPE_... constants.
Iterator	iterateModelClassInfos() Returns an iterator over all model class infos of this model.
Iterator	iterateModelRelationInfos() Returns an iterator over all model class relation infos or null, if the model implementation doesn't support relation infos.
boolean	supportsModelRelationInfos() Returns true, if modelRelationInfos are accessible at runtime.

Methods inherited from interface com.sap.tc.cmi.metadata.ICMIAbstractInfo

addSupportedOption, getName, getSetting, getSettings, setSetting, supportedOptions, supports

Field Detail

TYPE_RFCADAPTER

static final CMIModelType TYPE_RFCADAPTER

This model type means that the CMI model was created out of the import of an RFC model

TYPE_REVERSEENGINEERED

static final CMIModelType TYPE_REVERSEENGINEERED

This model type means that the CMI model was created (at design time) by a XMI import into the SAP Netweaver Developer Studio. Usually the imported XMI file was exported by an UML modelling tool.

TYPE_GENERIC

static final CMIModelType TYPE_GENERIC

This model type means that the CMI model consists only of usually few generic model classes to which no typed access is possible or desirable

Method Detail

getModelClassInfos

Collection getModelClassInfos()

Returns a collection of all model class infos of this model. The collection should be immutable.

iterateModelClassInfos

Iterator iterateModelClassInfos()

Returns an iterator over all model class infos of this model. The iterator should be immutable.

getModelClassInfo

ICMIModelClassInfo getModelClassInfo(String name)

Returns the model class infos for the model class with the given (full qualified) name.

supportsModelRelationInfos

boolean supportsModelRelationInfos()

Returns true, if modelRelationInfos are accessible at runtime. A model implementation that doesn't support this must return false, but must implement the class ICMIModelRelationRoleInfos anyway.

See Also:

ICMIRelationRoleInfo

getModelRelationInfos

Collection getModelRelationInfos()

Returns a collection of all model class relation infos or null, if the model implementation doesn't support relation infos. The collection should be immutable.

iterateModelRelationInfos

Iterator iterateModelRelationInfos()

Returns an iterator over all model class relation infos or null, if the model implementation doesn't support relation infos. The iterator should be immutable.

getModelRelationInfo

Collection getModelRelationInfo(String name)

Returns a collection of all model class relation infos with the given name or null, if the model implementation doesn't support relation infos. The collection should be immutable.

getModelType

CMIModelType getModelType()

Returns the model type of the model according to the defined TYPE_... constants.

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