org.osid.authentication

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

Methods

Modifier and Type	Method and 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.
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 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

Methods inherited from interface org.osid.OsidSourceableQuery

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

Method Detail

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 supportsAgentQuery() is 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 supportsAncestorAgencyQuery() is 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 supportsDescendantAgencyQuery() is 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.