org.apache.olingo.client.api.uri

Interface CommonURIBuilder<UB extends CommonURIBuilder<?>>

All Known Subinterfaces:

URIBuilder, URIBuilder

public interface CommonURIBuilder<UB extends CommonURIBuilder<?>>

OData URI builder.

Method Summary

Methods

Modifier and Type	Method and Description
UB	addParameterAlias(String alias, String exp) Adds the specified (custom) parameter alias to the URI.
UB	addQueryOption(QueryOption option, String value) Adds the specified query option to the URI.
UB	addQueryOption(String option, String value, boolean replace) Adds/Replaces the specified (custom) query option to the URI.
UB	appendBatchSegment() Appends batch segment to the URI.
UB	appendDerivedEntityTypeSegment(String segmentValue) Appends derived entity type segment to the URI.
UB	appendEntitySetSegment(String segmentValue) Appends EntitySet segment to the URI.
UB	appendKeySegment(Map<String,Object> segmentValues) Appends key segment to the URI, for multiple keys.
UB	appendKeySegment(Object val) Appends key segment to the URI.
UB	appendMetadataSegment() Appends metadata segment to the URI.
UB	appendNavigationSegment(String segmentValue) Appends navigation segment to the URI.
UB	appendOperationCallSegment(String operation) Appends operation (action or function) segment to the URI.
UB	appendPropertySegment(String segmentValue) Appends property segment to the URI.
UB	appendValueSegment() Appends value segment to the URI.
URI	build() Build OData URI.
UB	count() Adds count query option.
UB	expand(String... expandItems) Adds expand query option.
UB	filter(String filter) Adds filter query option.
UB	filter(URIFilter filter) Adds filter for filter query option.
UB	format(String format) Adds format query option.
UB	orderBy(String order) Adds orderby query option.
UB	replaceQueryOption(QueryOption option, String value) Adds/replaces the specified query option to the URI.
UB	select(String... selectItems) Adds select query option.
UB	skip(int skip) Adds skip query option.
UB	skipToken(String skipToken) Adds skiptoken query option.
UB	top(int top) Adds top query option.

Method Detail

addQueryOption

UB addQueryOption(QueryOption option,
                String value)

Adds the specified query option to the URI.
Concatenates value if the specified query option already exists.

Parameters:

option - query option.

value - query option value.

Returns:

current URIBuilder instance

replaceQueryOption

UB replaceQueryOption(QueryOption option,
                    String value)

Adds/replaces the specified query option to the URI.

Parameters:

option - query option.

value - query option value.

Returns:

current URIBuilder instance

addQueryOption

UB addQueryOption(String option,
                String value,
                boolean replace)

Adds/Replaces the specified (custom) query option to the URI.

Parameters:

option - query option.

value - query option value.

replace - if true then replace existing one.

Returns:

current URIBuilder instance.

addParameterAlias

UB addParameterAlias(String alias,
                   String exp)

Adds the specified (custom) parameter alias to the URI.

Parameters:

alias - parameter alias.

exp - expression value.

Returns:

current URIBuilder instance.

appendEntitySetSegment

UB appendEntitySetSegment(String segmentValue)

Appends EntitySet segment to the URI.

Parameters:

segmentValue - segment value.

Returns:

current URIBuilder instance

appendKeySegment

UB appendKeySegment(Object val)

Appends key segment to the URI.

Parameters:

val - segment value.

Returns:

current URIBuilder instance

appendKeySegment

UB appendKeySegment(Map<String,Object> segmentValues)

Appends key segment to the URI, for multiple keys.

Parameters:

segmentValues - segment values.

Returns:

current URIBuilder instance

appendPropertySegment

UB appendPropertySegment(String segmentValue)

Appends property segment to the URI.

Parameters:

segmentValue - segment value.

Returns:

current URIBuilder instance

appendNavigationSegment

UB appendNavigationSegment(String segmentValue)

Appends navigation segment to the URI.

Parameters:

segmentValue - segment value.

Returns:

current URIBuilder instance

appendDerivedEntityTypeSegment

UB appendDerivedEntityTypeSegment(String segmentValue)

Appends derived entity type segment to the URI.

Parameters:

segmentValue - segment value.

Returns:

current URIBuilder instance

appendValueSegment

UB appendValueSegment()

Appends value segment to the URI.

Returns:

current URIBuilder instance

appendOperationCallSegment

UB appendOperationCallSegment(String operation)

Appends operation (action or function) segment to the URI.

Parameters:

operation - Operation (action or function) name

Returns:

current URIBuilder instance

appendMetadataSegment

UB appendMetadataSegment()

Appends metadata segment to the URI.

Returns:

current URIBuilder instance

appendBatchSegment

UB appendBatchSegment()

Appends batch segment to the URI.

Returns:

current URIBuilder instance

count

UB count()

Adds count query option.

Returns:

current URIBuilder instance

expand

UB expand(String... expandItems)

Adds expand query option.

Parameters:

expandItems - items to be expanded in-line

Returns:

current URIBuilder instance

See Also:

QueryOption.EXPAND

format

UB format(String format)

Adds format query option.

Parameters:

format - media type acceptable in a response.

Returns:

current URIBuilder instance

See Also:

QueryOption.FORMAT

filter

UB filter(URIFilter filter)

Adds filter for filter query option.

Parameters:

filter - filter instance (to be obtained via FilterFactory); note that build() method will be immediately invoked.

Returns:

current URIBuilder instance

See Also:

QueryOption.FILTER, URIFilter, CommonFilterFactory

filter

UB filter(String filter)

Adds filter query option.

Parameters:

filter - filter string.

Returns:

current URIBuilder instance

See Also:

QueryOption.FILTER

select

UB select(String... selectItems)

Adds select query option.

Parameters:

selectItems - select items

Returns:

current URIBuilder instance

See Also:

QueryOption.SELECT

orderBy

UB orderBy(String order)

Adds orderby query option.

Parameters:

order - order string.

Returns:

current URIBuilder instance

See Also:

QueryOption.ORDERBY

top

UB top(int top)

Adds top query option.

Parameters:

top - maximum number of entities to be returned.

Returns:

current URIBuilder instance

See Also:

QueryOption.TOP

skip

UB skip(int skip)

Adds skip query option.

Parameters:

skip - number of entities to be skipped into the response.

Returns:

current URIBuilder instance

See Also:

QueryOption.SKIP

skipToken

UB skipToken(String skipToken)

Adds skiptoken query option.

Parameters:

skipToken - opaque token.

Returns:

current URIBuilder instance

See Also:

QueryOption.SKIPTOKEN

build

URI build()

Build OData URI.

Returns:

OData URI.