OSID - osid.authorization.QualifierQuery Service Interface Definition

Interface	osid.authorization.QualifierQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidFederateableQuery`
Used By	`osid.authorization.AuthorizationQuery`
	`osid.authorization.QualifierQuery`
	`osid.authorization.QualifierQuerySession`
	`osid.authorization.QualifierSearchSession`
	`osid.authorization.QualifierSmartVaultSession`
	`osid.authorization.VaultQuery`
Description	This is the query for searching qualifiers. 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	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 qualifiers that have any authorization mapping.
Parameters	`boolean`	`match`	`true` to match qualifiers with any authorization mapping, `false` to match qualifiers 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	matchAncestorQualifierId
Description	Sets the qualifier `Id` for this query to match qualifiers that have the specified qualifier as an ancestor.
Parameters	`osid.id.Id`	`qualifierId`	a qualifier `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`qualifierId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorQualifierIdTerms
Description	Clears the ancestor qualifier `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorQualifierQuery
Description	Tests if a `QualifierQuery` is available.
Return	`boolean`		`true` if a qualifier query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorQualifierQuery
Description	Gets the query for a qualifier. Multiple retrievals produce a nested `OR` term.
Return	`osid.authorization.QualifierQuery`		the qualifier query
Errors	UNIMPLEMENTED		`supportsAncestorQualifierQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorQualifierQuery()` is `true`.
Method	matchAnyAncestorQualifier
Description	Matches qualifiers that have any ancestor.
Parameters	`boolean`	`match`	`true` to match qualifiers with any ancestor, `false` to match root qualifiers
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorQualifierTerms
Description	Clears the ancestor qualifier query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantQualifierId
Description	Sets the qualifier `Id` for this query to match qualifiers that have the specified qualifier as a descendant.
Parameters	`osid.id.Id`	`qualifierId`	a qualifier `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`qualifierId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantQualifierIdTerms
Description	Clears the descendant qualifier `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantQualifierQuery
Description	Tests if a `QualifierQuery` is available.
Return	`boolean`		`true` if a qualifier query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantQualifierQuery
Description	Gets the query for a qualifier. Multiple retrievals produce a nested `OR` term.
Return	`osid.authorization.QualifierQuery`		the qualifier query
Errors	UNIMPLEMENTED		`supportsDescendantQualifierQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantQualifierQuery()` is `true`.
Method	matchAnyDescendantQualifier
Description	Matches qualifiers that have any ancestor.
Parameters	`boolean`	`match`	`true` to match qualifiers with any ancestor, `false` to match leaf qualifiers
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantQualifierTerms
Description	Clears the descendant qualifier 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	getQualifierQueryRecord
Description	Gets the qualifier query record corresponding to the given `Qualifier` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`qualifierRecordType`	a qualifier record type
Return	`osid.authorization.records.QualifierQueryRecord`		the qualifier query record
Errors	NULL_ARGUMENT		`qualifierRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(qualifierRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.