org.osid.authorization

Interface QualifierQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface QualifierQuery
extends OsidObjectQuery, OsidFederateableQuery

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 Summary

Methods

Modifier and Type	Method and Description
void	clearAncestorQualifierIdTerms() Clears the ancestor qualifier Id query terms.
void	clearAncestorQualifierTerms() Clears the ancestor qualifier query terms.
void	clearAuthorizationIdTerms() Clears the authorization Id query terms.
void	clearAuthorizationTerms() Clears the authorization query terms.
void	clearDescendantQualifierIdTerms() Clears the descendant qualifier Id query terms.
void	clearDescendantQualifierTerms() Clears the descendant qualifier query terms.
void	clearQualifierHierarchyIdTerms() Clears the qualifier hierarchy Id query terms.
void	clearQualifierHierarchyTerms() Clears the qualifier hierarchy query terms.
void	clearVaultIdTerms() Clears the vault Id query terms.
void	clearVaultTerms() Clears the vault query terms.
QualifierQuery	getAncestorQualifierQuery() Gets the query for a qualifier.
AuthorizationQuery	getAuthorizationQuery() Gets the query for an authorization.
QualifierQuery	getDescendantQualifierQuery() Gets the query for a qualifier.
HierarchyQuery	getQualifierHierarchyQuery() Gets the query for a qualifier hierarchy.
QualifierQueryRecord	getQualifierQueryRecord(Type qualifierRecordType) Gets the qualfiier query record corresponding to the given Qualifier record Type.
VaultQuery	getVaultQuery() Gets the query for a vault.
void	matchAncestorQualifierId(Id qualifierId, boolean match) Sets the qualifier Id for this query to match qualifiers that have the specified qualifier as an ancestor.
void	matchAnyAncestorQualifier(boolean match) Matches qualifiers that have any ancestor.
void	matchAnyAuthorization(boolean match) Matches qualifiers that have any authorization mapping.
void	matchAnyDescendantQualifier(boolean match) Matches qualifiers that have any ancestor.
void	matchAuthorizationId(Id authorizationId, boolean match) Sets the authorization Id for this query.
void	matchDescendantQualifierId(Id qualifierId, boolean match) Sets the qualifier Id for this query to match qualifiers that have the specified qualifier as a descendant.
void	matchQualifierHierarchyId(Id qualifierHierarchyId, boolean match) Sets the qualifier hierarchy Id for this query.
void	matchVaultId(Id vaultId, boolean match) Sets the vault Id for this query.
boolean	supportsAncestorQualifierQuery() Tests if a QualifierQuery is available.
boolean	supportsAuthorizationQuery() Tests if an AuthorizationQuery is available.
boolean	supportsDescendantQualifierQuery() Tests if a QualifierQuery is available.
boolean	supportsQualifierHierarchyQuery() Tests if a HierarchyQuery is available.
boolean	supportsVaultQuery() Tests if a VaultQuery is available.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchQualifierHierarchyId

void matchQualifierHierarchyId(Id qualifierHierarchyId,
                             boolean match)

Sets the qualifier hierarchy Id for this query.

Parameters:

qualifierHierarchyId - a hierarchy Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - qualifierHierarchyId is null

Compliance:

mandatory - This method must be implemented.

clearQualifierHierarchyIdTerms

void clearQualifierHierarchyIdTerms()

Clears the qualifier hierarchy Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsQualifierHierarchyQuery

boolean supportsQualifierHierarchyQuery()

Tests if a HierarchyQuery is available.

Returns:

true if a qualifier hierarchy query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getQualifierHierarchyQuery

HierarchyQuery getQualifierHierarchyQuery()

Gets the query for a qualifier hierarchy. Multiple retrievals produce a nested OR term.

Returns:

the qualifier hierarchy query

Throws:

UnimplementedException - supportsQualifierHierarchyQuery() is false

Compliance:

optional - This method must be implemented if supportsQualifierHierarchyQuery() is true.

clearQualifierHierarchyTerms

void clearQualifierHierarchyTerms()

Clears the qualifier hierarchy query terms.

Compliance:

mandatory - This method must be implemented.

matchAuthorizationId

void matchAuthorizationId(Id authorizationId,
                        boolean match)

Sets the authorization Id for this query.

Parameters:

authorizationId - an authorization Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - authorizationId is null

Compliance:

mandatory - This method must be implemented.

clearAuthorizationIdTerms

void clearAuthorizationIdTerms()

Clears the authorization Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAuthorizationQuery

boolean supportsAuthorizationQuery()

