OSID - osid.authorization.FunctionQuery Service Interface Definition

Interface	osid.authorization.FunctionQuery
Implements	`osid.OsidRuleQuery`
Description	This is the query for searching functions. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR.`
Method	matchQualifierHierarchyId
Description	Sets the qualifier hierarchy `Id` for this query.
Parameters	`osid.id.Id`	`qualifierHierarchyId`	a hierarchy `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`qualifierHierarchyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearQualifierHierarchyIdTerms
Description	Clears the qualifier hierarchy `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierHierarchyQuery
Description	Tests if a `HierarchyQuery` is available.
Return	`boolean`		`true` if a qualifier hierarchy query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getQualifierHierarchyQuery
Description	Gets the query for a qualifier hierarchy. Multiple retrievals produce a nested `OR` term.
Return	`osid.hierarchy.HierarchyQuery`		the qualifier hierarchy query
Errors	UNIMPLEMENTED		`supportsQualifierHierarchyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsQualifierHierarchyQuery()` is `true.`
Method	matchAnyQualifierHierarchy
Description	Matches functions that have any qualifier hierarchy.
Parameters	`boolean`	`match`	`true` to match functions with any qualifier hierarchy, `false` to match functions with no qualifier hierarchy
Compliance	`mandatory`		This method must be implemented.
Method	clearQualifierHierarchyTerms
Description	Clears the qualifier hierarchy query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAuthorizationId
Description	Sets the authorization `Id` for this query.
Parameters	`osid.id.Id`	`authorizationId`	an 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	clearAuthorizationIdTerms
Description	Clears the authorization `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationQuery
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	getAuthorizationQuery
Description	Gets the query for an authorization. Multiple retrievals produce a nested `OR` term.
Return	`osid.authorization.AuthorizationQuery`		the authorization query
Errors	UNIMPLEMENTED		`supportsAuthorizationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthorizationQuery()` is `true.`
Method	matchAnyAuthorization
Description	Matches functions that have any authorization mapping.
Parameters	`boolean`	`match`	`true` to match functions with any authorization mapping, `false` to match functions with no authorization mapping
Compliance	`mandatory`		This method must be implemented.
Method	clearAuthorizationTerms
Description	Clears the authorization query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchVaultId
Description	Sets the vault `Id` for this query.
Parameters	`osid.id.Id`	`vaultId`	a 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	getFunctionQueryRecord
Description	Gets the function query record corresponding to the given `Function` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`functionRecordType`	a function record type
Return	`osid.authorization.records.FunctionQueryRecord`		the function query record
Errors	NULL_ARGUMENT		`functionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(functionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.