Interface | osid.resource.MembershipSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to query if a | ||
Method | getBinId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Bin Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBin | ||
Description |
Gets the | ||
Return | osid.resource.Bin | the Bin associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canQueryMembership | ||
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
| ||
Return | boolean | false if membership queries are not authorized, true
otherwise | |
Compliance | mandatory | This method 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 | isMember | ||
Description |
Tests if a | ||
Parameters | osid.id.Id | memberResourceId | Id of the Resource member |
osid.id.Id | resourceId | Id of the Resource representing the group or
demographic | |
Return | boolean | true if memberResourceId is a member of the
resourceId, false otherwise | |
Errors | NULL_ARGUMENT | memberResourceId or resourceId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |