org.osid.personnel

Interface RealmQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

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.

Method Summary

Methods

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.

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

matchPersonId

void matchPersonId(Id personId,
                 boolean match)

Sets the person Id for this query to match persons assigned to realms.

Parameters:

personId - a person Id

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

Throws:

NullArgumentException - personId is null

Compliance:

mandatory - This method must be implemented.

clearPersonIdTerms

void clearPersonIdTerms()

Clears all person Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPersonQuery

boolean supportsPersonQuery()

Tests if a person query is available.

Returns:

true if a person query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPersonQuery

PersonQuery getPersonQuery()

Gets the query for a person.

Returns:

the person query

Throws:

UnimplementedException - supportsPersonQuery() is false

Compliance:

optional - This method must be implemented if supportsPersonQuery() is true.

matchAnyPerson

void matchAnyPerson(boolean match)

Matches realms with any person.

Parameters:

match - true to match realms with any person, false to match realms with no persons

Compliance:

mandatory - This method must be implemented.

clearPersonTerms

void clearPersonTerms()

Clears all person terms.

Compliance:

mandatory - This method must be implemented.

matchOrganizationId

void matchOrganizationId(Id organizationId,
                       boolean match)

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

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.

clearOrganizationIdTerms

void clearOrganizationIdTerms()

Clears all organization Id terms.

Compliance:

mandatory - This method must be implemented.

supportsOrganizationQuery

boolean supportsOrganizationQuery()

Tests if a organization query is available.

Returns:

true if a organization query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOrganizationQuery

OrganizationQuery getOrganizationQuery()

Gets the query for an organization.

Returns:

the organization query

Throws:

UnimplementedException - supportsOrganizationQuery() is false

Compliance:

optional - This method must be implemented if supportsOrganizationQuery() is true.

matchAnyOrganization

void matchAnyOrganization(boolean match)

Matches realms with any organization.

Parameters:

match - true to match realms with any organization, false to match realms with no organizations

Compliance:

mandatory - This method must be implemented.

clearOrganizationTerms

void clearOrganizationTerms()

Clears all organization terms.

Compliance:

mandatory - This method must be implemented.

matchPositionId

void matchPositionId(Id positionId,
                   boolean match)

Sets the position Id for this query to match positions assigned to realms.

Parameters:

positionId - a position Id

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

Throws:

NullArgumentException - positionId is null

Compliance:

mandatory - This method must be implemented.

clearPositionIdTerms

void clearPositionIdTerms()

Clears all position Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPositionQuery

boolean supportsPositionQuery()

Tests if a position query is available.

Returns:

true if a position query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPositionQuery

PositionQuery getPositionQuery()

Gets the query for a position.

Returns:

the position query

Throws:

UnimplementedException - supportsPositionQuery() is false

Compliance:

optional - This method must be implemented if supportsPositionQuery() is true.

matchAnyPosition

void matchAnyPosition(boolean match)

Matches realms with any position.

Parameters:

match - true to match realms with any position, false to match realms with no positions

Compliance:

mandatory - This method must be implemented.

clearPositionTerms

void clearPositionTerms()

Clears all position terms.

Compliance:

mandatory - This method must be implemented.

matchAppointmentId

void matchAppointmentId(Id appointmentId,
                      boolean match)

Sets the appointment Id for this query to match positions assigned to realms.

Parameters:

appointmentId - an appointment Id

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

Throws:

NullArgumentException - appointmentId is null

Compliance:

mandatory - This method must be implemented.

clearAppointmentIdTerms

void clearAppointmentIdTerms()

Clears all appointment Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAppointmentQuery

boolean supportsAppointmentQuery()

Tests if an appointment query is available.

Returns:

true if an appointment query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAppointmentQuery

AppointmentQuery getAppointmentQuery()

Gets the query for an appointment.

Returns:

the appointment query

Throws:

UnimplementedException - supportsAppointmentQuery() is false

Compliance:

optional - This method must be implemented if supportsAppointmentQuery() is true.

matchAnyAppointment

void matchAnyAppointment(boolean match)

Matches realms with any appointment.

Parameters:

match - true to match realms with any appointment, false to match realms with no appointments

Compliance:

mandatory - This method must be implemented.

clearAppointmentTerms

void clearAppointmentTerms()

Clears all appointment terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorRealmId

void matchAncestorRealmId(Id realmId,
                        boolean match)

Sets the realm Id for this query to match realms that have the specified realm as an ancestor.

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.

clearAncestorRealmIdTerms

void clearAncestorRealmIdTerms()

Clears all ancestor realm Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorRealmQuery

boolean supportsAncestorRealmQuery()

Tests if a RealmQuery is available.

Returns:

true if a realm query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorRealmQuery

RealmQuery getAncestorRealmQuery()

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

Returns:

the realm query

Throws:

UnimplementedException - supportsAncestorRealmQuery() is false

Compliance:

optional - This method must be implemented if supportsAncestorRealmQuery() is true.

matchAnyAncestorRealm

void matchAnyAncestorRealm(boolean match)

Matches realms with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorRealmTerms

void clearAncestorRealmTerms()

Clears all ancestor realm terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantRealmId

void matchDescendantRealmId(Id realmId,
                          boolean match)

Sets the realm Id for this query to match realms that have the specified realm as a descendant.

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.

clearDescendantRealmIdTerms

void clearDescendantRealmIdTerms()

Clears all descendant realm Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantRealmQuery

boolean supportsDescendantRealmQuery()

Tests if a RealmQuery is available.

Returns:

true if a realm query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantRealmQuery

RealmQuery getDescendantRealmQuery()

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

Returns:

the realm query

Throws:

UnimplementedException - supportsDescendantRealmQuery() is false

Compliance:

optional - This method must be implemented if supportsDescendantRealmQuery() is true.

matchAnyDescendantRealm

void matchAnyDescendantRealm(boolean match)

Matches realms with any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantRealmTerms

void clearDescendantRealmTerms()

Clears all descendant realm terms.

Compliance:

mandatory - This method must be implemented.

getRealmQueryRecord

RealmQueryRecord getRealmQueryRecord(Type realmRecordType)
                                     throws OperationFailedException

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

Parameters:

realmRecordType - a realm record type

Returns:

the realm query record

Throws:

NullArgumentException - realmRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(realmRecordType) is false

Compliance:

mandatory - This method must be implemented.