Package com.orchestranetworks.rest.util

Interface URIBuilderForBuiltin.ForDataset<T extends URIBuilderForBuiltin<T>>

All Superinterfaces:

URIBuilderForBuiltin<T>

All Known Subinterfaces:

URIBuilderForBuiltin.ForDataAndHistory

Enclosing interface:

URIBuilderForBuiltin<T extends URIBuilderForBuiltin<T>>

public static interface URIBuilderForBuiltin.ForDataset<T extends URIBuilderForBuiltin<T>>
extends URIBuilderForBuiltin<T>

Contains methods to generate built-in REST services URI to a dataset.

Since:

6.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.orchestranetworks.rest.util.URIBuilderForBuiltin

URIBuilderForBuiltin.ForDataAndHistory, URIBuilderForBuiltin.ForDataset<T extends URIBuilderForBuiltin<T>>, URIBuilderForBuiltin.ForDataspace<T extends URIBuilderForBuiltin<T>>, URIBuilderForBuiltin.ForNode<T extends URIBuilderForBuiltin<T>>, URIBuilderForBuiltin.ForRecord<T extends URIBuilderForBuiltin<T>>, URIBuilderForBuiltin.ForTable<T extends URIBuilderForBuiltin<T>>

Method Summary

Modifier and Type	Method	Description
URI	buildForDataset(Adaptation aDataset)	Returns an absolute URI to a specified dataset in its automatically computed dataspace.
URI	buildForDataset(HomeKey aDataspaceKey, AdaptationName aDatasetName)	Returns an absolute URI to a specified dataset in a specified dataspace.
UriBuilder	dataset(Adaptation aDataset)	Returns a configured URI builder which can generate built-in REST services URI to a dataset in its automatically computed dataspace.
UriBuilder	dataset(HomeKey aDataspaceKey, AdaptationName aDatasetName)	Returns a configured URI builder which can generate built-in REST services URI to a specified dataset in a specified dataspace.

Methods inherited from interface com.orchestranetworks.rest.util.URIBuilderForBuiltin

build, extendedAction, firstPage, lastPage, nextPage, pageSize, previousPage, queryParams, queryParams

Method Details

buildForDataset

URI buildForDataset(Adaptation aDataset)

Returns an absolute URI to a specified dataset in its automatically computed dataspace.

Parameters:

aDataset - the dataset

See Also:

• buildForDataset(HomeKey, AdaptationName)

dataset

UriBuilder dataset(Adaptation aDataset)

Returns a configured URI builder which can generate built-in REST services URI to a dataset in its automatically computed dataspace.

Parameters:

aDataset - the dataset

See Also:

• dataset(HomeKey, AdaptationName)

buildForDataset

URI buildForDataset(HomeKey aDataspaceKey,
 AdaptationName aDatasetName)

Returns an absolute URI to a specified dataset in a specified dataspace.

If query parameters must be added to the generated URI, then the URIBuilderForBuiltin.queryParams(Map) or URIBuilderForBuiltin.queryParams(MultivaluedMap) method has to be invoked before this one.

If pagination query parameters must be added to the generated URI, then the URIBuilderForBuiltin.firstPage(), URIBuilderForBuiltin.lastPage(), URIBuilderForBuiltin.nextPage(String), URIBuilderForBuiltin.previousPage(String) or URIBuilderForBuiltin.pageSize(int) method has to be invoked before this one.

If an extended action must be added to the generated URI, then the URIBuilderForBuiltin.extendedAction(String) method has to be invoked before this one.

Parameters:

aDataspaceKey - the dataspace key

aDatasetName - the dataset name

See Also:

• Data operations documentation

dataset

UriBuilder dataset(HomeKey aDataspaceKey,
 AdaptationName aDatasetName)

Returns a configured URI builder which can generate built-in REST services URI to a specified dataset in a specified dataspace.

Since a URI builder is returned, it is still possible to manipulate the preconfigured URI afterward.

To handle query parameters, the methods URIBuilderForBuiltin.queryParams(Map), URIBuilderForBuiltin.queryParams(MultivaluedMap) or UriBuilder.queryParam(String, Object...) should be used.

To handle pagination query parameters, the methods @link #firstPage()}, URIBuilderForBuiltin.lastPage(), URIBuilderForBuiltin.nextPage(String), URIBuilderForBuiltin.previousPage(String), URIBuilderForBuiltin.pageSize(int) or UriBuilder.queryParam(String, Object...) should be used.

To handle extended actions, the methods URIBuilderForBuiltin.extendedAction(String), UriBuilder.replacePath(String), UriBuilder.path(String) or UriBuilder.segment(String...) should be used.

Parameters:

aDataspaceKey - the dataspace key

aDatasetName - the dataset name

See Also:

• Data operations documentation