OSID - osid.transport.EndpointSearchSession Service Interface Definition

Interface	osid.transport.EndpointSearchSession
Implements	`osid.transport.EndpointQuerySession`
Used By	`osid.transport.TransportManager`
Used By	`osid.transport.TransportProxyManager`
Description	This session provides methods for searching among `Endpoint` objects. The search query is constructed using the `EndpointQuery`. `getEndpointsByQuery()` is the basic search method and returns a list of `Endpoint` objects.A more advanced search may be performed with `getEndpointsBySearch()`.It accepts a `EndpointSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getEndpointsBySearch()` returns a `EndpointSearchResults` that can be used to access the resulting `EndpointList` or be used to perform a search within the result set through `EndpointSearch`. Endpoints may have a endpoint query record indicated by their respective record types. The endpoint query record is accessed via the `EndpointQuery`.
Method	getEndpointSearch
Description	Gets a endpoint search.
Return	`osid.transport.EndpointSearch`		the endpoint search
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointSearchOrder
Description	Gets a endpoint search order. The `EndpointSearchOrder` is supplied to a `EndpointSearch` to specify the ordering of results.
Return	`osid.transport.EndpointSearchOrder`		the endpoint search order
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.transport.EndpointQuery`	`endpointQuery`	the endpoint query
Parameters	`osid.transport.EndpointSearch`	`endpointSearch`	the endpoint search
Return	`osid.transport.EndpointSearchResults`		the endpoint search results
Errors	NULL_ARGUMENT		`endpointQuery` or `endpointSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`endpointQuery` or `endpointSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointQueryFromInspector
Description	Gets a endpoint query from an inspector. The inspector is available from a `EndpointSearchResults`.
Parameters	`osid.transport.EndpointQueryInspector`	`endpointQueryInspector`	a endpoint query inspector
Return	`osid.transport.EndpointQuery`		the endpoint query
Errors	NULL_ARGUMENT		`endpointQueryInspector` is `null`
Errors	UNSUPPORTED		`endpointQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.