com.sap.smp.client.odata.metadata

Interface ODataMetaEntitySet

All Superinterfaces:

ODataMetaAnnotable, java.io.Serializable

All Known Implementing Classes:

ODataMetaEntitySetDefaultImpl

public interface ODataMetaEntitySet
extends ODataMetaAnnotable

Metadata (edm:EntitySet) element is a nominal type that represents an entity set in an entity model.
An entity set contains entity types specified by the edm:EntityType attribute.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAnnotation(AnnotationName name) Retrieves the annotation value of the entity set specified by the given fully qualified annotation name.
java.lang.String	getAnnotation(java.lang.String namespace, java.lang.String name) Retrieves the annotation value of the entity set with the given annotation namespace and localname.
java.util.Set<AnnotationName>	getAnnotationNames() Retrieves the annotation names of the entity set.
java.lang.String	getEntityType() Retrieves the fully qualified entity type name which this set contains.
java.lang.String	getName() Retrieves the name of the entity set.

Methods inherited from interface com.sap.smp.client.odata.metadata.ODataMetaAnnotable

getVocabularyAnnotation, getVocabularyAnnotation, getVocabularyAnnotationNames

Method Detail

getName

java.lang.String getName()

Retrieves the name of the entity set.

Returns:

the name of the entity set, always non-null

getEntityType

java.lang.String getEntityType()

Retrieves the fully qualified entity type name which this set contains.

Returns:

the fully qualified entity type name, always non-null

getAnnotationNames

java.util.Set<AnnotationName> getAnnotationNames()

Retrieves the annotation names of the entity set. It returns an empty set if there is no annotation in this entity set.

Returns:

the annotation names of the entity set, always non-null

getAnnotation

java.lang.String getAnnotation(AnnotationName name)

Retrieves the annotation value of the entity set specified by the given fully qualified annotation name.

Parameters:

name - fully qualified annotation name. MUST be nn-null, otherwise NullPointerException is thrown

Returns:

the annotation value if found, null otherwise

Throws:

java.lang.NullPointerException - if name parameter is null

getAnnotation

java.lang.String getAnnotation(java.lang.String namespace,
                               java.lang.String name)

Retrieves the annotation value of the entity set with the given annotation namespace and localname.

Parameters:

namespace - namespace of the annotation, can be null

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

Returns:

the annotation of the entity set if found, null otherwise

Throws:

java.lang.NullPointerException - is name parameter is null