com.sap.client.odata.v4

Class ExpandItem

java.lang.Object

com.sap.client.odata.v4.ExpandItem

public class ExpandItem
extends java.lang.Object

Encapsulates an OData expand item. An expand item indicates a property (or expression) that is used in the $expand system query option.

See Also:

DataQuery.expandItems.

Property Summary

Type	Property and Description
Property	to If this expand item references a simple property path, then return the property.
Property	toRequired If this expand item references a simple property path, then return the property.

Constructor Summary

Constructors

Constructor and Description
ExpandItem()

Method Summary

Modifier and Type	Method and Description
DataPath	getPath() A path to be expanded in the query results.
DataQuery	getQuery() (nullable) A query to configure the expansion (including nested expands).
DataQuery	getRequiredQuery() Return ExpandItem.query is it is non-null, otherwise a new DataQuery.
static ExpandItem	of(PropertyPath item) Return a new expand item for the specified property.
void	setPath(DataPath value) A path to be expanded in the query results.
void	setQuery(DataQuery value) A query to configure the expansion (including nested expands).
Property	toProperty() If this expand item references a simple property path, then return the property.
Property	toRequiredProperty() If this expand item references a simple property path, then return the property.
java.lang.String	toString() Return a string representation of this expand item.
ExpandItem	withQuery(DataQuery query) Set the query of this expand item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

to

public Property toProperty

If this expand item references a simple property path, then return the property. Otherwise return null.

toRequired

public Property toRequiredProperty

If this expand item references a simple property path, then return the property. Otherwise throw an exception.

Throws:

UndefinedException if this select item does not reference a simple property path.

Constructor Detail

ExpandItem

public ExpandItem()

Method Detail

getPath

public DataPath getPath()

A path to be expanded in the query results.

getQuery

public DataQuery getQuery()

(nullable) A query to configure the expansion (including nested expands).

getRequiredQuery

public DataQuery getRequiredQuery()

Return ExpandItem.query is it is non-null, otherwise a new DataQuery.

Returns:

ExpandItem.query is it is non-null, otherwise a new DataQuery.

of

public static ExpandItem of(PropertyPath item)

Return a new expand item for the specified property.

Parameters:

item - Item to be expanded.

Returns:

A new expand item for the specified property.

setPath

public void setPath(DataPath value)

A path to be expanded in the query results.

setQuery

public void setQuery(DataQuery value)

A query to configure the expansion (including nested expands).

toProperty

public Property toProperty()

If this expand item references a simple property path, then return the property. Otherwise return null.

toRequiredProperty

public Property toRequiredProperty()

If this expand item references a simple property path, then return the property. Otherwise throw an exception.

Throws:

UndefinedException if this select item does not reference a simple property path.

toString

public java.lang.String toString()

Return a string representation of this expand item.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this expand item.

withQuery

public ExpandItem withQuery(DataQuery query)

Set the query of this expand item.

Parameters:

query - Data query.

Returns:

This query.