CMI documentation
A C E F G I L M R S T

A

add(int, Object) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
add(Object) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
addAll(Collection) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
addAll(int, Collection) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
addAllSilently(int, Collection) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
addChangeListener(ICMIObservableListChangeListener) - Method in interface com.sap.tc.cmi.util.ICMIObservableList
registeres the given listener.
addChangeListener(ICMIObservableListChangeListener) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
addRelatedModelObject(String, ICMIModelClass) - Method in interface com.sap.tc.cmi.model.ICMIGenericModelClass
adds o to the relation role targetRoleName according to the add method in the java.util.Collection interface.
addSilently(int, Object) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
addSupportedOption(String) - Method in interface com.sap.tc.cmi.metadata.ICMIAbstractInfo
adds option to the supported options of the model element.
associatedInputParameterInfo() - Method in interface com.sap.tc.cmi.model.ICMIQuery
returns the metadata for the model class holding the input parameters or null if no metadata is available
associatedModel() - Method in interface com.sap.tc.cmi.model.ICMIModelClass
Returns the model to which this ModelClass instance is associated.
associatedModelClassInfo() - Method in interface com.sap.tc.cmi.model.ICMIModelClass
returns the metadata, i.e.
associatedModelClassInfo() - Method in interface com.sap.tc.cmi.model.ICMIGenericModelClass
returns the metadata, i.e.
associatedModelInfo() - Method in interface com.sap.tc.cmi.model.ICMIModel
returns the modelInfo of this model
associatedModelObjectCollectionInfo() - Method in interface com.sap.tc.cmi.model.ICMIModelObjectCollection
Returns the ICMIModelObjectCollectionInfo meta data, describing this model collection.
associatedResultInfo() - Method in interface com.sap.tc.cmi.model.ICMIQuery
returns the metadata for the model object collection holding the query result or null if no such metadata is available

C

CARDINALITY_MANY - Static variable in class com.sap.tc.cmi.metadata.CMICardinality
constant for the role cardinality * (== 0..* == 0..n)
CARDINALITY_ONE - Static variable in class com.sap.tc.cmi.metadata.CMICardinality
constant for the role cardinality 1 (== 1..1)
CARDINALITY_ONE_TO_MANY - Static variable in class com.sap.tc.cmi.metadata.CMICardinality
constant for the role cardinality 1..* (== 1..n)
CARDINALITY_ZERO_TO_ONE - Static variable in class com.sap.tc.cmi.metadata.CMICardinality
constant for the role cardinality 0..1
clear() - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
CMIAbstractObservableList - class com.sap.tc.cmi.util.CMIAbstractObservableList.
Abstract implementation of the ICMIObservableList interface.
CMIAbstractObservableList() - Constructor for class com.sap.tc.cmi.util.CMIAbstractObservableList
Constructor for CMIAbstractObservableList to be called by subclasses.
CMICardinality - class com.sap.tc.cmi.metadata.CMICardinality.
Describes the cardinality of a relation role.
CMIException - exception com.sap.tc.cmi.exception.CMIException.
Base class for exceptions thrown by methods of the Common Model Interface.
CMIException(String) - Constructor for class com.sap.tc.cmi.exception.CMIException
Creates an exception with a unparameterized text only.
CMIException(String, Object[]) - Constructor for class com.sap.tc.cmi.exception.CMIException
Creates an exception with the text and text parameters.
CMIException(String, Object[], Throwable) - Constructor for class com.sap.tc.cmi.exception.CMIException
Creates an exception with the given text, parameters and cause.
CMIException(String, Throwable) - Constructor for class com.sap.tc.cmi.exception.CMIException
Creates an exception with the given (unparameterized) text and cause.
CMIException(Throwable) - Constructor for class com.sap.tc.cmi.exception.CMIException
Creates an exception with the given cause.
CMIModelType - class com.sap.tc.cmi.metadata.CMIModelType.
Instances of this Enumeration Class represent the type of a model.
CMIModelType(String) - Constructor for class com.sap.tc.cmi.metadata.CMIModelType
 
