OSID - osid.id.IdLookupSession Service Interface Definition

Interface	osid.id.IdLookupSession
Implements	`osid.OsidSession`
Used By	`osid.id.IdManager`
Used By	`osid.id.IdProxyManager`
Description	This session is for retrieving `Id` objects. `getIds()` retrieves all known `Ids`. The existence of a single identifier can be confirmed through the `getId()` method, or it can be used as a means of `Id` translation.
Method	canLookupIds
Description	Tests if this user can perform `Id` 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.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getId
Description	Gets an `Id`. This method serves to get the primary `Id` if the given `Id` Is an alias. Otherwise, the same `Id` is returned.
Parameters	`osid.id.Id`	`id`	an `Id`
Return	`osid.id.Id`		the `Id`
Errors	NOT_FOUND		`id` is not found
	NULL_ARGUMENT		`id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIdsByIds
Description	Gets a list of `Ids`. This method serves to get the primary `Ids` if different from the given `Ids`. Otherwise, the same `Ids` are returned.
Parameters	`osid.id.IdList`	`ids`	a list of `Ids`
Return	`osid.id.IdList`		a list of `Ids`
Errors	NOT_FOUND		an `id` is not found
	NULL_ARGUMENT		`ids` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIdsByAuthority
Description	Gets `Ids` by the given authority.
Parameters	`string`	`authority`	an authority
Return	`osid.id.IdList`		a list of `Ids`
Errors	NULL_ARGUMENT		`authority` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIdsByAuthorityAndNamespace
Description	Gets `Ids` by the given authority and namespace.
Parameters	`string`	`authority`	an authority
Parameters	`string`	`namespace`	a namespace
Return	`osid.id.IdList`		a list of `Ids`
Errors	NULL_ARGUMENT		`authority` or `namespace` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIds
Description	Gets all `Ids`.
Return	`osid.id.IdList`		the list of all `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isEquivalent
Description	Tests if the two `Ids` are equivalent. Two `Ids` are equivalent if they identify the same object such as one is an alias of the other.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`equivalentId`	an `Id`
Return	`boolean`		`true` if the `Ids` are equivalent, false otherwise
Errors	NULL_ARGUMENT		`null` argument provided
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIdAliases
Description	Gets a list of `Id` aliases of an `Id`.
Parameters	`osid.id.Id`	`id`	an `Id`
Return	`osid.id.IdList`		a list of alias `Ids`
Errors	NULL_ARGUMENT		`id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIdAliasesByAuthority
Description	Gets a list of `Id` aliases in a authority for an `Id`.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`string`	`authority`	an authority
Return	`osid.id.IdList`		a list of alias `Ids`
Errors	NULL_ARGUMENT		`id` or `authority` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIdAliasesByAuthorityAndNamespace
Description	Gets a list of `Id` aliases in a namespace for an `Id`.
Parameters	`osid.id.Id`	`id`	an `Id`
	`string`	`authority`	an authority
	`string`	`namespace`	a namespace
Return	`osid.id.IdList`		a list of alias `Ids`
Errors	NULL_ARGUMENT		`id, authority`, or `namespace` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.