Tests if an AuthorizationQuery is available.

Returns:

true if an authorization query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAuthorizationQuery

AuthorizationQuery getAuthorizationQuery()

Gets the query for an authorization. Multiple retrievals produce a nested OR term.

Returns:

the authorization query

Throws:

UnimplementedException - supportsAuthorizationQuery() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationQuery() is true.

matchAnyAuthorization

void matchAnyAuthorization(boolean match)

Matches qualifiers that have any authorization mapping.

Parameters:

match - true to match qualifiers with any authorization mapping, false to match qualifiers with no authorization mapping

Compliance:

mandatory - This method must be implemented.

clearAuthorizationTerms

void clearAuthorizationTerms()

Clears the authorization query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorQualifierId

void matchAncestorQualifierId(Id qualifierId,
                            boolean match)

Sets the qualifier Id for this query to match qualifiers that have the specified qualifier as an ancestor.

Parameters:

qualifierId - a qualifier Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - qualifierId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorQualifierIdTerms

void clearAncestorQualifierIdTerms()

Clears the ancestor qualifier Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorQualifierQuery

boolean supportsAncestorQualifierQuery()

Tests if a QualifierQuery is available.

Returns:

true if a qualifier query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorQualifierQuery

QualifierQuery getAncestorQualifierQuery()

Gets the query for a qualifier. Multiple retrievals produce a nested OR term.

Returns:

the qualifier query

Throws:

UnimplementedException - supportsAncestorQualifierQuery() is false

Compliance:

optional - This method must be implemented if supportsAncestorQualifierQuery() is true.

matchAnyAncestorQualifier

void matchAnyAncestorQualifier(boolean match)

Matches qualifiers that have any ancestor.

Parameters:

match - true to match qualifiers with any ancestor, false to match root qualifiers

Compliance:

mandatory - This method must be implemented.

clearAncestorQualifierTerms

void clearAncestorQualifierTerms()

Clears the ancestor qualifier query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantQualifierId

void matchDescendantQualifierId(Id qualifierId,
                              boolean match)

Sets the qualifier Id for this query to match qualifiers that have the specified qualifier as a descendant.

Parameters:

qualifierId - a qualifier Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - qualifierId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantQualifierIdTerms

void clearDescendantQualifierIdTerms()

Clears the descendant qualifier Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantQualifierQuery

boolean supportsDescendantQualifierQuery()

Tests if a QualifierQuery is available.

Returns:

true if a qualifier query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantQualifierQuery

QualifierQuery getDescendantQualifierQuery()

Gets the query for a qualifier. Multiple retrievals produce a nested OR term.

Returns:

the qualifier query

Throws:

UnimplementedException - supportsDescendantQualifierQuery() is false

Compliance:

optional - This method must be implemented if supportsDescendantQualifierQuery() is true.

matchAnyDescendantQualifier

void matchAnyDescendantQualifier(boolean match)

Matches qualifiers that have any ancestor.

Parameters:

match - true to match qualifiers with any ancestor, false to match leaf qualifiers

Compliance:

mandatory - This method must be implemented.

clearDescendantQualifierTerms

void clearDescendantQualifierTerms()

Clears the descendant qualifier query terms.

Compliance:

mandatory - This method must be implemented.

matchVaultId

void matchVaultId(Id vaultId,
                boolean match)

Sets the vault Id for this query.

Parameters:

vaultId - a vault Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - vaultId is null

Compliance:

mandatory - This method must be implemented.

clearVaultIdTerms

void clearVaultIdTerms()

Clears the vault Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsVaultQuery

boolean supportsVaultQuery()

Tests if a VaultQuery is available.

Returns:

true if a vault query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getVaultQuery

VaultQuery getVaultQuery()

Gets the query for a vault. Multiple retrievals produce a nested OR term.

Returns:

the vault query

Throws:

UnimplementedException - supportsVaultQuery() is false

Compliance:

optional - This method must be implemented if supportsVaultQuery() is true.

clearVaultTerms

void clearVaultTerms()

Clears the vault query terms.

Compliance:

mandatory - This method must be implemented.

getQualifierQueryRecord

QualifierQueryRecord getQualifierQueryRecord(Type qualifierRecordType)
                                             throws OperationFailedException

Gets the qualfiier query record corresponding to the given Qualifier record Type. Multiple retrievals produce a nested OR term.

Parameters:

qualifierRecordType - a qualifier record type

Returns:

the qualifier query record

Throws:

NullArgumentException - qualifierRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(qualifierRecordType) is false

Compliance:

mandatory - This method must be implemented.