public interface CommonURIBuilder<UB extends CommonURIBuilder<?>>
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.
|
UB addQueryOption(QueryOption option, String value)
option
- query option.value
- query option value.UB replaceQueryOption(QueryOption option, String value)
option
- query option.value
- query option value.UB addQueryOption(String option, String value, boolean replace)
option
- query option.value
- query option value.replace
- if true then replace existing one.UB addParameterAlias(String alias, String exp)
alias
- parameter alias.exp
- expression value.UB appendEntitySetSegment(String segmentValue)
segmentValue
- segment value.UB appendKeySegment(Object val)
val
- segment value.UB appendKeySegment(Map<String,Object> segmentValues)
segmentValues
- segment values.UB appendPropertySegment(String segmentValue)
segmentValue
- segment value.UB appendNavigationSegment(String segmentValue)
segmentValue
- segment value.UB appendDerivedEntityTypeSegment(String segmentValue)
segmentValue
- segment value.UB appendValueSegment()
UB appendOperationCallSegment(String operation)
operation
- Operation (action or function) nameUB appendMetadataSegment()
UB appendBatchSegment()
UB count()
UB expand(String... expandItems)
expandItems
- items to be expanded in-lineQueryOption.EXPAND
UB format(String format)
format
- media type acceptable in a response.QueryOption.FORMAT
UB filter(URIFilter filter)
filter
- filter instance (to be obtained via FilterFactory);
note that build() method will be immediately invoked.QueryOption.FILTER
,
URIFilter
,
CommonFilterFactory
UB filter(String filter)
filter
- filter string.QueryOption.FILTER
UB select(String... selectItems)
selectItems
- select itemsQueryOption.SELECT
UB orderBy(String order)
order
- order string.QueryOption.ORDERBY
UB top(int top)
top
- maximum number of entities to be returned.QueryOption.TOP
UB skip(int skip)
skip
- number of entities to be skipped into the response.QueryOption.SKIP
UB skipToken(String skipToken)
skipToken
- opaque token.QueryOption.SKIPTOKEN
URI build()
Copyright © 2013–2015 The Apache Software Foundation. All rights reserved.