OSID - osid.resource.ResourceAgentSession Service Interface Definition

Interface	osid.resource.ResourceAgentSession
Implements	`osid.OsidSession`
Used By	`osid.resource.ResourceManager`
Used By	`osid.resource.ResourceProxyManager`
Description	This session provides methods to retrieve `Resource` to `Agent` mappings. An `Agent` may map to only one `Resource` while a `Resource` may map to multiple `Agents`. This lookup session defines several views comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	getBinId
Description	Gets the `Bin` `Id` associated with this session.
Return	`osid.id.Id`		the `Bin Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBin
Description	Gets the `Bin` associated with this session.
Return	`osid.resource.Bin`		the `Bin` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupResourceAgentMappings
Description	Tests if this user can perform lookups of resource/agent mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeAgentView
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	usePlenaryAgentView
Description	A complete view of the `Agent` 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	useFederatedBinView
Description	Federates the view for methods in this session. A federated view will include resources in bins which are children of this bin in the bin hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBinView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this bin only.
Compliance	`mandatory`		This method is must be implemented.
Method	useImplicitResourceView
Description	Returns the `Agents` directly mapped to the Resource and any Resource implied by the given Resource through grouping or demographic rules.
Compliance	`mandatory`		This method is must be implemented.
Method	useExplciitResourceView
Description	Returns the Agents only directly mapped to the given Resource.
Compliance	`mandatory`		This method is must be implemented.
Method	getResourceIdByAgent
Description	Gets the `Resource` `Id` directly associated with the given agent.
Parameters	`osid.id.Id`	`agentId`	`Id` of the `Agent`
Return	`osid.id.Id`		associated resource
Errors	NOT_FOUND		`agentId` is not found
	NULL_ARGUMENT		`agentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceByAgent
Description	Gets the `Resource` directly associated with the given agent.
Parameters	`osid.id.Id`	`agentId`	`Id` of the `Agent`
Return	`osid.resource.Resource`		associated resource
Errors	NOT_FOUND		`agentId` is not found
	NULL_ARGUMENT		`agentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgentIdsByResource
Description	Gets the list of `Agent` `Ids` associated with a `Resource`. In implicit resource mode, `Agents` are returns for the given `Resource` and any `Resource` implied through grouping or demographic rules. Otherwise, only `Agents` explicitly mapped to the given `Resource` are returned.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
Return	`osid.id.IdList`		list of agent `Ids`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgentsByResource
Description	Gets the list of `Agent` `Ids` associated with a `Resource`. In implicit resource mode, `Agents` are returns for the given `Resource` and any `Resource` implied through grouping or demographic rules. Otherwise, only `Agents` explicitly mapped to the given `Resource` are returned.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
Return	`osid.authentication.AgentList`		list of agents
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgentIdsByResources
Description	Gets the list of `Agent` `Ids` associated with any of the given `Resources`. In implicit resource mode, `Agents` are returns for the given `Resource` and any `Resource` implied through grouping or demographic rules. Otherwise, only `Agents` explicitly mapped to the given `Resource` are returned.
Parameters	`osid.id.IdList`	`resourceIds`	`Ids` of the `Resources`
Return	`osid.id.IdList`		list of agent `Ids`
Errors	NULL_ARGUMENT		`resourceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgentsByResources
Description	Gets the list of `Agents` associated with any of the given `Resources`. In implicit resource mode, `Agents` are returns for the given `Resource` and any `Resource` implied through grouping or demographic rules. Otherwise, only `Agents` explicitly mapped to the given `Resource` are returned.
Parameters	`osid.id.IdList`	`resourceIds`	`Ids` of the `Resources`
Return	`osid.authentication.AgentList`		list of agents
Errors	NULL_ARGUMENT		`resourceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCheckResourceAgentMappings
Description	Tests if this user can perform checks of resource/agent mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 checking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	isAgentForResource
Description	Tests if the given `Agent` is associated with the given `Resource`. In implicit resource mode, the given `Resource` and any `Resource` implied through grouping or demographic rules are checked. Otherwise, only the given `Resource` is checked.
Parameters	`osid.id.Id`	`agentId`	`Id` of an `Agent`
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
Return	`boolean`		`true` of `agentId` is associated with the given `resourceId`, `false` otherwise
Errors	NULL_ARGUMENT		`agentId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAgentForResources
Description	Tests if the given `Agent` is associated with any of the given `Resources`. In implicit resource mode, the given `Resource` and any `Resource` implied through grouping or demographic rules are checked. Otherwise, only the given `Resource` is checked.
Parameters	`osid.id.Id`	`agentId`	`Id` of an `Agent`
Parameters	`osid.id.IdList`	`resourceIds`	`Ids` of the `Resources`
Return	`boolean`		`true` of `agentId` is associated with any of the given `resourceIds`, `false` otherwise
Errors	NULL_ARGUMENT		`agentId` or `resourceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.