com.sap.smp.client.odata

Interface ODataEntity

All Superinterfaces:

ODataPayload, java.io.Serializable

All Known Implementing Classes:

ODataEntityDefaultImpl

public interface ODataEntity
extends ODataPayload

Payload type representing an OData entry. This is the main abstraction through which business entities mapped using OData can be read and modified.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.smp.client.odata.ODataPayload

ODataPayload.Type

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAnnotation(AnnotationName name) Returns the annotation value specified by the given fully qualified local annotation name.
java.lang.String	getAnnotation(java.lang.String namespace, java.lang.String name) Returns the annotation value specified by the given local annotation namespace and localname.
java.util.Set<AnnotationName>	getAnnotationNames() Returns a set of fully qualified local annotation names.
java.net.URL	getEditMediaLink() Returns the edit media link of this entity.
java.lang.String	getEditResourcePath() Returns the path to the endpoint through which this entity can be edited.
java.lang.String	getEntityType() Returns the type of the entity in it's fully-qualified form which includes the namespace prefix.
java.lang.String	getEtag() Returns the ETag of the entry backing this entity.
java.lang.String	getMediaContentType() Returns the content type of the media.
java.lang.String	getMediaEtag() Returns the ETag of the media resource.
java.net.URL	getMediaLink() Returns the media link of this entity.
ODataNavigationProperty	getNavigationProperty(java.lang.String key) Returns the navigation property associated with the given key.
java.util.Set<java.lang.String>	getNavigationPropertyNames() Returns the set containing the names of navigation properties.
ODataPropMap	getProperties() Returns the current map containing the data properties of this entity.
java.lang.String	getResourcePath() Returns the path from which this entity has been obtained.
boolean	isMediaEntry() Convenience method telling whether this entity is a media entry.
void	setEtag(java.lang.String etag) Sets the ETag of the entry backing this entity.
void	setMediaEtag(java.lang.String mediaEtag) Sets the media ETag
void	setMediaLink(java.lang.String mediaContentType, java.net.URL link, java.net.URL editLink) Sets the media links and the media content type of this entity.
ODataNavigationProperty	setNavigationProperty(java.lang.String key, ODataNavigationProperty link) Associates the specified key with the specified navigation property.
void	setResourcePath(java.lang.String resourcePath, java.lang.String editResourcePath) Sets resource paths.

Method Detail

getEntityType

java.lang.String getEntityType()

Returns the type of the entity in it's fully-qualified form which includes the namespace prefix.

Returns:

the entity type, can be null

getResourcePath

java.lang.String getResourcePath()

Returns the path from which this entity has been obtained. The path is relative to the base URL.

Returns:

the resource path, can be null

getEditResourcePath

java.lang.String getEditResourcePath()

Returns the path to the endpoint through which this entity can be edited. The path is relative to the base URL.

Returns:

the edit resource path, can be null

setResourcePath

void setResourcePath(java.lang.String resourcePath,
                     java.lang.String editResourcePath)

Sets resource paths. All arguments should be relative to the base URL.

Parameters:

resourcePath - the resource path, can be null

editResourcePath - the edit resource path, can be null

isMediaEntry

boolean isMediaEntry()

Convenience method telling whether this entity is a media entry. An entity qualifies as such in case it either the media link or the edit media link is set.

Returns:

true if this is a media entry, false otherwise

getMediaContentType

java.lang.String getMediaContentType()

Returns the content type of the media.

Returns:

the media content type, can be null

getMediaLink

java.net.URL getMediaLink()

Returns the media link of this entity.

Returns:

the media link, can be null

getEditMediaLink

java.net.URL getEditMediaLink()

Returns the edit media link of this entity.

Returns:

the edit media link, can be null

setMediaLink

void setMediaLink(java.lang.String mediaContentType,
                  java.net.URL link,
                  java.net.URL editLink)

Sets the media links and the media content type of this entity.

Parameters:

mediaContentType - the media content type, can be null

link - the media link, can be null

editLink - the edit media link, can be null

getNavigationPropertyNames

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

Returns the set containing the names of navigation properties. The returned set may be backed by this object and therefore should not be modified by the caller!

Returns:

the set of navigation property names, always non-null

getNavigationProperty

ODataNavigationProperty getNavigationProperty(java.lang.String key)

Returns the navigation property associated with the given key.

Parameters:

key - the key of the property, can be null

Returns:

the associated navigation property or null if none is found

setNavigationProperty

ODataNavigationProperty setNavigationProperty(java.lang.String key,
                                              ODataNavigationProperty link)

Associates the specified key with the specified navigation property.

Parameters:

key - the key, must be non-null

link - the property, must be non-null

Returns:

the previous property associated with the key, can be null

getProperties

ODataPropMap getProperties()

Returns the current map containing the data properties of this entity.

Returns:

the map of entity properties, always non-null

getEtag

java.lang.String getEtag()

Returns the ETag of the entry backing this entity.

Returns:

the entity tag, can be null

getMediaEtag

java.lang.String getMediaEtag()

Returns the ETag of the media resource. It can be non-null if the this entity is a media entity.

Returns:

the entity media tag, can be null

setMediaEtag

void setMediaEtag(java.lang.String mediaEtag)

Sets the media ETag

Parameters:

mediaEtag - the media etag, can be null

setEtag

void setEtag(java.lang.String etag)

Sets the ETag of the entry backing this entity.

Parameters:

etag - the entity tag, can be null

getAnnotationNames

java.util.Set<AnnotationName> getAnnotationNames()

Returns a set of fully qualified local annotation names.

Returns:

set of fully qualified local annotation names, always non-null

getAnnotation

java.lang.String getAnnotation(AnnotationName name)

Returns the annotation value specified by the given fully qualified local annotation name.

Parameters:

name - fully qualified local annotation name

Returns:

the annotation value if found, null otherwise

getAnnotation

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

Returns the annotation value specified by the given local annotation namespace and localname.

Parameters:

namespace - annotation namespace, can be null

name - annotation local name. It MUST be non-null, otherwise NullPointerException is thrown

Returns:

the annotation value if found, null otherwise

Throws:

java.lang.NullPointerException - if name parameter is null