Interface URIBuilderForBuiltin.ForNode<T extends URIBuilderForBuiltin<T>>
- All Superinterfaces:
URIBuilderForBuiltin<T>
- All Known Subinterfaces:
URIBuilderForBuiltin.ForDataAndHistory
- Enclosing interface:
- URIBuilderForBuiltin<T extends URIBuilderForBuiltin<T>>
URI
to a record field
or a dataset node.- 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 TypeMethodDescriptionbuildForNode
(Adaptation aRecordOrDataset, Path aNodePath) Returns an absoluteURI
to a specified record field or a dataset node, in its automatically computed dataspace.buildForNode
(HomeKey aDataspaceKey, AdaptationName aDatasetName, Path aNodePath) Returns an absoluteURI
to a specified dataset node, in a specified dataspace.node
(Adaptation aRecordOrDataset, Path aNodePath) Returns a configuredURI
builder which can generate built-in REST servicesURI
to a specified record field or dataset node, in its automatically computed dataspace.node
(HomeKey aDataspaceKey, AdaptationName aDatasetName, Path aNodePath) Returns a configuredURI
builder which can generate built-in REST servicesURI
to a specified dataset node, in a specified dataspace.Methods inherited from interface com.orchestranetworks.rest.util.URIBuilderForBuiltin
build, extendedAction, firstPage, lastPage, nextPage, pageSize, previousPage, queryParams, queryParams
-
Method Details
-
buildForNode
Returns an absoluteURI
to a specified record field or a dataset node, in its automatically computed dataspace.- Parameters:
aRecordOrDataset
- the record or datasetaNodePath
- the path node- See Also:
-
node
Returns a configuredURI
builder which can generate built-in REST servicesURI
to a specified record field or dataset node, in its automatically computed dataspace.- Parameters:
aRecordOrDataset
- the record or datasetaNodePath
- the path node- See Also:
-
buildForNode
Returns an absoluteURI
to a specified dataset node, in a specified dataspace.If query parameters must be added to the generated
URI
, then theURIBuilderForBuiltin.queryParams(Map)
orURIBuilderForBuiltin.queryParams(MultivaluedMap)
method has to be invoked before this one.If pagination query parameters must be added to the generated
URI
, then theURIBuilderForBuiltin.firstPage()
,URIBuilderForBuiltin.lastPage()
,URIBuilderForBuiltin.nextPage(String)
,URIBuilderForBuiltin.previousPage(String)
orURIBuilderForBuiltin.pageSize(int)
method has to be invoked before this one.If an extended action must be added to the generated
URI
, then theURIBuilderForBuiltin.extendedAction(String)
method has to be invoked before this one.- Parameters:
aDataspaceKey
- the dataspace keyaDatasetName
- the dataset nameaNodePath
- the path node- See Also:
-
node
Returns a configuredURI
builder which can generate built-in REST servicesURI
to a specified dataset node, 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)
orUriBuilder.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)
orUriBuilder.queryParam(String, Object...)
should be used.To handle extended actions, the methods
URIBuilderForBuiltin.extendedAction(String)
,UriBuilder.replacePath(String)
,UriBuilder.path(String)
orUriBuilder.segment(String...)
should be used.- Parameters:
aDataspaceKey
- the dataspace keyaDatasetName
- the dataset nameaNodePath
- the path node- See Also:
-