OSID - osid.transport.EndpointQuerySession Service Interface Definition

Interface	osid.transport.EndpointQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.transport.EndpointSearchSession`
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`. Endpoints may have a endpoint query record indicated by their respective record types. The endpoint query record is accessed via the `EndpointQuery`.
Method	canSearchEndpoints
Description	Tests if this user can perform `Endpoint` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointQuery
Description	Gets a endpoint query. The returned query will not have an extension query.
Return	`osid.transport.EndpointQuery`		the endpoint query
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointsByQuery
Description	Gets a list of `Endpoints` matching the given endpoint query.
Parameters	`osid.transport.EndpointQuery`	`endpointQuery`	the endpoint query
Return	`osid.transport.EndpointList`		the returned `EndpointList`
Errors	NULL_ARGUMENT		`endpointQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		a `endpointQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.