org.odata4j.core
Interface OLink

All Superinterfaces:

Titled

All Known Subinterfaces:

ORelatedEntitiesLink, ORelatedEntitiesLinkInline, ORelatedEntityLink, ORelatedEntityLinkInline

public interface OLink
extends Titled

An OLink represents a reference to one or more OData entities.

Relationships to a single entity are represented as ORelatedEntityLink. Relationships to multiple entities are represented as ORelatedEntitiesLink.

The OLinks static factory class can be used to create OLink instances.

See Also:

OLinks

Method Summary

String	getHref() Gets the link href.
List<OEntity>	getRelatedEntities() Gets the inlined referents.
OEntity	getRelatedEntity() Gets the inlined referent.
String	getRelation() Gets the link relation.
String	getTitle() Gets the link title.
boolean	isCollection() Returns true if this OLink represents a collection of related entities, false if it is a single entity link.
boolean	isInline() Returns true if this OLink represents inlined content, false otherwise.

Method Detail

getHref

String getHref()

Gets the link href.

Returns:

the link href

getRelatedEntities

List<OEntity> getRelatedEntities()

Gets the inlined referents.

getRelatedEntity

OEntity getRelatedEntity()

Gets the inlined referent.

getRelation

String getRelation()

Gets the link relation.

Returns:

the link relation

getTitle

String getTitle()

Gets the link title.

Specified by:

getTitle in interface Titled

Returns:

the link title

isCollection

boolean isCollection()

Returns true if this OLink represents a collection of related entities, false if it is a single entity link.

isInline

boolean isInline()

Returns true if this OLink represents inlined content, false otherwise.