org.apache.olingo.odata2.api.uri.info
Interface GetEntitySetLinksCountUriInfo

All Known Subinterfaces:

UriInfo

public interface GetEntitySetLinksCountUriInfo

Access to the parts of the request URI that are relevant for GET requests of the number of links to entities.

Method Summary

Map<String,String>	getCustomQueryOptions() Gets the custom query options as Map from option names to their corresponding String values, or an empty list if no custom query options are given in the URI.
EdmEntityContainer	getEntityContainer() Gets the target entity container.
FilterExpression	getFilter() Gets the value of the $filter system query option as root object of the expression tree built during URI parsing.
EdmFunctionImport	getFunctionImport() Gets the function import.
Map<String,EdmLiteral>	getFunctionImportParameters() Gets the parameters of a function import as Map from parameter names to their corresponding typed values, or an empty list if no function import is used or no parameters are given in the URI.
List<KeyPredicate>	getKeyPredicates() Gets the key predicates used to select a single entity out of the start entity set, or an empty list if not used.
List<NavigationSegment>	getNavigationSegments() Gets the navigation segments, or an empty list if no navigation has been used.
Integer	getSkip() Gets the value of the $skip system query option.
EdmEntitySet	getStartEntitySet() Gets the start entity set - identical to the target entity set if no navigation has been used.
EdmEntitySet	getTargetEntitySet() Gets the target entity set after navigation.
EdmType	getTargetType() Gets the target entity type of the request.
Integer	getTop() Gets the value of the $top system query option.
boolean	isCount() Determines whether $count has been used in the request URI.
boolean	isLinks() Determines whether $links has been used in the request URI.

Method Detail

getEntityContainer

EdmEntityContainer getEntityContainer()

Gets the target entity container.

Returns:

EdmEntityContainer the target entity container

getStartEntitySet

EdmEntitySet getStartEntitySet()

Gets the start entity set - identical to the target entity set if no navigation has been used.

Returns:

EdmEntitySet

getTargetEntitySet

EdmEntitySet getTargetEntitySet()

Gets the target entity set after navigation.

Returns:

EdmEntitySet target entity set

getFunctionImport

EdmFunctionImport getFunctionImport()

Gets the function import.

Returns:

EdmFunctionImport the function import

getTargetType

EdmType getTargetType()

Gets the target entity type of the request.

Returns:

EdmType the target type

getKeyPredicates

List<KeyPredicate> getKeyPredicates()

Gets the key predicates used to select a single entity out of the start entity set, or an empty list if not used.

Returns:

List of KeyPredicate

See Also:

getStartEntitySet()

getNavigationSegments

List<NavigationSegment> getNavigationSegments()

Gets the navigation segments, or an empty list if no navigation has been used.

Returns:

List of NavigationSegment

isCount

boolean isCount()

Determines whether $count has been used in the request URI.

Returns:

whether $count has been used

isLinks

boolean isLinks()

Determines whether $links has been used in the request URI.

Returns:

whether $links has been used

getFilter

FilterExpression getFilter()

Gets the value of the $filter system query option as root object of the expression tree built during URI parsing.

Returns:

the filter expression or null

getSkip

Integer getSkip()

Gets the value of the $skip system query option.

Returns:

skip or null

getTop

Integer getTop()

Gets the value of the $top system query option.

Returns:

top or null

getFunctionImportParameters

Map<String,EdmLiteral> getFunctionImportParameters()

Gets the parameters of a function import as Map from parameter names to their corresponding typed values, or an empty list if no function import is used or no parameters are given in the URI.

Returns:

Map of <String, EdmLiteral> function import parameters

getCustomQueryOptions

Map<String,String> getCustomQueryOptions()

Gets the custom query options as Map from option names to their corresponding String values, or an empty list if no custom query options are given in the URI.

Returns:

Map of <String, String> custom query options