Interface AgencyQuery

All Superinterfaces:

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

public interface AgencyQuery
extends OsidCatalogQuery

This is the query for searching agencies. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearAgentIdTerms()	Clears the agent Id terms.
void	clearAgentTerms()	Clears the agent terms.
void	clearAncestorAgencyIdTerms()	Clears the ancestor agency Id terms.
void	clearAncestorAgencyTerms()	Clears the ancestor agency terms.
void	clearDescendantAgencyIdTerms()	Clears the descendant agency Id terms.
void	clearDescendantAgencyTerms()	Clears the descendant agency terms.
AgencyQueryRecord	getAgencyQueryRecord(Type agencyRecordType)	Gets the agency query record corresponding to the given Agency record Type .Multiple record retrievals produce a nested OR term.
AgentQuery	getAgentQuery()	Gets the query for an agent.
AgentQuery	getAncestorAgencyQuery()	Gets the query for an agency.
AgentQuery	getDescendantAgencyQuery()	Gets the query for an agency.
void	matchAgentId(Id agentId, boolean match)	Sets the agent Id for this query.
void	matchAncestorAgencyId(Id agencyId, boolean match)	Sets the agency Id for this query to match agencies that have the specified agency as an ancestor.
void	matchAnyAgent(boolean match)	Matches agencies with any agent.
void	matchAnyAncestorAgency(boolean match)	Matches agencies with any ancestor.
void	matchAnyDescendantAgency(boolean match)	Matches agencies with any descendant.
void	matchDescendantAgencyId(Id agencyId, boolean match)	Sets the agency Id for this query to match agencies that have the specified agency as an descendant.
boolean	supportsAgentQuery()	Tests if an AgentQuery is available.
boolean	supportsAncestorAgencyQuery()	Tests if an AgencyQuery is available.
boolean	supportsDescendantAgencyQuery()	Tests if an AgencyQuery 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.

Methods inherited from interface OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

matchAgentId

void matchAgentId(Id agentId,
 boolean match)

Sets the agent Id for this query.

Parameters:

agentId - an agent Id

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

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearAgentIdTerms

void clearAgentIdTerms()

Clears the agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAgentQuery

boolean supportsAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgentQuery

AgentQuery getAgentQuery()

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

Returns:

the agent query

Throws:

UnimplementedException - supportsAgentQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAgentQuery()} is {@code true} .

matchAnyAgent

void matchAnyAgent(boolean match)

Matches agencies with any agent.

Parameters:

match - true to match agencies with any agent. false to match agencies with no agents

Compliance:

mandatory - This method must be implemented.

clearAgentTerms

void clearAgentTerms()

Clears the agent terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorAgencyId

void matchAncestorAgencyId(Id agencyId,
 boolean match)

Sets the agency Id for this query to match agencies that have the specified agency as an ancestor.

Parameters:

agencyId - an agency Id

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

Throws:

NullArgumentException - agencyId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorAgencyIdTerms

void clearAncestorAgencyIdTerms()

Clears the ancestor agency Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorAgencyQuery

boolean supportsAncestorAgencyQuery()

Tests if an AgencyQuery is available.

Returns:

true if an agency query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorAgencyQuery

AgentQuery getAncestorAgencyQuery()

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

Returns:

the agency query

Throws:

UnimplementedException - supportsAncestorAgencyQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAncestorAgencyQuery()} is {@code true} .

matchAnyAncestorAgency

void matchAnyAncestorAgency(boolean match)

Matches agencies with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorAgencyTerms

void clearAncestorAgencyTerms()

Clears the ancestor agency terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantAgencyId

void matchDescendantAgencyId(Id agencyId,
 boolean match)

Sets the agency Id for this query to match agencies that have the specified agency as an descendant.

Parameters:

agencyId - an agency Id

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

Throws:

NullArgumentException - agencyId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantAgencyIdTerms

void clearDescendantAgencyIdTerms()

Clears the descendant agency Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantAgencyQuery

boolean supportsDescendantAgencyQuery()

Tests if an AgencyQuery is available.

Returns:

true if an agency query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantAgencyQuery

AgentQuery getDescendantAgencyQuery()

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

Returns:

the agency query

Throws:

UnimplementedException - supportsDescendantAgencyQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDescendantAgencyQuery()} is {@code true} .

matchAnyDescendantAgency

void matchAnyDescendantAgency(boolean match)

Matches agencies with any descendant.

Parameters:

match - true to match agencies with any descendant, false to match leaf agencies

Compliance:

mandatory - This method must be implemented.

clearDescendantAgencyTerms

void clearDescendantAgencyTerms()

Clears the descendant agency terms.

Compliance:

mandatory - This method must be implemented.

getAgencyQueryRecord

AgencyQueryRecord getAgencyQueryRecord(Type agencyRecordType)
                                throws OperationFailedException

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

Parameters:

agencyRecordType - an agency record type

Returns:

the agency query record

Throws:

NullArgumentException - agencyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(agencyRecordType) is false

Compliance:

mandatory - This method must be implemented.