public interface RealmQuery extends OsidCatalogQuery
This is the query for searching for realms. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorRealmIdTerms()
Clears all ancestor realm
Id terms. |
void |
clearAncestorRealmTerms()
Clears all ancestor realm terms.
|
void |
clearAppointmentIdTerms()
Clears all appointment
Id terms. |
void |
clearAppointmentTerms()
Clears all appointment terms.
|
void |
clearDescendantRealmIdTerms()
Clears all descendant realm
Id terms. |
void |
clearDescendantRealmTerms()
Clears all descendant realm terms.
|
void |
clearOrganizationIdTerms()
Clears all organization
Id terms. |
void |
clearOrganizationTerms()
Clears all organization terms.
|
void |
clearPersonIdTerms()
Clears all person
Id terms. |
void |
clearPersonTerms()
Clears all person terms.
|
void |
clearPositionIdTerms()
Clears all position
Id terms. |
void |
clearPositionTerms()
Clears all position terms.
|
RealmQuery |
getAncestorRealmQuery()
Gets the query for a realm.
|
AppointmentQuery |
getAppointmentQuery()
Gets the query for an appointment.
|
RealmQuery |
getDescendantRealmQuery()
Gets the query for a realm.
|
OrganizationQuery |
getOrganizationQuery()
Gets the query for an organization.
|
PersonQuery |
getPersonQuery()
Gets the query for a person.
|
PositionQuery |
getPositionQuery()
Gets the query for a position.
|
RealmQueryRecord |
getRealmQueryRecord(Type realmRecordType)
Gets the record query corresponding to the given
Realm
record Type. |
void |
matchAncestorRealmId(Id realmId,
boolean match)
Sets the realm
Id for this query to match realms that
have the specified realm as an ancestor. |
void |
matchAnyAncestorRealm(boolean match)
Matches realms with any ancestor.
|
void |
matchAnyAppointment(boolean match)
Matches realms with any appointment.
|
void |
matchAnyDescendantRealm(boolean match)
Matches realms with any descendant.
|
void |
matchAnyOrganization(boolean match)
Matches realms with any organization.
|
void |
matchAnyPerson(boolean match)
Matches realms with any person.
|
void |
matchAnyPosition(boolean match)
Matches realms with any position.
|
void |
matchAppointmentId(Id appointmentId,
boolean match)
Sets the appointment
Id for this query to match
positions assigned to realms. |
void |
matchDescendantRealmId(Id realmId,
boolean match)
Sets the realm
Id for this query to match realms that
have the specified realm as a descendant. |
void |
matchOrganizationId(Id organizationId,
boolean match)
Sets the organization
Id for this query to match
organizations assigned to realms. |
void |
matchPersonId(Id personId,
boolean match)
Sets the person
Id for this query to match persons
assigned to realms. |
void |
matchPositionId(Id positionId,
boolean match)
Sets the position
Id for this query to match positions
assigned to realms. |
boolean |
supportsAncestorRealmQuery()
Tests if a
RealmQuery is available. |
boolean |
supportsAppointmentQuery()
Tests if an appointment query is available.
|
boolean |
supportsDescendantRealmQuery()
Tests if a
RealmQuery is available. |
boolean |
supportsOrganizationQuery()
Tests if a organization query is available.
|
boolean |
supportsPersonQuery()
Tests if a person query is available.
|
boolean |
supportsPositionQuery()
Tests if a position query 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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchPersonId(Id personId, boolean match)
Id
for this query to match persons
assigned to realms.personId
- a person Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- personId
is
null
mandatory
- This method must be implemented. void clearPersonIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsPersonQuery()
true
if a person query is available,
false
otherwisemandatory
- This method must be implemented. PersonQuery getPersonQuery()
UnimplementedException
- supportsPersonQuery()
is false
optional
- This method must be implemented if
supportsPersonQuery()
is true.
void matchAnyPerson(boolean match)
match
- true
to match realms with any person,
false
to match realms with no personsmandatory
- This method must be implemented. void clearPersonTerms()
mandatory
- This method must be implemented. void matchOrganizationId(Id organizationId, boolean match)
Id
for this query to match
organizations assigned to realms.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 clearOrganizationIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsOrganizationQuery()
true
if a organization query is available,
false
otherwisemandatory
- This method must be implemented. OrganizationQuery getOrganizationQuery()
UnimplementedException
-
supportsOrganizationQuery()
is false
optional
- This method must be implemented if
supportsOrganizationQuery()
is true.
void matchAnyOrganization(boolean match)
match
- true
to match realms with any
organization, false
to match realms with no
organizationsmandatory
- This method must be implemented. void clearOrganizationTerms()
mandatory
- This method must be implemented. void matchPositionId(Id positionId, boolean match)
Id
for this query to match positions
assigned to realms.positionId
- a position Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- positionId
is
null
mandatory
- This method must be implemented. void clearPositionIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsPositionQuery()
true
if a position query is available,
false
otherwisemandatory
- This method must be implemented. PositionQuery getPositionQuery()
UnimplementedException
- supportsPositionQuery()
is false
optional
- This method must be implemented if
supportsPositionQuery()
is true.
void matchAnyPosition(boolean match)
match
- true
to match realms with any position,
false
to match realms with no positionsmandatory
- This method must be implemented. void clearPositionTerms()
mandatory
- This method must be implemented. void matchAppointmentId(Id appointmentId, boolean match)
Id
for this query to match
positions assigned to realms.appointmentId
- an appointment Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- appointmentId
is
null
mandatory
- This method must be implemented. void clearAppointmentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAppointmentQuery()
true
if an appointment query is available,
false
otherwisemandatory
- This method must be implemented. AppointmentQuery getAppointmentQuery()
UnimplementedException
-
supportsAppointmentQuery()
is false
optional
- This method must be implemented if
supportsAppointmentQuery()
is true.
void matchAnyAppointment(boolean match)
match
- true
to match realms with any
appointment, false
to match realms with no
appointmentsmandatory
- This method must be implemented. void clearAppointmentTerms()
mandatory
- This method must be implemented. void matchAncestorRealmId(Id realmId, boolean match)
Id
for this query to match realms that
have the specified realm as an ancestor.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 clearAncestorRealmIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorRealmQuery()
RealmQuery
is available. true
if a realm query is available,
false
otherwisemandatory
- This method must be implemented. RealmQuery getAncestorRealmQuery()
OR
term.UnimplementedException
-
supportsAncestorRealmQuery()
is false
optional
- This method must be implemented if
supportsAncestorRealmQuery()
is true.
void matchAnyAncestorRealm(boolean match)
match
- true
to match realms with any ancestor,
false
to match root realmsmandatory
- This method must be implemented. void clearAncestorRealmTerms()
mandatory
- This method must be implemented. void matchDescendantRealmId(Id realmId, boolean match)
Id
for this query to match realms that
have the specified realm as a descendant.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 clearDescendantRealmIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantRealmQuery()
RealmQuery
is available. true
if a realm query is available,
false
otherwisemandatory
- This method must be implemented. RealmQuery getDescendantRealmQuery()
OR
term.UnimplementedException
-
supportsDescendantRealmQuery()
is false
optional
- This method must be implemented if
supportsDescendantRealmQuery()
is true.
void matchAnyDescendantRealm(boolean match)
match
- true
to match realms with any descendant,
false
to match leaf realmsmandatory
- This method must be implemented. void clearDescendantRealmTerms()
mandatory
- This method must be implemented. RealmQueryRecord getRealmQueryRecord(Type realmRecordType) throws OperationFailedException
Realm
record Type.
Multiple record retrievals produce a
nested boolean OR
term.realmRecordType
- a realm record typeNullArgumentException
- realmRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(realmRecordType)
is false
mandatory
- This method must be implemented.