OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.GroupSession
Implementsosid.OsidSession
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.

MethodgetBinId
Description

Gets the Bin Id associated with this session.

Returnosid.id.Idthe Bin Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBin
Description

Gets the Bin associated with this session.

Returnosid.resource.Binthe Bin associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupResourceMembers
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.

Returnboolean false if looking up members is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeResourceView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryResourceView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedBinView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBinView
Description

Isolates the view for methods in this session. An isolated view restricts resources to this bin only.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedGroupView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedGroupView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to the specified group only.

CompliancemandatoryThis method is must be implemented.
MethodgetResourceIdsByGroup
Description

Gets the list of Resource Ids associated with a Resource. In a federated view, resources for child groups are included.

Parametersosid.id.IdgroupResourceId Id of the Resource
Returnosid.id.IdListlist of member resource Ids
ErrorsNOT_FOUND groupResourceId is not found
NULL_ARGUMENT groupResourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourcesByGroup
Description

Gets the list of Resources associated with a Resource. In a federated view, resources for child groups are included.

Parametersosid.id.IdgroupResourceId Id of the Resource
Returnosid.resource.ResourceListlist of resourcememembers
ErrorsNOT_FOUND groupResourceId is not found
NULL_ARGUMENT groupResourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourceIdsByGroups
Description

Gets the list of Resource Ids corresponding to a list of Resource objects.

Parametersosid.id.IdListgroupResourceIdslist of resource Ids
Returnosid.id.IdListlist of resource Ids
ErrorsNULL_ARGUMENT groupResourceIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourcesByGroups
Description

Gets the list of Resources corresponding to a list of Resource objects.

Parametersosid.id.IdListgroupResourceIdslist of resource Ids
Returnosid.resource.ResourceListlist of resources
ErrorsNULL_ARGUMENT groupResourceIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGroupIdsByResource
Description

Gets the list of Resource Ids mapped to a Resource.

Parametersosid.id.IdresourceId Id of a Resource
Returnosid.id.IdListlist of group resource Ids
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGroupsByResource
Description

Gets the list of Resource objects mapped to a Resource.

Parametersosid.id.IdresourceId Id of a Resource
Returnosid.resource.ResourceListlist of group resources
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.