public interface URIBuilderForBuiltin<T extends URIBuilderForBuiltin<T>>
URI
to EBX® built-in REST services.Constants
,
CategoryURIBuilder
,
Data services documentation,
Built-in REST services documentationModifier and Type | Interface and Description |
---|---|
static interface |
URIBuilderForBuiltin.ForDataAndHistory
Aggregates methods to generate built-in REST services
URI
to data and history category resources. |
static interface |
URIBuilderForBuiltin.ForDataset<T extends URIBuilderForBuiltin<T>>
Contains methods to generate built-in REST services
URI to a dataset. |
static interface |
URIBuilderForBuiltin.ForDataspace<T extends URIBuilderForBuiltin<T>>
Beta feature:
Contains methods to generate built-in REST services
URI to a dataspace. |
static interface |
URIBuilderForBuiltin.ForNode<T extends URIBuilderForBuiltin<T>>
Contains methods to generate built-in REST services
URI to a record field
or a dataset node. |
static interface |
URIBuilderForBuiltin.ForRecord<T extends URIBuilderForBuiltin<T>>
Contains methods to generate built-in REST services
URI to a record. |
static interface |
URIBuilderForBuiltin.ForTable<T extends URIBuilderForBuiltin<T>>
Contains methods to generate built-in REST services
URI to a table. |
Modifier and Type | Method and Description |
---|---|
URI |
build()
Returns an absolute
URI that includes every previous configured URI's part. |
T |
extendedAction(String anExtendedAction)
Appends the provided extended action to the generated URI path's end.
|
T |
firstPage()
Replaces the first page action from the existing set of query parameters.
|
T |
lastPage()
Replaces the last page action from the existing set of query parameters.
|
T |
nextPage(String aPageRecordFilter)
Replaces the next page action and page record filter from the existing set of query parameters.
|
T |
pageSize(int aPageSize)
Replaces the provided pageSize from the existing set of query parameters.
|
T |
previousPage(String aPageRecordFilter)
Replaces the previous page action and page record filter from the existing set
of query parameters.
|
T |
queryParams(Map<String,String> parameters) |
T |
queryParams(MultivaluedMap<String,String> parameters)
Appends the provided query parameters to the existing set of query parameters.
|
T queryParams(Map<String,String> parameters)
queryParams(MultivaluedMap)
T queryParams(MultivaluedMap<String,String> parameters)
parameters
- the query parameters to add to the existing set.UriBuilder.queryParam(String, Object...)
T pageSize(int aPageSize)
aPageSize
- the size of the returned page.UriBuilder.replaceQueryParam(String, Object...)
T firstPage()
If a page record filter is found, it is deleted.
UriBuilder.replaceQueryParam(String, Object...)
T lastPage()
If a page record filter is found, it is deleted.
UriBuilder.replaceQueryParam(String, Object...)
T nextPage(String aPageRecordFilter)
aPageRecordFilter
- a record XPath predicate
expression used to determine the pagination contexts.
It should not be modified on the client side.UriBuilder.replaceQueryParam(String, Object...)
T previousPage(String aPageRecordFilter)
aPageRecordFilter
- a record XPath predicate
expression used to determine the pagination contexts.
It should not be modified on the client side.UriBuilder.replaceQueryParam(String, Object...)
T extendedAction(String anExtendedAction)
Warning: When this API is run, the extended action is appended to the currently configured URI's path.
anExtendedAction
- the extended action to append. If the provided value is not prefaced
with the character :
, then it is automatically added.URI build()
URI
that includes every previous configured URI's part.