OSID - osid.authentication.process.CircleOfTrustSession Service Interface Definition

Interface	osid.authentication.process.CircleOfTrustSession
Implements	`osid.OsidSession`
Description	This session examines the relationship between `Agents` and `Trusts.` isolated agency view: All agent methods in this session operate, retrieve and pertain to trusts defined explicitly in the current agency. federated agency view: All trust methods in this session operate, retrieve and pertain to all trusts defined in this agency and any other trusts implicitly available in this agency through agency inheritence.
Method	getAgencyId
Description	Gets the `Agency` `Id` associated with this session.
Return	`osid.id.Id`		the `Agency Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAgency
Description	Gets the `Agency` associated with this session.
Return	`osid.authentication.Agency`		the `Agency` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupTrustCircles
Description	Tests if this user can look up trusts for agents. A return of true does not guarantee successful authorization. A return of false indicates that it is known these methods will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to users outside the circle.
Return	`boolean`		`false` if trust methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedAgencyView
Description	Federates the view for methods in this session. A federated view will include trusts in agencies which are children of this agency in the agency hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAgencyView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this agency only.
Compliance	`mandatory`		This method is must be implemented.
Method	getTrust
Description	Gets a trust level for the given agent. An `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().`
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Return	`osid.authentication.process.Trust`		the trust
Errors	NOT_FOUND		`agentId` is not found
	NULL_ARGUMENT		`agentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isInCircle
Description	Tests if the given agent is inside the given circle of trust.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Return	`boolean`		`true` if the agent is in the given trust, `false` if agent not found or is outside the circle
Errors	NULL_ARGUMENT		`agentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.