com.sap.smp.client.odata.metadata

Interface ODataMetaEntityContainer

All Superinterfaces:

ODataMetaAnnotable, java.io.Serializable

All Known Implementing Classes:

ODataMetaEntityContainerDefaultImpl

public interface ODataMetaEntityContainer
extends ODataMetaAnnotable

Represents the metadata of an entity container (edm:EntityContainer).
The edm:EntityContainer element represents an entity container in an entity model. It corresponds to a logical data store and contains zero or more entity sets (edm:EntitySet) or function imports (edm:FunctionImport) elements.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAnnotation(AnnotationName name) Retrieves the annotation value specified by the given annotation name.
java.lang.String	getAnnotation(java.lang.String namespace, java.lang.String name) Retrieves the annotation value specified by the given annotation namespace and loccalname.
java.util.Set<AnnotationName>	getAnnotationNames() Retrieves the set of annotation names belonging to the entity container.
java.util.Set<java.lang.String>	getEntitySetNames() Retrieves the names of the entity sets.
ODataMetaFunctionImport	getFunctionImport(java.lang.String name) Retrieves the metadata representation of function import specified by the given name.
java.util.Set<java.lang.String>	getFunctionImportNames() Retrieves the set of function import names.
ODataMetaEntitySet	getMetaEntitySet(java.lang.String name) Retrieves the entity set specified by the given name.

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

getVocabularyAnnotation, getVocabularyAnnotation, getVocabularyAnnotationNames

Method Detail

getFunctionImportNames

java.util.Set<java.lang.String> getFunctionImportNames()

Retrieves the set of function import names.

Returns:

set of the function import names, always non-null

getFunctionImport

ODataMetaFunctionImport getFunctionImport(java.lang.String name)

Retrieves the metadata representation of function import specified by the given name.

Parameters:

name - of the function import. MUST be non-null, otherwise NullPointerException is thrown

Returns:

metadata representing the function import (edm:FunctionImport) if found, null otherwise

Throws:

java.lang.NullPointerException - if name parameter is null

getEntitySetNames

java.util.Set<java.lang.String> getEntitySetNames()

Retrieves the names of the entity sets.

Returns:

names of the entity sets, always non-null

getMetaEntitySet

ODataMetaEntitySet getMetaEntitySet(java.lang.String name)

Retrieves the entity set specified by the given name.

Parameters:

name - name of the entity set. MUST be non-null, otherwise NullPointerException is thrown

Returns:

metadata representation of entity set (edm:EntitySet) if found, null otherwise

Throws:

java.lang.NullPointerException - if name parameter is null

getAnnotationNames

java.util.Set<AnnotationName> getAnnotationNames()

Retrieves the set of annotation names belonging to the entity container.

Returns:

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

getAnnotation

java.lang.String getAnnotation(AnnotationName name)

Retrieves the annotation value specified by the given annotation name.

Parameters:

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

Returns:

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 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 value if found, null otherwise

Throws:

java.lang.NullPointerException - if name parameter is null