org.osid.personnel

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

Methods

Modifier and Type	Method and 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(java.lang.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 org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

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.OsidTemporalQuery

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

Method Detail

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 supportsPersonQuery() is 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 supportsPositionQuery() is 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(java.lang.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 supportsRealmQuery() is 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.