Interface OrganizationQuery

All Superinterfaces:

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

public interface OrganizationQuery
extends OsidObjectQuery, OsidFederateableQuery, OsidTemporalQuery

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

Like all OsidQueries, OrganizationQuery is stateful and must not be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
void	clearAncestorOrganizationIdTerms()	Clears the ancestor organization Id query terms.
void	clearAncestorOrganizationTerms()	Clears the ancestor organization query terms.
void	clearDescendantOrganizationIdTerms()	Clears the descendant organization Id query terms.
void	clearDescendantOrganizationTerms()	Clears the descendant organization query terms.
void	clearDisplayLabelTerms()	Clears all display label terms.
void	clearRealmIdTerms()	Clears all realm Id terms.
void	clearRealmTerms()	Clears all realm terms.
OrganizationQuery	getAncestorOrganizationQuery()	Gets the query for an organization.
OrganizationQuery	getDescendantOrganizationQuery()	Gets the query for an organization.
OrganizationQueryRecord	getOrganizationQueryRecord(Type organizationRecordType)	Gets the organization query record corresponding to the given Organization record Type.
RealmQuery	getRealmQuery()	Gets the query for a realm query.
void	matchAncestorOrganizationId(Id organizationId, boolean match)	Sets the organization Id for this query to match organizations that have the specified organization as an ancestor.
void	matchAnyAncestorOrganization(boolean match)	Matches agencies with any organization ancestor.
void	matchAnyDescendantOrganization(boolean match)	Matches organizations with any organization descendant.
void	matchAnyDisplayLabel(boolean match)	Matches organizations with any display label.
void	matchDescendantOrganizationId(Id organizationId, boolean match)	Sets the organization Id for this query to match organizations that have the specified organization as a descendant.
void	matchDisplayLabel(String label, Type stringMatchType, boolean match)	Matches a display label.
void	matchRealmId(Id realmId, boolean match)	Sets the realm Id for this query to match organizations assigned to realms.
boolean	supportsAncestorOrganizationQuery()	Tests if an OrganizationQuery is available.
boolean	supportsDescendantOrganizationQuery()	Tests if an OrganizationQuery is available.
boolean	supportsRealmQuery()	Tests if a RealmQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

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

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Details

matchDisplayLabel

void matchDisplayLabel(String label,
 Type stringMatchType,
 boolean match)

Matches a display label.

Parameters:

label - a display label

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - label is not of stringMatchType

NullArgumentException - label or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyDisplayLabel

void matchAnyDisplayLabel(boolean match)

Matches organizations with any display label.

Parameters:

match - true to match organizations with any display label, false to match organizations with no display label

Compliance:

mandatory - This method must be implemented.

clearDisplayLabelTerms

void clearDisplayLabelTerms()

Clears all display label terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorOrganizationId

void matchAncestorOrganizationId(Id organizationId,
 boolean match)

Sets the organization Id for this query to match organizations that have the specified organization as an ancestor.

Parameters:

organizationId - an organization Id

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

Throws:

NullArgumentException - organizationId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorOrganizationIdTerms

void clearAncestorOrganizationIdTerms()

Clears the ancestor organization Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorOrganizationQuery

boolean supportsAncestorOrganizationQuery()

Tests if an OrganizationQuery is available.

Returns:

true if an organization query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorOrganizationQuery

OrganizationQuery getAncestorOrganizationQuery()

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

Returns:

the organization query

Throws:

UnimplementedException - supportsAncestorOrganizationQuery() is false

Compliance:

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

matchAnyAncestorOrganization

void matchAnyAncestorOrganization(boolean match)

Matches agencies with any organization ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorOrganizationTerms

void clearAncestorOrganizationTerms()

Clears the ancestor organization query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantOrganizationId

void matchDescendantOrganizationId(Id organizationId,
 boolean match)

Sets the organization Id for this query to match organizations that have the specified organization as a descendant.

Parameters:

organizationId - an organization Id

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

Throws:

NullArgumentException - organizationId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantOrganizationIdTerms

void clearDescendantOrganizationIdTerms()

Clears the descendant organization Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantOrganizationQuery

boolean supportsDescendantOrganizationQuery()

Tests if an OrganizationQuery is available.

Returns:

true if an organization query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantOrganizationQuery

OrganizationQuery getDescendantOrganizationQuery()

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

Returns:

the organization query

Throws:

UnimplementedException - supportsDescendantOrganizationQuery() is false

Compliance:

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

matchAnyDescendantOrganization

void matchAnyDescendantOrganization(boolean match)

Matches organizations with any organization descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantOrganizationTerms

void clearDescendantOrganizationTerms()

Clears the descendant organization query terms.

Compliance:

mandatory - This method must be implemented.

matchRealmId

void matchRealmId(Id realmId,
 boolean match)

Sets the realm Id for this query to match organizations assigned to realms.

Parameters:

realmId - a realm Id

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

Throws:

NullArgumentException - realmId is null

Compliance:

mandatory - This method must be implemented.

clearRealmIdTerms

void clearRealmIdTerms()

Clears all realm Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRealmQuery

boolean supportsRealmQuery()

Tests if a RealmQuery is available.

Returns:

true if a realm query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRealmQuery

RealmQuery getRealmQuery()

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

Returns:

the realm query

Throws:

UnimplementedException - supportsRealmQuery() is false

Compliance:

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

clearRealmTerms

void clearRealmTerms()

Clears all realm terms.

Compliance:

mandatory - This method must be implemented.

getOrganizationQueryRecord

OrganizationQueryRecord getOrganizationQueryRecord(Type organizationRecordType)
                                            throws OperationFailedException

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

Parameters:

organizationRecordType - an organization record type

Returns:

the organization query record

Throws:

NullArgumentException - organizationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(organizationRecordType) is false

Compliance:

mandatory - This method must be implemented.