CMIObservableListEvent - class com.sap.tc.cmi.util.CMIObservableListEvent.
Event object that describes changes in an ICMIObservableList.
CMIObservableListEvent(ICMIObservableList) - Constructor for class com.sap.tc.cmi.util.CMIObservableListEvent
Constructor for CMIObservableListEvent.
CMIObservableListEvent(ICMIObservableList, int, Object, int, int) - Constructor for class com.sap.tc.cmi.util.CMIObservableListEvent
Creates an event object with the given type and parameters for the given source.
CMISetting - class com.sap.tc.cmi.metadata.CMISetting.
Instances of this class represent a setting that the metadata of a model element (like ICMIModelInfo, ICMIModelClassInfo, ICMIModelClassPropertyInfo, ICMIRelationInfo or ICMIRelationRoleInfo) can have.
CMISetting(CMISettingDefinition, String) - Constructor for class com.sap.tc.cmi.metadata.CMISetting
protected constructor
CMISettingDefinition - class com.sap.tc.cmi.metadata.CMISettingDefinition.
Instances of this Enumeration Class represent a setting definition that the metadata of a model element (like ICMIModelInfo, ICMIModelClassInfo, ICMIModelClassPropertyInfo, ICMIRelationInfo or ICMIRelationRoleInfo) can have.
CMISettingDefinition(String) - Constructor for class com.sap.tc.cmi.metadata.CMISettingDefinition
protected constructor
com.sap.tc.cmi.exception - package com.sap.tc.cmi.exception
 
com.sap.tc.cmi.metadata - package com.sap.tc.cmi.metadata
 
com.sap.tc.cmi.model - package com.sap.tc.cmi.model
 
com.sap.tc.cmi.util - package com.sap.tc.cmi.util
 
complexChange(CMIObservableListEvent) - Method in interface com.sap.tc.cmi.util.ICMIObservableListChangeListener
Event which is fired when the list has changed in a more complex way.
CONTIGUOUS_ELEMENTS_ADDED - Static variable in class com.sap.tc.cmi.util.CMIObservableListEvent
Event type when multiple elements have been added en block.
CONTIGUOUS_ELEMENTS_REMOVED - Static variable in class com.sap.tc.cmi.util.CMIObservableListEvent
Event type when multiple elements have been removed en block.
countOf() - Method in interface com.sap.tc.cmi.model.ICMIQuery
returns the number all matching model objects for the parameterized query independent of the fetch size.
createModelObject(Class) - Method in interface com.sap.tc.cmi.model.ICMIModel
Gets an instance of ICMIModelClass within the scope of the current model If a model is not able to support this method, it must throw an UnsupportedOperationException.
createModelObject(String) - Method in interface com.sap.tc.cmi.model.ICMIModel
Gets an instance of ICMIModelClass within the scope of the current model.

E

ELEMENT_ADDED - Static variable in class com.sap.tc.cmi.util.CMIObservableListEvent
Event type when a single element has been added.
ELEMENT_CHANGED - Static variable in class com.sap.tc.cmi.util.CMIObservableListEvent
Event type used when a single element has been changed.
ELEMENT_REMOVED - Static variable in class com.sap.tc.cmi.util.CMIObservableListEvent
Event type used when a single element has been removed.
elementAdded(CMIObservableListEvent) - Method in interface com.sap.tc.cmi.util.ICMIObservableListChangeListener
Event which is fired when a single element is added.
elementChanged(CMIObservableListEvent) - Method in interface com.sap.tc.cmi.util.ICMIObservableListChangeListener
Event which is fired when a single element is changed.
elementRemoved(CMIObservableListEvent) - Method in interface com.sap.tc.cmi.util.ICMIObservableListChangeListener
Event which is fired when a single element has been removed.
execute() - Method in interface com.sap.tc.cmi.model.ICMIQuery
executes the query.
execute() - Method in interface com.sap.tc.cmi.model.ICMIModelClassExecutable
executes the Executable

F

fireComplexChange(int, int, int) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
fire a complex change event of the given type
fireElementAdded(Object, int) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
fire an element added event for the given element and index
fireElementChanged(Object, int) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
fire an element changed event for the given element and index
fireElementRemoved(Object, int) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
fire an element removed event for the given element and index

G

getAttributeValue(String) - Method in interface com.sap.tc.cmi.model.ICMIGenericModelClass
Returns the value of the attribute with the given name as an Object.
getCardinality() - Method in interface com.sap.tc.cmi.metadata.ICMIRelationRoleInfo
returns the cardinality of the role according the defined CARDINALITY...
getChangeType() - Method in class com.sap.tc.cmi.util.CMIObservableListEvent
 
