OSID - osid.authorization.Authorization Service Interface Definition

Interface	osid.authorization.Authorization
Implements	`osid.OsidRelationship`
Used By	`osid.authorization.AuthorizationAdminSession`
	`osid.authorization.AuthorizationList`
	`osid.authorization.AuthorizationLookupSession`
Description	An Authorization is a mapping among an actor, a `Function` and a `Qualifier`. This interface is not required for performing authorization checks but is used for examining and managing authorizations. The actor of an authorization may be specified in a variety of forms. `Agent` `Resource`: all the `Agents` associated with a `Resource` for matching authorizations `Resource` and `Trust`: all the `Agents` within a cicle of `Trust` are used An explicit `Authorization` represents the mappings as they are directly managed in the `AuthorizationAdminSession`. Implicit authorizations may be retrieved which are authorizations inferred through the `Function` or `Qualifier` hierarchies. An implicit `Authorization` is one where `isImplicit()` is true and should not be used for modification as it is only available for auditing purposes. An `Authorization` containing a `Resource` may also provide the associated Agent in a request for implicit authorizations or for all the authorizations, both explicit and implicit, for a given `Agent`.
Method	isImplicit
Description	Tests if this authorization is implicit.
Return	`boolean`		`true` if this authorization is implicit, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	hasResource
Description	Tests if this authorization has a `Resource`.
Return	`boolean`		`true` if this authorization has a `Resource`, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceId
Description	Gets the `resource Id` for this authorization.
Return	`osid.id.Id`		the `Resource Id`
Errors	ILLEGAL_STATE		`hasResource()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getResource
Description	Gets the `Resource` for this authorization.
Return	`osid.resource.Resource`		the `Resource`
Errors	ILLEGAL_STATE		`hasResource()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasTrust
Description	Tests if this authorization has a `Trust`.
Return	`boolean`		`true` if this authorization has a `Trust`, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTrustId
Description	Gets the `Trust` `Id` for this authorization.
Return	`osid.id.Id`		the trust `Id`
Errors	ILLEGAL_STATE		`hasTrust()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getTrust
Description	Gets the `Trust` for this authorization.
Return	`osid.authentication.process.Trust`		the `Trust`
Errors	ILLEGAL_STATE		`hasTrust()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasAgent
Description	Tests if this authorization has an `Agent` .An implied authorization may have an `Agent` in addition to a specified `Resource`.
Return	`boolean`		`true` if this authorization has an `Agent`, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentId
Description	Gets the `Agent Id` for this authorization.
Return	`osid.id.Id`		the `Agent Id`
Errors	ILLEGAL_STATE		`hasAgent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAgent
Description	Gets the `Agent` for this authorization.
Return	`osid.authentication.Agent`		the `Agent`
Errors	ILLEGAL_STATE		`hasAgent()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionId
Description	Gets the `Function Id` for this authorization.
Return	`osid.id.Id`		the function `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getFunction
Description	Gets the `Function` for this authorization.
Return	`osid.authorization.Function`		the function
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getQualifierId
Description	Gets the `Qualifier Id` for this authorization.
Return	`osid.id.Id`		the qualifier `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getQualifier
Description	Gets the qualifier for this authorization.
Return	`osid.authorization.Qualifier`		the qualifier
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationRecord
Description	Gets the authorization record corresponding to the given `Authorization` record `Type`. This method is used to retrieve an object implementing the requested record. The `authorizationRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(authorizationRecordType)` is `true`.
Parameters	`osid.type.Type`	`authorizationRecordType`	the type of the record to retrieve
Return	`osid.authorization.records.AuthorizationRecord`		the authorization record
Errors	NULL_ARGUMENT		`authorizationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(authorizationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.