com.sap.smp.client.odata.metadata

Interface ODataMetaEntityType

All Superinterfaces:

ODataMetaAnnotable, java.io.Serializable

All Known Implementing Classes:

ODataMetaEntityTypeDefaultImpl

public interface ODataMetaEntityType
extends ODataMetaAnnotable

Represents an entity type in the entity model (edm:EntityType).
Entity types are nominal structural types with a key that consists of one or more references to structural properties. An entity type by definition has an independent existence and can be created, updated or deleted independently of any other types. An entity type is the template for an entity: any uniquely identifiable record such as a customer or order. An entity type can define two types of properties. A structural property is a named reference to a primitive or complex type, or a collection of primitive or complex types. A navigation property is a named reference to another entity type or collection of entity types. All properties MUST have a unique name. Properties MUST NOT have the same name as the declaring entity type. An open entity type allows properties to be added to an instance of the type dynamically. Any request for the value of a missing property on an open entity type MUST return null.

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 specified by the given annotation namespace and localname.
java.util.Set<AnnotationName>	getAnnotationNames() Retrieves the set of annotation names of the entity type.
java.util.Set<java.lang.String>	getKeyPropertyNames() Retrieves the set of key property names.
java.lang.String	getName() Retrieves the name of the entity type.
ODataMetaNavigationProperty	getNavigationProperty(java.lang.String propertyName) Retrieves the metadata representation of a navigation property specified by its name.
java.util.Set<java.lang.String>	getNavigationPropertyNames() Retrieves the set of navigation property names.
ODataMetaProperty	getProperty(java.lang.String propertyName) Retrieves the metadata representation of a property.
java.util.Set<java.lang.String>	getPropertyNames() Retrieves the set of property names.
boolean	isMediaEntity() Retrieves whether this is a media entity.

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 type.

Returns:

name of the entity type, always non-null

isMediaEntity

boolean isMediaEntity()

Retrieves whether this is a media entity.

Returns:

true if this is a media entity, false otherwise

getKeyPropertyNames

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

Retrieves the set of key property names.

Returns:

set of key property names, always non-null

getPropertyNames

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

Retrieves the set of property names.

Returns:

set of property names, always non-null

getProperty

ODataMetaProperty getProperty(java.lang.String propertyName)

Retrieves the metadata representation of a property.

Parameters:

propertyName - name of the property. MUST be non-null, otherwise NullPointerException is thrown

Returns:

metadata of the property (edm:Property) if found, null otherwise

Throws:

java.lang.NullPointerException - if propertyName is null

getNavigationPropertyNames

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

Retrieves the set of navigation property names.

Returns:

set of navigation property names, always non-null

getNavigationProperty

ODataMetaNavigationProperty getNavigationProperty(java.lang.String propertyName)

Retrieves the metadata representation of a navigation property specified by its name.

Parameters:

propertyName - name of the navigation property. MUST be non-null, otherwise NullPointerException is thrown

Returns:

metadata representation of the navigation properties (edm:NavigationProperty) if found, null otherwise

Throws:

java.lang.NullPointerException - if propertyName is null

getAnnotationNames

java.util.Set<AnnotationName> getAnnotationNames()

Retrieves the set of annotation names of the entity type.

Returns:

the set of annotation names of the entity type, 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 non-null, otherwise NullPointerException is thrown

Returns:

the annotation value of the entity set 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 specified by 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 value of the entity set if found, null otherwise

Throws:

java.lang.NullPointerException - if name parameter is null