getDataType() - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassPropertyInfo
Returns the IDataType of the property or null, if there is none.
getElement() - Method in class com.sap.tc.cmi.util.CMIObservableListEvent
 
getElementModelClassInfo() - Method in interface com.sap.tc.cmi.metadata.ICMIModelObjectCollectionInfo
Returns meta info that describes the elements of the collection.
getFromIndex() - Method in class com.sap.tc.cmi.util.CMIObservableListEvent
 
getInputParameter() - Method in interface com.sap.tc.cmi.model.ICMIQuery
Returns the model object which holds the query input parameters or null if the query doesn't support parameters.
getModelClassInfo() - Method in interface com.sap.tc.cmi.metadata.ICMIRelationRoleInfo
returns the model class info of the model class, to which the role belongs
getModelClassInfo() - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassPropertyInfo
Returns the metadata of the model class to which this property belongs.
getModelClassInfo(String) - Method in interface com.sap.tc.cmi.metadata.ICMIModelInfo
returns the model class infos for the model class with the given (full qualified) name.
getModelClassInfos() - Method in interface com.sap.tc.cmi.metadata.ICMIModelInfo
returns a collection of all model class infos of this model.
getModelInfo() - Method in interface com.sap.tc.cmi.metadata.ICMIRelationInfo
returns the model info of the model to which this relation belongs.
getModelInfo() - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassInfo
Returns the metadata of the model to which the class belongs.
getModelRelationInfo() - Method in interface com.sap.tc.cmi.metadata.ICMIRelationRoleInfo
returns the corresponing relation info or null, if this method is not supported.
getModelRelationInfo(String) - Method in interface com.sap.tc.cmi.metadata.ICMIModelInfo
returns a collection of all model class relation infos with the given name or null, if the model implementation doesn't support relation infos.
getModelRelationInfos() - Method in interface com.sap.tc.cmi.metadata.ICMIModelInfo
returns a collection of all model class relation infos or null, if the model implementation doesn't support relation infos.
getModelType() - Method in interface com.sap.tc.cmi.metadata.ICMIModelInfo
returns the model type of the model according to the defined TYPE_...
getName() - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassInfo
returns the name of the model class.
getName() - Method in interface com.sap.tc.cmi.metadata.ICMIAbstractInfo
returns the name of the metadata entity.
getObservableList() - Method in class com.sap.tc.cmi.util.CMIObservableListEvent
 
getOtherRoleInfo() - Method in interface com.sap.tc.cmi.metadata.ICMIRelationRoleInfo
returns the other role.
getParameters() - Method in class com.sap.tc.cmi.exception.CMIException
Returns the array of parameters that are part of the message text or null if there are no parameters.
getPropertyInfo(String) - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassInfo
returns the property metadata of the model class for the property with the given name.
getPropertyInfos() - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassInfo
Returns a collection of all properties of the class.
getRelatedModelClassInfo(String) - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassInfo
Convenience method which returns the metadata for the model class to which this model class is related via a relation, where the relation is determined through the named target role of this model class.
getRelatedModelObject(String) - Method in interface com.sap.tc.cmi.model.ICMIGenericModelClass
Returns null or the appropriate object of type ICMIModelClass according to the relation role in targetRoleName, which must have the cardinality 1 or 0..1.
getRelatedModelObjects(String) - Method in interface com.sap.tc.cmi.model.ICMIGenericModelClass
Returns the appropriate collection of objects of type ICMIModelClass according to the relation role in targetRoleName, which must have the cardinality * or 1..*.
getResult() - Method in interface com.sap.tc.cmi.model.ICMIQuery
returns the collection which matches the query.
getRoleInfos() - Method in interface com.sap.tc.cmi.metadata.ICMIRelationInfo
returns a collection with the role infos of two relation roles which belong to the relation The collection should be immutable.
getSetting(CMISettingDefinition) - Method in interface com.sap.tc.cmi.metadata.ICMIAbstractInfo
returns the setting of the given settingDef.
getSettingDefinition() - Method in class com.sap.tc.cmi.metadata.CMISetting
returns the CMISettingDefinition
getSettings() - Method in interface com.sap.tc.cmi.metadata.ICMIAbstractInfo
returns a map with all actual settings.
getSourceRoleInfos() - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassInfo
Returns a collection of all source roles of the class.
getStructureType() - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassInfo
returns the Java DDIC IStructure of the model class info.
getTargetRoleInfo(String) - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassInfo
Returns the metadata for the target role with the given name.
getToIndex() - Method in class com.sap.tc.cmi.util.CMIObservableListEvent
 
