com.sap.tc.cmi.annotations

Interface ICMIAnnotatedClassInfo

All Superinterfaces:

ICMIAbstractInfo, ICMIModelClassInfo

public interface ICMIAnnotatedClassInfo
extends ICMIModelClassInfo

Additional metadata for an annotated class. Can be retrieved from an ICMIAnnotatedClass or ICMIModelClassinfo can be checked if it is an instance of this interface.

Type Classification:

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

Method Summary

ICMIAnnotationInfo	getAnnotationInfo(String annotationName) Note: metadata should not throw exceptions if requested information is not available.
ICMIAnnotationInfo[]	getAnnotationInfos()
ICMIAnnotationInfo	getAttributeAnnotationInfo(String attributeName, String annotationName) Note: metadata should not throw exceptions if requested information is not available.
ICMIAnnotationInfo	getAttributeAnnotationInfo(String attributeName, String[] componentPath, String annotationName)
ICMIAnnotationInfo[]	getAttributeAnnotationInfos(String attributeName)
ICMIAnnotationInfo[]	getAttributeAnnotationInfos(String attributeName, String[] componentPath)
ICMIClassAnnotationProvider	getStaticAnnotations()
ICMIAnnotationInfo	getTargetRoleAnnotationInfo(String targetRoleName, String annotationName) Note: metadata should not throw exceptions if requested information is not available.
ICMIAnnotationInfo[]	getTargetRoleAnnotationInfos(String targetRoleName)

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

getModelInfo, getName, getPropertyInfo, getPropertyInfos, getRelatedModelClassInfo, getSourceRoleInfos, getStructureType, getTargetRoleInfo, isGeneric, iteratePropertyInfos, iterateSourceRoleInfos

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

addSupportedOption, getSetting, getSettings, setSetting, supportedOptions, supports

Method Detail

getAnnotationInfos

ICMIAnnotationInfo[] getAnnotationInfos()

getAnnotationInfo

ICMIAnnotationInfo getAnnotationInfo(String annotationName)

Note: metadata should not throw exceptions if requested information is not available.

Parameters:

annotationName -

Returns:

annotation info or null if no such annotation exists.

getAttributeAnnotationInfos

ICMIAnnotationInfo[] getAttributeAnnotationInfos(String attributeName)

getAttributeAnnotationInfos

ICMIAnnotationInfo[] getAttributeAnnotationInfos(String attributeName,
                                                 String[] componentPath)

getAttributeAnnotationInfo

ICMIAnnotationInfo getAttributeAnnotationInfo(String attributeName,
                                              String annotationName)

Note: metadata should not throw exceptions if requested information is not available.

Parameters:

annotationName -

Returns:

annotation info or null if no such annotation exists.

getAttributeAnnotationInfo

ICMIAnnotationInfo getAttributeAnnotationInfo(String attributeName,
                                              String[] componentPath,
                                              String annotationName)

getTargetRoleAnnotationInfos

ICMIAnnotationInfo[] getTargetRoleAnnotationInfos(String targetRoleName)

getTargetRoleAnnotationInfo

ICMIAnnotationInfo getTargetRoleAnnotationInfo(String targetRoleName,
                                               String annotationName)

Note: metadata should not throw exceptions if requested information is not available.

Parameters:

annotationName -

Returns:

annotation info or null if no such annotation exists.

getStaticAnnotations

ICMIClassAnnotationProvider getStaticAnnotations()

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