org.apache.olingo.commons.api.domain

Interface CommonODataEntity

All Superinterfaces:

ODataInvokeResult, ODataLinked

All Known Subinterfaces:

ODataEntity, ODataEntity, ODataSingleton

public interface CommonODataEntity
extends ODataLinked, ODataInvokeResult

OData entity.

Method Summary

Methods

Modifier and Type	Method and Description
URI	getEditLink() Returns OData entity edit link.
String	getETag() Gets ETag.
URI	getLink()
URI	getMediaContentSource() Gets media content source.
String	getMediaContentType() Gets media content type.
ODataLink	getMediaEditLink(String name) Gets media-edit link with given name, if available, otherwise null.
List<ODataLink>	getMediaEditLinks() Returns entity media edit links.
String	getMediaETag() ETag of the binary stream represented by this media entity or named stream property.
ODataOperation	getOperation(String title) Searches for operation with given title.
List<ODataOperation>	getOperations() Gets operations.
List<? extends CommonODataProperty>	getProperties() Returns OData entity properties.
CommonODataProperty	getProperty(String name) Searches for property with given name.
FullQualifiedName	getTypeName()
boolean	isMediaEntity() Checks if the current entity is a media entity.
boolean	isReadOnly() TRUE if read-only entity.
void	setEditLink(URI editLink) Sets OData entity edit link.
void	setETag(String eTag) Sets ETag.
void	setMediaContentSource(URI mediaContentSource) Sets media content source.
void	setMediaContentType(String mediaContentType) Sets media content type.
void	setMediaEntity(boolean isMediaEntity) Sets media entity flag.
void	setMediaETag(String eTag) Set media ETag.

Methods inherited from interface org.apache.olingo.commons.api.domain.ODataLinked

addLink, getAssociationLink, getAssociationLinks, getNavigationLink, getNavigationLinks, removeLink

Method Detail

getTypeName

FullQualifiedName getTypeName()

Returns:

the type name of this entity.

getLink

URI getLink()

Returns:

self link.

getEditLink

URI getEditLink()

Returns OData entity edit link.

Returns:

entity edit link.

setEditLink

void setEditLink(URI editLink)

Sets OData entity edit link.

Parameters:

editLink - edit link.

getETag

String getETag()

Gets ETag.

Returns:

ETag.

setETag

void setETag(String eTag)

Sets ETag.

Parameters:

eTag - ETag.

getOperation

ODataOperation getOperation(String title)

Searches for operation with given title.

Parameters:

title - operation to look for

Returns:

operation if found with given title, null otherwise

getOperations

List<ODataOperation> getOperations()

Gets operations.

Returns:

operations.

getProperty

CommonODataProperty getProperty(String name)

Searches for property with given name.

Parameters:

name - property to look for

Returns:

property if found with given name, null otherwise

getProperties

List<? extends CommonODataProperty> getProperties()

Returns OData entity properties.

Returns:

OData entity properties.

getMediaEditLink

ODataLink getMediaEditLink(String name)

Gets media-edit link with given name, if available, otherwise null.

Parameters:

name - candidate link name

Returns:

media-edit link with given name, if available, otherwise null

getMediaEditLinks

List<ODataLink> getMediaEditLinks()

Returns entity media edit links.

Returns:

OData entity links.

isReadOnly

boolean isReadOnly()

TRUE if read-only entity.

Returns:

TRUE if read-only; FALSE otherwise.

isMediaEntity

boolean isMediaEntity()

Checks if the current entity is a media entity.

Returns:

'TRUE' if media entity; 'FALSE' otherwise.

setMediaEntity

void setMediaEntity(boolean isMediaEntity)

Sets media entity flag.

Parameters:

isMediaEntity - media entity flag value.

getMediaContentType

String getMediaContentType()

Gets media content type.

Returns:

media content type.

setMediaContentType

void setMediaContentType(String mediaContentType)

Sets media content type.

Parameters:

mediaContentType - media content type.

getMediaContentSource

URI getMediaContentSource()

Gets media content source.

Returns:

media content source.

setMediaContentSource

void setMediaContentSource(URI mediaContentSource)

Sets media content source.

Parameters:

mediaContentSource - media content source.

getMediaETag

String getMediaETag()

ETag of the binary stream represented by this media entity or named stream property.

Returns:

media ETag value

setMediaETag

void setMediaETag(String eTag)

Set media ETag.

Parameters:

eTag - media ETag value