com.sap.tc.cmi.metadata
Interface ICMIModelObjectCollectionInfo

All Superinterfaces:

ICMIAbstractInfo

public interface ICMIModelObjectCollectionInfo

extends ICMIAbstractInfo

Represents the metadata of an instance of ICMIModelObjectCollection at runtime. Implementing this class and providing instances of this class for each model object collection is optional for a model implementation. This type can be called, extendeded or implemented by applications or frameworks using CMI.

Since:

6.30 Beta 3

Version:

$Id: //tc/CommonModelInterface/630_VAL_REL/src/_cmi_api/java/com/sap/tc/cmi/metadata/ICMIModelObjectCollectionInfo.java#1 $

Method Summary

ICMIModelClassInfo

getElementModelClassInfo() Returns meta info that describes the elements of the collection.

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

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

Method Detail

getElementModelClassInfo

public ICMIModelClassInfo getElementModelClassInfo()

Returns meta info that describes the elements of the collection. If there is no such meta info available, null is returned.

There may be several different reasons, why null is returned:

• model implementation doesn't provide meta info for classes at all
• model implementation didn't implement this method (as it is optional)
• a model implementation doesn't know a meta info that is valid for all elements in the collection.

The only guarantee is, that if a model class info is returned, all elements in the collection must be compatible with that meta info. That is an element may either implement IWDGenericModelClass and provide access to all attributes and roles described in the class meta info or an element may be a typed model class with typed accessors for all these attributes and roles. Both cases can even occur in a single collection.

A first class model implementation should always return a model class info for collections with a single type of elements. For collections that contain multiple types of elements, it should provide meta info describing the "greatest common denominator" (eg. describing a common baseclass).