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.
Modifier and Type | Method and 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(java.lang.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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchDisplayLabel(java.lang.String label, Type stringMatchType, boolean match)
label
- a display labelstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- label
is not
of stringMatchType
NullArgumentException
- label
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyDisplayLabel(boolean match)
match
- true
to match organizations with any
display label, false
to match organizations
with no display labelmandatory
- This method must be implemented. void clearDisplayLabelTerms()
mandatory
- This method must be implemented. void matchAncestorOrganizationId(Id organizationId, boolean match)
Id
for this query to match
organizations that have the specified organization as an ancestor.organizationId
- an organization Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- organizationId
is null
mandatory
- This method must be implemented. void clearAncestorOrganizationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorOrganizationQuery()
OrganizationQuery
is available. true
if an organization query is available,
false
otherwisemandatory
- This method must be implemented. OrganizationQuery getAncestorOrganizationQuery()
OR
term.UnimplementedException
-
supportsAncestorOrganizationQuery()
is false
optional
- This method must be implemented if
supportsAncestorOrganizationQuery()
is
true.
void matchAnyAncestorOrganization(boolean match)
match
- true
to match organizations with any
ancestor, false
to match root organizationsmandatory
- This method must be implemented. void clearAncestorOrganizationTerms()
mandatory
- This method must be implemented. void matchDescendantOrganizationId(Id organizationId, boolean match)
Id
for this query to match
organizations that have the specified organization as a descendant.organizationId
- an organization Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- organizationId
is null
mandatory
- This method must be implemented. void clearDescendantOrganizationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantOrganizationQuery()
OrganizationQuery
is available. true
if an organization query is available,
false
otherwisemandatory
- This method must be implemented. OrganizationQuery getDescendantOrganizationQuery()
OR
term.UnimplementedException
-
supportsDescendantOrganizationQuery()
is false
optional
- This method must be implemented if
supportsDescendantOrganizationQuery()
is
true.
void matchAnyDescendantOrganization(boolean match)
match
- true
to match organizations with any
descendant, false
to match leaf organizationsmandatory
- This method must be implemented. void clearDescendantOrganizationTerms()
mandatory
- This method must be implemented. void matchRealmId(Id realmId, boolean match)
Id
for this query to match organizations
assigned to realms.realmId
- a realm Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- realmId
is
null
mandatory
- This method must be implemented. void clearRealmIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsRealmQuery()
RealmQuery
is available. true
if a realm query is available,
false
otherwisemandatory
- This method must be implemented. RealmQuery getRealmQuery()
OR
term.UnimplementedException
- supportsRealmQuery()
is false
optional
- This method must be implemented if
supportsRealmQuery()
is true.
void clearRealmTerms()
mandatory
- This method must be implemented. OrganizationQueryRecord getOrganizationQueryRecord(Type organizationRecordType) throws OperationFailedException
Organization
record Type.
Multiple record
retrievals produce a nested OR
term.organizationRecordType
- an organization record typeNullArgumentException
- organizationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(organizationRecordType)
is false
mandatory
- This method must be implemented.