getValue() - Method in class com.sap.tc.cmi.metadata.CMISetting
returns the value of the CMISetting

I

ICMIAbstractInfo - interface com.sap.tc.cmi.metadata.ICMIAbstractInfo.
Represents an common super interface for runtime meta data of a model element.
ICMIGenericModelClass - interface com.sap.tc.cmi.model.ICMIGenericModelClass.
Interface for a generic model class.
ICMIModel - interface com.sap.tc.cmi.model.ICMIModel.
Manages and contains all Model classes, which together form a Common Model.
ICMIModelClass - interface com.sap.tc.cmi.model.ICMIModelClass.
Represents a Model class in a Model.
ICMIModelClassExecutable - interface com.sap.tc.cmi.model.ICMIModelClassExecutable.
allows Access to some executable behavior of model classes.
ICMIModelClassInfo - interface com.sap.tc.cmi.metadata.ICMIModelClassInfo.
Represents the metadata of a model class at runtime.
ICMIModelClassPropertyInfo - interface com.sap.tc.cmi.metadata.ICMIModelClassPropertyInfo.
Represents the metadata of a model class property at runtime.
ICMIModelInfo - interface com.sap.tc.cmi.metadata.ICMIModelInfo.
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.
ICMIModelObjectCollection - interface com.sap.tc.cmi.model.ICMIModelObjectCollection.
Represents a collection of instances of model classes in a model.
ICMIModelObjectCollectionInfo - interface com.sap.tc.cmi.metadata.ICMIModelObjectCollectionInfo.
Represents the metadata of an instance of ICMIModelObjectCollection at runtime.
ICMIModificationCount - interface com.sap.tc.cmi.util.ICMIModificationCount.
Interface for classes which support tracking of modifications.
ICMIObservableList - interface com.sap.tc.cmi.util.ICMIObservableList.
List that informs about changes.
ICMIObservableListChangeListener - interface com.sap.tc.cmi.util.ICMIObservableListChangeListener.
Methods a listener must implement to be informed about list changes.
ICMIQuery - interface com.sap.tc.cmi.model.ICMIQuery.
represents a query in a Model.
ICMIRelationInfo - interface com.sap.tc.cmi.metadata.ICMIRelationInfo.
Represents the metadata of a model relation at runtime.
ICMIRelationRoleInfo - interface com.sap.tc.cmi.metadata.ICMIRelationRoleInfo.
represents the metadats of a model relation role at runtime This type can be called, extended or implemented by applications or frameworks using CMI.
isAggregation() - Method in interface com.sap.tc.cmi.metadata.ICMIRelationRoleInfo
returns true, if role is a aggregating role
isDirty() - Method in interface com.sap.tc.cmi.model.ICMIQuery
returns true if the query is not yet executed or the result is not consistent with input parameters any more and false otherwise.
isGeneric() - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassInfo
Returns true, if the class by this meta info implements ICMIGenericModelClass and thereby provides generic access to properties and relation roles.
isMandatory() - Method in class com.sap.tc.cmi.metadata.CMICardinality
returns true, if the role cardinality is 1 or 1..*
isMultiple() - Method in class com.sap.tc.cmi.metadata.CMICardinality
returns true, if the role cardinality is * or 1..*
isNavigable() - Method in interface com.sap.tc.cmi.metadata.ICMIRelationRoleInfo
returns true, if role is navigable
isReadOnly() - Method in interface com.sap.tc.cmi.metadata.ICMIRelationRoleInfo
returns true, if role is read only and can not be modified at runtime by a Web Dynpro component or the framework.
isReadOnly() - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassPropertyInfo
Returns true, if the property is read only and can not be modified at runtime through the means of the CMI.
iterateModelClassInfos() - Method in interface com.sap.tc.cmi.metadata.ICMIModelInfo
returns an iterator over all model class infos of this model.
iterateModelRelationInfos() - Method in interface com.sap.tc.cmi.metadata.ICMIModelInfo
returns an iterator over all model class relation infos or null, if the model implementation doesn't support relation infos.
iteratePropertyInfos() - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassInfo
returns an iterator over all properties of the classes.
iterateSourceRoleInfos() - Method in interface com.sap.tc.cmi.metadata.ICMIModelClassInfo
Returns an iterator over all source roles of the class.

