public interface MembershipSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canQueryMembership()
Tests if this user can perform membership queries.
|
Bin |
getBin()
Gets the
Bin associated with this session. |
Id |
getBinId()
Gets the
Bin Id associated with this
session. |
boolean |
isMember(Id memberResourceId,
Id resourceId)
Tests if a
Resource is a member of another
Resource. |
void |
useFederatedBinView()
Federates the view for methods in this session.
|
void |
useIsolatedBinView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBinId()
Bin
Id
associated with this
session. Bin Id
associated with this sessionmandatory
- This method must be implemented. Bin getBin() throws OperationFailedException, PermissionDeniedException
Bin
associated with this session. Bin
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canQueryMembership()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if membership queries are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedBinView()
mandatory
- This method is must be implemented. void useIsolatedBinView()
mandatory
- This method is must be implemented. boolean isMember(Id memberResourceId, Id resourceId) throws OperationFailedException, PermissionDeniedException
Resource
is a member of another
Resource.
memberResourceId
- Id
of the Resource
memberresourceId
- Id
of the Resource
representing the group or demographic memberResourceId
is a member of the
resourceId,
false otherwiseNullArgumentException
- memberResourceId
or resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.