org.osid.personnel

Interface PositionQuery

All Superinterfaces:

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

public interface PositionQuery
extends OsidObjectQuery, OsidTemporalQuery, OsidSubjugateableQuery

This is the query for searching positions. 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	clearBenefitsTypeTerms() Clears all benefits type terms.
void	clearCompensationFrequencyTerms() Clears all compensation frequency terms.
void	clearExemptTerms() Clears all exempt terms.
void	clearHighSalaryRangeTerms() Clears all high salary terms.
void	clearLevelIdTerms() Clears all grade Id terms.
void	clearLevelTerms() Clears all level terms.
void	clearLowSalaryRangeTerms() Clears all low salary terms.
void	clearMidpointSalaryRangeTerms() Clears all midpoint salary terms.
void	clearOrganizationIdTerms() Clears all organization Id terms.
void	clearOrganizationTerms() Clears all organization terms.
void	clearQualificationIdTerms() Clears all objective Id terms.
void	clearQualificationTerms() Clears all qualification terms.
void	clearRealmIdTerms() Clears all realm Id terms.
void	clearRealmTerms() Clears all realm terms.
void	clearRequiredCommitmentTerms() Clears all required commitment terms.
void	clearTargetAppointmentsTerms() Clears all target appointments terms.
void	clearTitleTerms() Clears all title terms.
GradeQuery	getLevelQuery() Gets the query for a grade query.
OrganizationQuery	getOrganizationQuery() Gets the query for an organization query.
PositionQueryRecord	getPositionQueryRecord(Type positionRecordType) Gets the position query record corresponding to the given Position record Type.
ObjectiveQuery	getQualificationQuery() Gets the query for an objective query.
RealmQuery	getRealmQuery() Gets the query for a realm query.
void	matchAnyBenefitsType(boolean match) Matches positions with any benefits type.
void	matchAnyCompensationFrequency(boolean match) Matches positions with any compensation frequency.
void	matchAnyExempt(boolean match) Matches positions with any exempt flag set.
void	matchAnyHighSalaryRange(boolean match) Matches positions with any high salary.
void	matchAnyLevel(boolean match) Matches positions with any level.
void	matchAnyLowSalaryRange(boolean match) Matches positions with any low salary.
void	matchAnyMidpointSalaryRange(boolean match) Matches positions with any midpoint salary.
void	matchAnyQualification(boolean match) Matches positions with any qualification.
void	matchAnyRequiredCommitment(boolean match) Matches positions with any required commitment.
void	matchAnyTargetAppointments(boolean match) Matches positions with any target appointments.
void	matchAnyTitle(boolean match) Matches persons with any title.
void	matchBenefitsType(Type type, boolean match) Matches a benefits type.
void	matchCompensationFrequency(Duration low, Duration high, boolean match) Matches a compensation frequency between the given range inclusive.
void	matchExempt(boolean match) Matches exempt positions.
void	matchHighSalaryRange(Currency from, Currency to, boolean match) Matches a high salary between the given range inclusive.
void	matchLevelId(Id gradeId, boolean match) Sets a grade Id.
void	matchLowSalaryRange(Currency from, Currency to, boolean match) Matches a low salary between the given range inclusive.
void	matchMidpointSalaryRange(Currency from, Currency to, boolean match) Matches a midpoint salary between the given range inclusive.
void	matchOrganizationId(Id organizationId, boolean match) Sets an organization Id.
void	matchQualificationId(Id objectiveId, boolean match) Sets an objective Id.
void	matchRealmId(Id realmId, boolean match) Sets the realm Id for this query to match positions assigned to realms.
void	matchRequiredCommitment(long from, long to, boolean match) Matches a required commitment between the given range inclusive.
void	matchTargetAppointments(long from, long to, boolean match) Matches a target appointments between the given range inclusive.
void	matchTitle(java.lang.String title, Type stringMatchType, boolean match) Matches a title.
boolean	supportsLevelQuery() Tests if a GradeQuery is available.
boolean	supportsOrganizationQuery() Tests if an OrganizationQuery is available.
boolean	supportsQualificationQuery() Tests if an ObjectiveQuery is available.
boolean	supportsRealmQuery() Tests if a RealmQuery 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.OsidTemporalQuery

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

