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

Modifier and Type

Method

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 qualifier 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 Extensible
getRecordTypes, hasRecordType

Modifier and Type

Method

Description

TypeList

getRecordTypes()

Gets the record types available in this object.

boolean

hasRecordType(Type recordType)

Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery
clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type

Method

Description

void

clearRecordTerms()

Clears all record Type terms.

void

matchAnyRecord(boolean match)

Matches an object that has any record.

void

matchRecordType(Type recordType, boolean match)

Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery
clearIdTerms, matchId

Modifier and Type

Method

Description

void

clearIdTerms()

Clears all Id terms.

void

matchId(Id id, boolean match)

Adds an Id to match.

Methods inherited from interface 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

Modifier and Type

Method

Description

void

clearCommentIdTerms()

Clears all comment Id terms.

void

clearCommentTerms()

Clears all comment terms.

void

clearCreditIdTerms()

Clears all credit Id terms.

void

clearCreditTerms()

Clears all credit terms.

void

clearDescriptionTerms()

Clears all description terms.

void

clearDisplayNameTerms()

Clears all display name terms.

void

clearGenusTypeTerms()

Clears all genus type terms.

void

clearJournalEntryIdTerms()

Clears all journal entry Id terms.

void

clearJournalEntryTerms()

Clears all journal entry terms.

void

clearParentGenusTypeTerms()

Clears all genus type terms.

void

clearRelationshipIdTerms()

Clears all relationship Id terms.

void

clearRelationshipPeerIdTerms()

Clears all relationship Id terms.

void

clearRelationshipTerms()

Clears all relationship terms.

void

clearStateIdTerms()

Clears all state Id terms.

void

clearStateTerms()

Clears all state terms.

void

clearStatisticTerms()

Clears all statistic terms.

void

clearSubjectIdTerms()

Clears all subject Id terms.

void

clearSubjectRelevancyTerms()

Clears all subject relevancy terms.

void

clearSubjectTerms()

Clears all subject terms.

CommentQuery

getCommentQuery()

Gets the query for a comment.

CreditQuery

getCreditQuery()

Gets the query for an ackowledgement credit.

JournalEntryQuery

getJournalEntryQuery()

Gets the query for a journal entry.

RelationshipQuery

getRelationshipQuery()

Gets the query for relationship.

StateQuery

getStateQuery()

Gets the query for a state.

StatisticQuery

getStatisticQuery()

Gets the query for a statistic.

SubjectQuery

getSubjectQuery()

Gets the query for a subject.

RelevancyQuery

getSubjectRelevancyQuery()

Gets the query for a subject relevancy.

void

matchAnyComment(boolean match)

Matches an object that has any Comment in the given Book .

void

matchAnyCredit(boolean match)

Matches an object that has any Credit .

void

matchAnyDescription(boolean match)

Matches a description that has any value.

void

matchAnyDisplayName(boolean match)

Matches any object with a display name.

void

matchAnyGenusType(boolean match)

Matches an object that has any genus type.

void

matchAnyJournalEntry(boolean match)

Matches an object that has any JournalEntry in the given Journal .

void

matchAnyRelationship(boolean match)

Matches an object that has any Relationship .

void

matchAnyState(boolean match)

Matches an object that has any mapping to a State in the given Process .

void

matchAnyStatistic(boolean match)

Matches an object that has any Statistic .

void

matchAnySubject(boolean match)

Matches an object that has any relationship to a Subject .

void

matchCommentId(Id commentId, boolean match)

Matches an object that has the given comment.

void

matchCreditId(Id creditId, boolean match)

Matches an object that has the given credit.

void

matchDescription(String description, Type stringMatchType, boolean match)

Adds a description name to match.

void

matchDisplayName(String displayName, Type stringMatchType, boolean match)

Adds a display name to match.

void

matchGenusType(Type genusType, boolean match)

Sets a Type for querying objects of a given genus.

void

matchJournalEntryId(Id journalEntryId, boolean match)

Matches an object that has the given journal entry.

void

matchParentGenusType(Type genusType, boolean match)

Sets a Type for querying objects of a given genus.

void

matchRelationshipId(Id relationshipId, boolean match)

Matches an object that has the given relationship.

void

matchRelationshipPeerId(Id peerId, boolean match)

Matches an object that has a relationship to the given peer Id .

void

matchStateId(Id stateId, boolean match)

Matches an object mapped to the given state.

void

matchSubjectId(Id subjectId, boolean match)

Matches an object with a relationship to the given subject.

boolean

supportsCommentQuery()

Tests if a CommentQuery is available.

boolean

supportsCreditQuery()

Tests if a CreditQuery is available to provide queries of related acknowledgements.

boolean

supportsJournalEntryQuery()

Tests if a JournalEntry is available to provide queries of journaled OsidObjects .

boolean

supportsRelationshipQuery()

Tests if a RelationshipQuery is available.

boolean

supportsStateQuery()

Tests if a StateQuery is available to provide queries of processed objects.

boolean

supportsStatisticQuery()

Tests if a StatisticQuery is available to provide statistical queries.

boolean

supportsSubjectQuery()

Tests if a SubjectQuery is available.

boolean

supportsSubjectRelevancyQuery()

Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type

Method

Description

void

clearAnyTerms()

Clears the match any terms.

void

clearKeywordTerms()

Clears all keyword terms.

TypeList

getStringMatchTypes()

Gets the string matching types supported.

void

matchAny(boolean match)

Matches any object.

void

matchKeyword(String keyword, Type stringMatchType, boolean match)

Adds a keyword to match.

boolean

supportsStringMatchType(Type stringMatchType)

Tests if the given string matching type is supported.

Method Details
- 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 {@code supportsQualifierHierarchyQuery()} is {@code 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 {@code supportsAuthorizationQuery()} is {@code 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 {@code supportsAncestorQualifierQuery()} is {@code 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 {@code supportsDescendantQualifierQuery()} is {@code 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 {@code supportsVaultQuery()} is {@code 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 qualifier 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.

Interface QualifierQuery

Method Summary

Methods inherited from interface Extensible

Methods inherited from interface OsidExtensibleQuery

Methods inherited from interface OsidIdentifiableQuery

Methods inherited from interface OsidObjectQuery

Methods inherited from interface OsidQuery

Method Details

matchQualifierHierarchyId

clearQualifierHierarchyIdTerms

supportsQualifierHierarchyQuery

getQualifierHierarchyQuery

clearQualifierHierarchyTerms

matchAuthorizationId

clearAuthorizationIdTerms

supportsAuthorizationQuery

getAuthorizationQuery

matchAnyAuthorization

clearAuthorizationTerms

matchAncestorQualifierId

clearAncestorQualifierIdTerms

supportsAncestorQualifierQuery

getAncestorQualifierQuery

matchAnyAncestorQualifier

clearAncestorQualifierTerms

matchDescendantQualifierId

clearDescendantQualifierIdTerms

supportsDescendantQualifierQuery

getDescendantQualifierQuery

matchAnyDescendantQualifier

clearDescendantQualifierTerms

matchVaultId

clearVaultIdTerms

supportsVaultQuery

getVaultQuery

clearVaultTerms

getQualifierQueryRecord