OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.MembershipSession
Implementsosid.OsidSession
Description

This session provides methods to query if a Resource is a member of another Resource. Resources may represent groups of Resources or generated Demographics of Resources.

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.
MethodcanQueryMembership
Description

Tests if this user can perform membership queries. 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 membership queries are not authorized, true otherwise
CompliancemandatoryThis method 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.
MethodisMember
Description

Tests if a Resource is a member of another Resource.

Parametersosid.id.IdmemberResourceId Id of the Resource member
osid.id.IdresourceId Id of the Resource representing the group or demographic
Returnbooleantrue if memberResourceId is a member of the resourceId, false otherwise
ErrorsNULL_ARGUMENT memberResourceId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.