com.sap.smp.client.odata.metadata

Interface ODataMetaAnnotable

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ODataMetaAnnotationTerm, ODataMetaComplexType, ODataMetaEntityContainer, ODataMetaEntitySet, ODataMetaEntityType, ODataMetaFunctionImport, ODataMetaNavigationProperty, ODataMetaProperty

All Known Implementing Classes:

AnnotableDefaultImpl, ODataAnnotationTermDefaultImpl, ODataMetaComplexTypeDefaultImpl, ODataMetaEntityContainerDefaultImpl, ODataMetaEntitySetDefaultImpl, ODataMetaEntityTypeDefaultImpl, ODataMetaFunctionImportDefaultImpl, ODataMetaNavigationPropertyDefaultImpl, ODataMetaPropertyDefaultImpl

public interface ODataMetaAnnotable
extends java.io.Serializable

The Interface Annotable. Base interface for metadata elements supports Odata v4.0 vocabulary-based annotation

Method Summary

Modifier and Type	Method and Description
ODataMetaAnnotation	getVocabularyAnnotation(AnnotationName name) Retrieves the Odata v4.0 vocabulary-based annotation specified by the given annotation name.
ODataMetaAnnotation	getVocabularyAnnotation(java.lang.String namespace, java.lang.String name) Retrieves the Odata v4.0 vocabulary-based annotation specified by the given annotation namespace and loccalname.
java.util.Set<AnnotationName>	getVocabularyAnnotationNames() Retrieves the set of Odata v4.0 vocabulary-based annotation names belonging to the element.

Method Detail

getVocabularyAnnotationNames

java.util.Set<AnnotationName> getVocabularyAnnotationNames()

Retrieves the set of Odata v4.0 vocabulary-based annotation names belonging to the element.

Returns:

set of annotation names belonging to the element, always non-null

getVocabularyAnnotation

ODataMetaAnnotation getVocabularyAnnotation(AnnotationName name)

Retrieves the Odata v4.0 vocabulary-based annotation specified by the given annotation name.

Parameters:

name - fully qualified name of the annotation. MUST be non-null, otherwise NullPointerException is thrown

Returns:

annotation if found, null otherwise

Throws:

java.lang.NullPointerException - if name parameter is null

getVocabularyAnnotation

ODataMetaAnnotation getVocabularyAnnotation(java.lang.String namespace,
                                            java.lang.String name)

Retrieves the Odata v4.0 vocabulary-based annotation specified by the given annotation namespace and loccalname.

Parameters:

namespace - namespace of the annotation, can be null

name - local name of the annotation. It MUST be non-null, otherwise NullpointerException is thrown.

Returns:

annotation if found, null otherwise

Throws:

java.lang.NullPointerException - if name parameter is null