Package org.apache.olingo.server.api.uri
Interface UriInfo
- All Superinterfaces:
UriInfoAll,UriInfoBatch,UriInfoCrossjoin,UriInfoEntityId,UriInfoMetadata,UriInfoResource,UriInfoService
public interface UriInfo
extends UriInfoService, UriInfoMetadata, UriInfoResource, UriInfoBatch, UriInfoAll, UriInfoCrossjoin, UriInfoEntityId
Object acting as general access to URI information extracted from the request URI.
Depending on the URI info kind different interfaces are used to provide access to that information.
Use method getKind() to obtain URI info kind information and to perform an appropriate cast.
-
Method Summary
Modifier and TypeMethodDescriptionConvenience casting method.Convenience casting method.Convenience casting method.Convenience casting method.Convenience casting method.Convenience casting method.Convenience casting method.Gets a list of all alias definitions which were in the URI (including aliases not used anywhere).getKind()SeeUriInfoKindfor more details which kinds are allowed.Gets a list of all system query options which were in the URI.Methods inherited from interface org.apache.olingo.server.api.uri.UriInfoAll
getCountOption, getCustomQueryOptions, getDeltaTokenOption, getFormatOption, getSearchOption, getSkipOption, getSkipTokenOption, getTopOptionMethods inherited from interface org.apache.olingo.server.api.uri.UriInfoCrossjoin
getCountOption, getDeltaTokenOption, getEntitySetNames, getExpandOption, getFilterOption, getFormatOption, getOrderByOption, getSearchOption, getSelectOption, getSkipOption, getSkipTokenOption, getTopOptionMethods inherited from interface org.apache.olingo.server.api.uri.UriInfoEntityId
getCustomQueryOptions, getEntityTypeCast, getExpandOption, getFormatOption, getIdOption, getSelectOptionMethods inherited from interface org.apache.olingo.server.api.uri.UriInfoMetadata
getFormatOption, getFragmentMethods inherited from interface org.apache.olingo.server.api.uri.UriInfoResource
getApplyOption, getCountOption, getCustomQueryOptions, getDeltaTokenOption, getExpandOption, getFilterOption, getFormatOption, getIdOption, getOrderByOption, getSearchOption, getSelectOption, getSkipOption, getSkipTokenOption, getTopOption, getUriResourceParts, getValueForAlias
-
Method Details
-
getKind
UriInfoKind getKind()SeeUriInfoKindfor more details which kinds are allowed.- Returns:
- the kind of this URI info object.
-
asUriInfoService
UriInfoService asUriInfoService()Convenience casting method.- Returns:
- this as a
UriInfoServiceobject
-
asUriInfoAll
UriInfoAll asUriInfoAll()Convenience casting method.- Returns:
- this as a
UriInfoAllobject
-
asUriInfoBatch
UriInfoBatch asUriInfoBatch()Convenience casting method.- Returns:
- this as a
UriInfoBatchobject
-
asUriInfoCrossjoin
UriInfoCrossjoin asUriInfoCrossjoin()Convenience casting method.- Returns:
- this as a
UriInfoCrossjoinobject
-
asUriInfoEntityId
UriInfoEntityId asUriInfoEntityId()Convenience casting method.- Returns:
- this as a
UriInfoEntityIdobject
-
asUriInfoMetadata
UriInfoMetadata asUriInfoMetadata()Convenience casting method.- Returns:
- this as a
UriInfoMetadataobject
-
asUriInfoResource
UriInfoResource asUriInfoResource()Convenience casting method.- Returns:
- this as a
UriInfoResourceobject
-
getSystemQueryOptions
List<SystemQueryOption> getSystemQueryOptions()Gets a list of all system query options which were in the URI.- Returns:
- a list of all system query options used
-
getAliases
List<AliasQueryOption> getAliases()Gets a list of all alias definitions which were in the URI (including aliases not used anywhere).- Returns:
- a list of all alias definitions
-