com.sap.tc.cmi.metadata

Interface ICMIRelationRoleInfo

All Superinterfaces:

ICMIAbstractInfo

public interface ICMIRelationRoleInfo
extends ICMIAbstractInfo

Represents the metadata of a model relation role at runtime.

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.

Method Summary

CMICardinality	getCardinality() Returns the cardinality of this role as one of the enum values defined by CMICardinality.
ICMIModelClassInfo	getModelClassInfo() Returns the model class info of the model class, to which the role belongs.
ICMIRelationInfo	getModelRelationInfo() Returns the corresponding relation info or null, if this method is not supported.
ICMIRelationRoleInfo	getOtherRoleInfo() Returns the other role.
boolean	isAggregation() Returns true, if this role is an aggregating role.
boolean	isNavigable() Returns true, if this role is navigable.
boolean	isReadOnly() Returns true, if this role is read only and can't be modified at runtime by an application or by the framework.

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

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

Method Detail

getModelClassInfo

ICMIModelClassInfo getModelClassInfo()

Returns the model class info of the model class, to which the role belongs.

getOtherRoleInfo

ICMIRelationRoleInfo getOtherRoleInfo()

Returns the other role. If this is the source role info, the target role info is returned and vice versa. An implementation can derive this information from the corresponding relation info or from a source role : target role association.

getModelRelationInfo

ICMIRelationInfo getModelRelationInfo()

Returns the corresponding relation info or null, if this method is not supported. So model implementations, which have difficulties to supply relation info, can implement this method with return null;

getCardinality

CMICardinality getCardinality()

Returns the cardinality of this role as one of the enum values defined by CMICardinality.

isReadOnly

boolean isReadOnly()

Returns true, if this role is read only and can't be modified at runtime by an application or by the framework.

isAggregation

boolean isAggregation()

Returns true, if this role is an aggregating role.

isNavigable

boolean isNavigable()

Returns true, if this role is navigable.

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