Interface AppointmentQuery

All Superinterfaces:

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

public interface AppointmentQuery
extends OsidRelationshipQuery

This is the query for searching appointments. 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	clearCommitmentTerms()	Clears all commitment 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.
void	clearRealmIdTerms()	Clears all realm Id terms.
void	clearRealmTerms()	Clears all realm terms.
void	clearSalaryTerms()	Clears all salary terms.
void	clearTitleTerms()	Clears all title terms.
AppointmentQueryRecord	getAppointmentQueryRecord(Type appointmentRecordType)	Gets the appointment query record corresponding to the given Appointment record Type .
PersonQuery	getPersonQuery()	Gets the query for a person query.
PositionQuery	getPositionQuery()	Gets the query for a position query.
RealmQuery	getRealmQuery()	Gets the query for a realm query.
void	matchAnyCommitment(boolean match)	Matches positions with any low salary.
void	matchAnySalary(boolean match)	Matches positions with any salary.
void	matchAnyTitle(boolean match)	Matches persons with any title.
void	matchCommitment(long from, long to, boolean match)	Matches a commitment between the given range inclusive.
void	matchPersonId(Id personId, boolean match)	Sets a person Id .
void	matchPositionId(Id positionId, boolean match)	Sets a position Id .
void	matchRealmId(Id realmId, boolean match)	Sets the realm Id for this query to match appointments assigned to realms.
void	matchSalary(Currency from, Currency to, boolean match)	Matches a salary between the given range inclusive.
void	matchTitle(String title, Type stringMatchType, boolean match)	Matches a title.
boolean	supportsPersonQuery()	Tests if a PersonQuery is available.
boolean	supportsPositionQuery()	Tests if a PositionQuery 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 OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

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

matchPersonId

void matchPersonId(Id personId,
 boolean match)

Sets a person Id .

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 PersonQuery 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 query. Multiple retrievals produce a nested OR term.

Returns:

the person query

Throws:

UnimplementedException - supportsPersonQuery() is false

Compliance:

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

clearPersonTerms

void clearPersonTerms()

Clears all person terms.

Compliance:

mandatory - This method must be implemented.

matchPositionId

void matchPositionId(Id positionId,
 boolean match)

Sets a position Id .

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 PositionQuery 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 query. Multiple retrievals produce a nested OR term.

Returns:

the position query

Throws:

UnimplementedException - supportsPositionQuery() is false

Compliance:

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

clearPositionTerms

void clearPositionTerms()

Clears all position terms.

Compliance:

mandatory - This method must be implemented.

matchCommitment

void matchCommitment(long from,
 long to,
 boolean match)

Matches a commitment between the given range inclusive.

Parameters:

from - a starting range

to - an ending range

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

Throws:

InvalidArgumentException - from is greater than to

Compliance:

mandatory - This method must be implemented.

matchAnyCommitment

void matchAnyCommitment(boolean match)

Matches positions with any low salary.

Parameters:

match - true to match appointments with any commitment, false to match appointments with no commitment

Compliance:

mandatory - This method must be implemented.

clearCommitmentTerms

void clearCommitmentTerms()

Clears all commitment terms.

Compliance:

mandatory - This method must be implemented.

matchTitle

void matchTitle(String title,
 Type stringMatchType,
 boolean match)

Matches a title.

Parameters:

title - a title

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - title is not of stringMatchType

NullArgumentException - title or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyTitle

void matchAnyTitle(boolean match)

Matches persons with any title.

Parameters:

match - true to match appointments with any title, false to match appointments with no title

Compliance:

mandatory - This method must be implemented.

clearTitleTerms

void clearTitleTerms()

Clears all title terms.

Compliance:

mandatory - This method must be implemented.

matchSalary

void matchSalary(Currency from,
 Currency to,
 boolean match)

Matches a salary between the given range inclusive.

Parameters:

from - a starting salary range

to - an ending salary range

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnySalary

void matchAnySalary(boolean match)

Matches positions with any salary.

Parameters:

match - true to match appointments with any salary, false to match appointments with no salary

Compliance:

mandatory - This method must be implemented.

clearSalaryTerms

void clearSalaryTerms()

Clears all salary terms.

Compliance:

mandatory - This method must be implemented.

matchRealmId

void matchRealmId(Id realmId,
 boolean match)

Sets the realm Id for this query to match appointments 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.

getAppointmentQueryRecord

AppointmentQueryRecord getAppointmentQueryRecord(Type appointmentRecordType)
                                          throws OperationFailedException

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

Parameters:

appointmentRecordType - an appointment record type

Returns:

the appointment query record

Throws:

NullArgumentException - appointmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(appointmentRecordType) is false

Compliance:

mandatory - This method must be implemented.