Method Detail

matchOrganizationId

void matchOrganizationId(Id organizationId,
                       boolean match)

Sets an organization Id.

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 an OrganizationQuery is available.

Returns:

true if an organization query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOrganizationQuery

OrganizationQuery getOrganizationQuery()

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

Returns:

the organization query

Throws:

UnimplementedException - supportsOrganizationQuery() is false

Compliance:

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

clearOrganizationTerms

void clearOrganizationTerms()

Clears all organization 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 positions with any title, false to match positions with no title

Compliance:

mandatory - This method must be implemented.

clearTitleTerms

void clearTitleTerms()

Clears all title terms.

Compliance:

mandatory - This method must be implemented.

matchLevelId

void matchLevelId(Id gradeId,
                boolean match)

Sets a grade Id.

Parameters:

gradeId - a grade Id

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

Throws:

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearLevelIdTerms

void clearLevelIdTerms()

Clears all grade Id terms.

Compliance:

mandatory - This method must be implemented.

supportsLevelQuery

boolean supportsLevelQuery()

Tests if a GradeQuery is available.

Returns:

true if a grade query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLevelQuery

GradeQuery getLevelQuery()

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

Returns:

the grade query

Throws:

UnimplementedException - supportsLevelQuery() is false

Compliance:

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

matchAnyLevel

void matchAnyLevel(boolean match)

Matches positions with any level.

Parameters:

match - true to match positions with any level, false to match positions with no level

Compliance:

mandatory - This method must be implemented.

clearLevelTerms

void clearLevelTerms()

Clears all level terms.

Compliance:

mandatory - This method must be implemented.

matchQualificationId

void matchQualificationId(Id objectiveId,
                        boolean match)

Sets an objective Id.

Parameters:

objectiveId - an objective Id

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

Throws:

NullArgumentException - objectiveId is null

Compliance:

mandatory - This method must be implemented.

clearQualificationIdTerms

void clearQualificationIdTerms()

Clears all objective Id terms.

Compliance:

mandatory - This method must be implemented.

supportsQualificationQuery

boolean supportsQualificationQuery()

Tests if an ObjectiveQuery is available.

Returns:

true if an objective query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getQualificationQuery

ObjectiveQuery getQualificationQuery()

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

Returns:

the grade query

Throws:

UnimplementedException - supportsQualificationQuery() is false

Compliance:

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

matchAnyQualification

void matchAnyQualification(boolean match)

Matches positions with any qualification.

Parameters:

match - true to match positions with any qualification, false to match positions with no qualifications

Compliance:

mandatory - This method must be implemented.

clearQualificationTerms

void clearQualificationTerms()

Clears all qualification terms.

Compliance:

mandatory - This method must be implemented.

matchTargetAppointments

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

Matches a target appointments 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.

matchAnyTargetAppointments

void matchAnyTargetAppointments(boolean match)

Matches positions with any target appointments.

Parameters:

match - true to match positions with any target appointments, false to match positions with no target appointments

Compliance:

mandatory - This method must be implemented.

clearTargetAppointmentsTerms

void clearTargetAppointmentsTerms()

Clears all target appointments terms.

Compliance:

mandatory - This method must be implemented.

matchRequiredCommitment

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

Matches a required 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.

matchAnyRequiredCommitment

void matchAnyRequiredCommitment(boolean match)

Matches positions with any required commitment.

Parameters:

match - true to match positions with any required commitment, false to match positions with no required commitment

Compliance:

mandatory - This method must be implemented.

clearRequiredCommitmentTerms

void clearRequiredCommitmentTerms()

Clears all required commitment terms.

Compliance:

mandatory - This method must be implemented.

matchLowSalaryRange

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

Matches a low salary between the given range inclusive.

