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 .

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

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 OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

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.