L

LIST_CLEARED - Static variable in class com.sap.tc.cmi.util.CMIObservableListEvent
Event type when list has been cleared.

M

modCount() - Method in interface com.sap.tc.cmi.util.ICMIModificationCount
Returns the current state of the modification counter.
MULTIPLE_ELEMENTS_REMOVED - Static variable in class com.sap.tc.cmi.util.CMIObservableListEvent
Event type when multiple elements have been removed at not necessarily contiguous positions.

R

remove(int) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
remove(Object) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
removeAll(Collection) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
removeChangeListener(ICMIObservableListChangeListener) - Method in interface com.sap.tc.cmi.util.ICMIObservableList
registeres the given listener.
removeChangeListener(ICMIObservableListChangeListener) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
removeRange(int, int) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
removeRangeSilently(int, int) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
removeRelatedModelObject(String, ICMIModelClass) - Method in interface com.sap.tc.cmi.model.ICMIGenericModelClass
removes o from the relation role targetRoleName according to the remove method in the java.util.Collection interface.
removeSilently(int) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
retainAll(Collection) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
ROLE_NAME_INPUT_PARAMETER - Static variable in interface com.sap.tc.cmi.model.ICMIQuery
Constant string for implicit inputParamter relation role.
ROLE_NAME_RESULT - Static variable in interface com.sap.tc.cmi.model.ICMIQuery
Constant string for implicit result relation role.

S

set(int, Object) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
setAttributeValue(String, Object) - Method in interface com.sap.tc.cmi.model.ICMIGenericModelClass
Sets the attribute to given value.
setRelatedModelObject(String, ICMIModelClass) - Method in interface com.sap.tc.cmi.model.ICMIGenericModelClass
Sets the relation role targetRoleName of an x:0..1 or x:1 relation to object o of type ICMIModelClass.
setRelatedModelObjects(String, Collection) - Method in interface com.sap.tc.cmi.model.ICMIGenericModelClass
sets the relation role targetRoleName of an x:* or x:1..* relation to the Collection col, which contains exclusively objects of type ICMIModelClass.
setSetting(CMISettingDefinition, String) - Method in interface com.sap.tc.cmi.metadata.ICMIAbstractInfo
set the setting of the given settingDef to the given value.
setSilently(int, Object) - Method in class com.sap.tc.cmi.util.CMIAbstractObservableList
 
supportedOptions() - Method in interface com.sap.tc.cmi.metadata.ICMIAbstractInfo
returns a collection of all supported options.
supports(String) - Method in interface com.sap.tc.cmi.metadata.ICMIAbstractInfo
returns true, if the given option is supported by the model element
supportsModelRelationInfos() - Method in interface com.sap.tc.cmi.metadata.ICMIModelInfo
returns true, if modelRelationInfos are accessible at runtime.

T

toString() - Method in class com.sap.tc.cmi.metadata.CMISetting
returns a String representation of the CMISetting object in the form "SettingDefinition: Setting"
toString() - Method in class com.sap.tc.cmi.metadata.CMIModelType
returns a string representation of the model type
toString() - Method in class com.sap.tc.cmi.metadata.CMISettingDefinition
returns the CMISettingDefinition as String
toString() - Method in class com.sap.tc.cmi.metadata.CMICardinality
returns a String representation of the cardinality
TYPE_GENERIC - Static variable in interface com.sap.tc.cmi.metadata.ICMIModelInfo
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
TYPE_REVERSEENGINEERED - Static variable in interface com.sap.tc.cmi.metadata.ICMIModelInfo
This model type means that the CMI model was created (at design time) by a XMI import into the SAP Netweaver Developer Studio.
TYPE_RFCADAPTER - Static variable in interface com.sap.tc.cmi.metadata.ICMIModelInfo
This model type means that the CMI model was created out of the import of an RFC model

A C E F G I L M R S T
CMI documentation

Copyright © 2002 SAP AG. Automatically generated Thu Mar 3 2005, 21:53