OSID - osid.resource.GroupSession Service Interface Definition

Interface	osid.resource.GroupSession
Implements	`osid.OsidSession`
Used By	`osid.resource.ResourceManager`
Used By	`osid.resource.ResourceProxyManager`
Description	This session provides methods to retrieve `Resource` to `Group` mappings. A `Resource` may appear in multiple resource groups. A group is also represented by a resource itself.
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	canLookupResourceMembers
Description	Tests if this user can perform lookups of resource members. 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 members is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeResourceView
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	usePlenaryResourceView
Description	A complete view of the `Resource` 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 resources to this bin only.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedGroupView
Description	Federates the view for methods in this session. A federated view will include resources in groups which are children of the specified group in the group hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedGroupView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to the specified group only.
Compliance	`mandatory`		This method is must be implemented.
Method	getResourceIdsByGroup
Description	Gets the list of `Resource` `Ids` associated with a `Resource`. In a federated view, resources for child groups are included.
Parameters	`osid.id.Id`	`groupResourceId`	`Id` of the `Resource`
Return	`osid.id.IdList`		list of member resource `Ids`
Errors	NOT_FOUND		`groupResourceId` is not found
	NULL_ARGUMENT		`groupResourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourcesByGroup
Description	Gets the list of `Resources` associated with a `Resource`. In a federated view, resources for child groups are included.
Parameters	`osid.id.Id`	`groupResourceId`	`Id` of the `Resource`
Return	`osid.resource.ResourceList`		list of resourcememembers
Errors	NOT_FOUND		`groupResourceId` is not found
	NULL_ARGUMENT		`groupResourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceIdsByGroups
Description	Gets the list of `Resource Ids` corresponding to a list of `Resource` objects.
Parameters	`osid.id.IdList`	`groupResourceIds`	list of resource `Ids`
Return	`osid.id.IdList`		list of resource `Ids`
Errors	NULL_ARGUMENT		`groupResourceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourcesByGroups
Description	Gets the list of `Resources` corresponding to a list of `Resource` objects.
Parameters	`osid.id.IdList`	`groupResourceIds`	list of resource `Ids`
Return	`osid.resource.ResourceList`		list of resources
Errors	NULL_ARGUMENT		`groupResourceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGroupIdsByResource
Description	Gets the list of `Resource` `Ids` mapped to a `Resource`.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
Return	`osid.id.IdList`		list of group resource `Ids`
Errors	NOT_FOUND		`resourceId` is not found
	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGroupsByResource
Description	Gets the list of `Resource` objects mapped to a `Resource`.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
Return	`osid.resource.ResourceList`		list of group resources
Errors	NOT_FOUND		`resourceId` is not found
	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.