OSID - osid.authorization.rules.AuthorizationEnablerQuery Service Interface Definition

Interface	osid.authorization.rules.AuthorizationEnablerQuery
Implements	`osid.OsidEffectuatorQuery`
Used By	`osid.authorization.rules.AuthorizationEnablerQuerySession`
	`osid.authorization.rules.AuthorizationEnablerSearchSession`
	`osid.authorization.rules.AuthorizationEnablerSmartVaultSession`
Description	This is the query for searching authorization enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledAuthorizationId
Description	Matches enablers mapped to an authorization.
Parameters	`osid.id.Id`	`authorizationId`	the authorization `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`authorizationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledAuthorizationIdTerms
Description	Clears the authorization `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledAuthorizationQuery
Description	Tests if an `AuthorizationQuery` is available.
Return	`boolean`		`true` if an authorization query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledAuthorizationQuery
Description	Gets the query for an authorization. Multiple retrievals produce a nested `OR` term.
Return	`osid.authorization.AuthorizationQuery`		the authorization query
Errors	UNIMPLEMENTED		`supportsRuledAuthorizationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledAuthorizationQuery()` is `true`.
Method	matchAnyRuledAuthorization
Description	Matches enablers mapped to any authorization.
Parameters	`boolean`	`match`	`true` for enablers mapped to any authorization, `false` to match enablers mapped to no authorizations
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledAuthorizationTerms
Description	Clears the authorization query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchVaultId
Description	Matches enablers mapped to the vault.
Parameters	`osid.id.Id`	`vaultId`	the vault `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`vaultId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearVaultIdTerms
Description	Clears the vault `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsVaultQuery
Description	Tests if a `VaultQuery` is available.
Return	`boolean`		`true` if a vault query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getVaultQuery
Description	Gets the query for a vault. Multiple retrievals produce a nested `OR` term.
Return	`osid.authorization.VaultQuery`		the vault query
Errors	UNIMPLEMENTED		`supportsVaultQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVaultQuery()` is `true`.
Method	clearVaultTerms
Description	Clears the vault query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablerQueryRecord
Description	Gets the authorization enabler query record corresponding to the given `AuthorizationEnabler` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`authorizationEnablerRecordType`	an authorization enabler record type
Return	`osid.authorization.rules.records.AuthorizationEnablerQueryRecord`		the authorization enabler query record
Errors	NULL_ARGUMENT		`authorizationEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(authorizationEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.