Parameters:

from - a starting salary

to - an ending salary

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.

matchAnyLowSalaryRange

void matchAnyLowSalaryRange(boolean match)

Matches positions with any low salary.

Parameters:

match - true to match positions with any low salary range, commitment, false to match positions with no low salary range

Compliance:

mandatory - This method must be implemented.

clearLowSalaryRangeTerms

void clearLowSalaryRangeTerms()

Clears all low salary terms.

Compliance:

mandatory - This method must be implemented.

matchMidpointSalaryRange

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

Matches a midpoint salary between the given range inclusive.

Parameters:

from - a starting salary

to - an ending salary

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.

matchAnyMidpointSalaryRange

void matchAnyMidpointSalaryRange(boolean match)

Matches positions with any midpoint salary.

Parameters:

match - true to match positions with any midpoint salary range, commitment, false to match positions with no midpoint salary range

Compliance:

mandatory - This method must be implemented.

clearMidpointSalaryRangeTerms

void clearMidpointSalaryRangeTerms()

Clears all midpoint salary terms.

Compliance:

mandatory - This method must be implemented.

matchHighSalaryRange

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

Matches a high salary between the given range inclusive.

Parameters:

from - a starting salary

to - an ending salary

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.

matchAnyHighSalaryRange

void matchAnyHighSalaryRange(boolean match)

Matches positions with any high salary.

Parameters:

match - true to match positions with any high salary range, false to match positions with no high salary range

Compliance:

mandatory - This method must be implemented.

clearHighSalaryRangeTerms

void clearHighSalaryRangeTerms()

Clears all high salary terms.

Compliance:

mandatory - This method must be implemented.

matchCompensationFrequency

void matchCompensationFrequency(Duration low,
                              Duration high,
                              boolean match)

Matches a compensation frequency between the given range inclusive.

Parameters:

low - low range of time frequency

high - high range of time frequency

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

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - frequency is null

Compliance:

mandatory - This method must be implemented.

matchAnyCompensationFrequency

void matchAnyCompensationFrequency(boolean match)

Matches positions with any compensation frequency.

Parameters:

match - true to match positions with any compensation frequency, false to match positions with no compensation frequency

Compliance:

mandatory - This method must be implemented.

clearCompensationFrequencyTerms

void clearCompensationFrequencyTerms()

Clears all compensation frequency terms.

Compliance:

mandatory - This method must be implemented.

matchExempt

void matchExempt(boolean match)

Matches exempt positions.

Parameters:

match - true to match exempt positions, false to match non-exempt positions

Compliance:

mandatory - This method must be implemented.

matchAnyExempt

void matchAnyExempt(boolean match)

Matches positions with any exempt flag set.

Parameters:

match - true to match positions with any exempt status,, false to match positions with no exempt status

Compliance:

mandatory - This method must be implemented.

clearExemptTerms

void clearExemptTerms()

Clears all exempt terms.

Compliance:

mandatory - This method must be implemented.

matchBenefitsType

void matchBenefitsType(Type type,
                     boolean match)

Matches a benefits type.

Parameters:

type - a benefits type

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

Throws:

NullArgumentException - type is null

Compliance:

mandatory - This method must be implemented.

matchAnyBenefitsType

void matchAnyBenefitsType(boolean match)

Matches positions with any benefits type.

Parameters:

match - true to match positions with any benefits type, false to match positions with no benefits type

Compliance:

mandatory - This method must be implemented.

clearBenefitsTypeTerms

void clearBenefitsTypeTerms()

Clears all benefits type terms.

Compliance:

mandatory - This method must be implemented.

matchRealmId

void matchRealmId(Id realmId,
                boolean match)

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

getPositionQueryRecord

PositionQueryRecord getPositionQueryRecord(Type positionRecordType)
                                           throws OperationFailedException

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

Parameters:

positionRecordType - a position record type

Returns:

the position query record

Throws:

NullArgumentException - positionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(positionRecordType) is false

Compliance:

mandatory - This method must be implemented.