public interface URIBuilderForBuiltin
Constants
,
Data services documentation,
Built-in REST services documentationModifier and Type | Method and Description |
---|---|
URI |
build()
Returns an absolute base
URI that includes category and version. |
URI |
buildForDataset(Adaptation aDataset)
Returns an absolute
URI for a specified dataset
with empty query parameters. |
URI |
buildForDataset(Adaptation aDataset,
Map<String,String> parameters)
Returns an absolute
URI to a specified dataset
with the provided query parameters. |
URI |
buildForDataset(HomeKey aDataspaceKey,
AdaptationName aDatasetName)
Returns an absolute
URI to a specified dataset
in a specified dataspace with empty query parameters. |
URI |
buildForDataset(HomeKey aDataspaceKey,
AdaptationName aDatasetName,
Map<String,String> parameters)
Returns an absolute
URI to a specified dataset
in a specified dataspace including the provided query parameters. |
URI |
buildForNode(Adaptation aRecordOrDataset,
Path aNodePath)
Returns an absolute
URI to a specified record field
or dataset node without query parameters. |
URI |
buildForNode(Adaptation aRecordOrDataset,
Path aNodePath,
Map<String,String> parameters)
Returns an absolute
URI to a specified record field
or dataset node with query parameters. |
URI |
buildForNode(HomeKey aDataspaceKey,
AdaptationName aDatasetName,
Path aNodePath)
Returns an absolute
URI to a specified dataset node
without query parameters. |
URI |
buildForNode(HomeKey aDataspaceKey,
AdaptationName aDatasetName,
Path aNodePath,
Map<String,String> parameters)
Returns an absolute
URI to a specified dataset node
with query parameters. |
URI |
buildForRecord(Adaptation aRecord)
Returns an absolute
URI to a specified record
without query parameters. |
URI |
buildForRecord(Adaptation aRecord,
Map<String,String> parameters)
Returns an absolute
URI to a specified record
with query parameters. |
URI |
buildForTableFirstPage(Adaptation aRecord,
SchemaNode aTableOrAssociationNode,
int aPageSize,
Map<String,String> parameters)
Returns an absolute
URI to access the first table page
with query parameters. |
URI |
buildForTableLastPage(Adaptation aRecord,
SchemaNode aTableOrAssociationNode,
int aPageSize,
Map<String,String> parameters)
Returns an absolute
URI to access the last
table page with query parameters. |
URI |
buildForTableNextPage(Adaptation aRecord,
SchemaNode aTableOrAssociationNode,
String aPageRecordFilter,
int aPageSize,
Map<String,String> parameters)
Returns an absolute
URI to access the next
table page with query parameters. |
URI |
buildForTablePreviousPage(Adaptation aRecord,
SchemaNode aTableOrAssociationNode,
String aPageRecordFilter,
int aPageSize,
Map<String,String> parameters)
Returns an absolute
URI to access the previous
table page with query parameters. |
URI build()
URI
that includes category and version.URI buildForDataset(Adaptation aDataset)
URI
for a specified dataset
with empty query parameters.buildForDataset(Adaptation, Map)
URI buildForDataset(Adaptation aDataset, Map<String,String> parameters)
URI
to a specified dataset
with the provided query parameters.aDataset
- the datasetparameters
- the query parametersURI buildForDataset(HomeKey aDataspaceKey, AdaptationName aDatasetName)
URI
to a specified dataset
in a specified dataspace with empty query parameters.URI buildForDataset(HomeKey aDataspaceKey, AdaptationName aDatasetName, Map<String,String> parameters)
URI
to a specified dataset
in a specified dataspace including the provided query parameters.aDataspaceKey
- the dataspace keyaDatasetName
- the dataset nameparameters
- the query parametersURI buildForNode(Adaptation aRecordOrDataset, Path aNodePath)
URI
to a specified record field
or dataset node without query parameters.buildForNode(Adaptation, Path, Map)
URI buildForNode(Adaptation aRecordOrDataset, Path aNodePath, Map<String,String> parameters)
URI
to a specified record field
or dataset node with query parameters.aRecordOrDataset
- the record or datasetaNodePath
- the path nodeparameters
- the query parametersURI buildForNode(HomeKey aDataspaceKey, AdaptationName aDatasetName, Path aNodePath)
URI
to a specified dataset node
without query parameters.URI buildForNode(HomeKey aDataspaceKey, AdaptationName aDatasetName, Path aNodePath, Map<String,String> parameters)
URI
to a specified dataset node
with query parameters.aDataspaceKey
- the dataspace keyaDatasetName
- the dataset nameaNodePath
- the path nodeparameters
- the query parametersURI buildForRecord(Adaptation aRecord)
URI
to a specified record
without query parameters.buildForRecord(Adaptation, Map)
URI buildForRecord(Adaptation aRecord, Map<String,String> parameters)
URI
to a specified record
with query parameters.aRecord
- the recordparameters
- the query parametersURI buildForTableFirstPage(Adaptation aRecord, SchemaNode aTableOrAssociationNode, int aPageSize, Map<String,String> parameters)
URI
to access the first table page
with query parameters.aRecord
- the recordaTableOrAssociationNode
- the table or association nodeaPageSize
- the table page sizeparameters
- the query parametersbuildForTableLastPage(Adaptation, SchemaNode, int, Map)
,
Data operations documentationURI buildForTablePreviousPage(Adaptation aRecord, SchemaNode aTableOrAssociationNode, String aPageRecordFilter, int aPageSize, Map<String,String> parameters)
URI
to access the previous
table page with query parameters.aRecord
- the recordaTableOrAssociationNode
- the table or association nodeaPageRecordFilter
- the page record filteraPageSize
- the table page sizeparameters
- the query parametersbuildForTableNextPage(Adaptation, SchemaNode, String, int, Map)
,
Data operations documentationURI buildForTableNextPage(Adaptation aRecord, SchemaNode aTableOrAssociationNode, String aPageRecordFilter, int aPageSize, Map<String,String> parameters)
URI
to access the next
table page with query parameters.aRecord
- the recordaTableOrAssociationNode
- the table or association nodeaPageRecordFilter
- the page record filteraPageSize
- the table page sizeparameters
- the query parametersbuildForTablePreviousPage(Adaptation, SchemaNode, String, int, Map)
,
Data operations documentationURI buildForTableLastPage(Adaptation aRecord, SchemaNode aTableOrAssociationNode, int aPageSize, Map<String,String> parameters)
URI
to access the last
table page with query parameters.aRecord
- the recordaTableOrAssociationNode
- the table or association nodeaPageSize
- the table page sizeparameters
- the query parametersbuildForTableFirstPage(Adaptation, SchemaNode, int, Map)
,
Data operations documentation