public interface CircleOfTrustSession extends OsidSession
This session examines the relationship between Agents
and Trusts.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupTrustCircles()
Tests if this user can look up trusts for agents.
|
Agency |
getAgency()
Gets the
Agency associated with this session. |
Id |
getAgencyId()
Gets the
Agency Id associated with this
session. |
Trust |
getTrust(Id agentId)
Gets a trust level for the given agent.
|
boolean |
isInCircle(Id agentId)
Tests if the given agent is inside the given circle of trust.
|
void |
useFederatedAgencyView()
Federates the view for methods in this session.
|
void |
useIsolatedAgencyView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAgencyId()
Agency
Id
associated with this
session. Agency Id
associated with this sessionmandatory
- This method must be implemented. Agency getAgency() throws OperationFailedException, PermissionDeniedException
Agency
associated with this session. Agency
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupTrustCircles()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer create operations to users
outside the circle. false
if trust methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedAgencyView()
mandatory
- This method is must be implemented. void useIsolatedAgencyView()
mandatory
- This method is must be implemented. Trust getTrust(Id agentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Agent
may be
in one circle of trust that, in turn, is inside another circle of
trust. To test whether an agent is inside a specific circle, use
IsInCircle().
agentId
- an agent Id
NotFoundException
- agentId
is not foundNullArgumentException
- agentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean isInCircle(Id agentId) throws OperationFailedException, PermissionDeniedException
agentId
- an agent Id
true
if the agent is in the given trust,
false
if agent not found or is outside the circleNullArgumentException
- agentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.