OSID - osid.transport.EndpointLookupSession Service Interface Definition

Interface	osid.transport.EndpointLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Endpoint` objects. The `Endpoint represents` transport destination. This session defines two views which offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete and ordered result set or is an error condition Generally, the comparative view should be used for most applications as it permits operation even if there is data out of sync.
Method	canLookupEndpoints
Description	Tests if this user can perform `Endpoint` lookups. 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeEndpointView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryEndpointView
Description	A complete view of the `Endpoint` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getEndpoint
Description	Gets the `Endpoint` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Endpoint` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Endpoint` and retained for compatibility.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of the `Endpoint` to retrieve
Return	`osid.transport.Endpoint`		the `Endpoint`
Errors	NOT_FOUND		no `Endpoint` found with the given `Id`
	NULL_ARGUMENT		`Id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointsByIds
Description	Gets an `EndpointList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the endpoints specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Endpoint` elements may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`endpointIds`	the list of `Ids` to retrieve
Return	`osid.transport.EndpointList`		the returned `Endpoint` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`endpointIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointsByGenusType
Description	Gets an `EndpointList` corresponding to the given endpoint genus `Type` which does not include endpoints of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known endpoints or an error results. Otherwise, the returned list may contain only those endpoints that are accessible through this session.
Parameters	`osid.type.Type`	`endpointGenusType`	an endpoint genus type
Return	`osid.transport.EndpointList`		the returned `Endpoint` list
Errors	NULL_ARGUMENT		`endpointGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointsByParentGenusType
Description	Gets an `EndpointList` corresponding to the given endpoint genus `Type` and include any additional endpoints with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known endpoints or an error results. Otherwise, the returned list may contain only those endpoints that are accessible through this session.
Parameters	`osid.type.Type`	`endpointsGenusType`	an endpoint genus type
Return	`osid.transport.EndpointList`		the returned `Endpoint` list
Errors	NULL_ARGUMENT		`endpointGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointsByRecordType
Description	Gets an `EndpointList` containing the given endpoint record `Type.` In plenary mode, the returned list contains all known endpoints or an error results. Otherwise, the returned list may contain only those endpoints that are accessible through this session.
Parameters	`osid.type.Type`	`endpointsRecordType`	an endpoint record type
Return	`osid.transport.EndpointList`		the returned `Endpoint` list
Errors	NULL_ARGUMENT		`endpointRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointsByProvider
Description	Gets an `EndpointList` containing the given endpoint record `Type.` In plenary mode, the returned list contains all known endpoints or an error results. Otherwise, the returned list may contain only those endpoints that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.transport.EndpointList`		the returned `Endpoint` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEndpoints
Description	Gets all `Endpoint` elements. In plenary mode, the returned list contains all known endpoints or an error results. Otherwise, the returned list may contain only those endpoints that are accessible through this session.
Return	`osid.transport.EndpointList`		a list of endpoints
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.