OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.PositionQuery
Implementsosid.OsidObjectQuery
osid.OsidTemporalQuery
osid.OsidSubjugateableQuery
Description

This is the query for searching positions. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchOrganizationId
Description

Sets an organization Id.

Parametersosid.id.IdorganizationIdan organization Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT organizationId is null
CompliancemandatoryThis method must be implemented.
MethodclearOrganizationIdTerms
Description

Clears all organization Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsOrganizationQuery
Description

Tests if an OrganizationQuery is available.

Returnboolean true if an organization query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationQuery
Description

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

Returnosid.personnel.OrganizationQuerythe organization query
ErrorsUNIMPLEMENTED supportsOrganizationQuery() is false
ComplianceoptionalThis method must be implemented if supportsOrganizationQuery() is true.
MethodclearOrganizationTerms
Description

Clears all organization terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTitle
Description

Matches a title.

Parametersstringtitlea title
osid.type.TypestringMatchTypea string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT title is not of stringMatchType
NULL_ARGUMENT title or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTitle
Description

Matches persons with any title.

Parametersbooleanmatch true to match positions with any title, false to match positions with no title
CompliancemandatoryThis method must be implemented.
MethodclearTitleTerms
Description

Clears all title terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLevelId
Description

Sets a grade Id.

Parametersosid.id.IdgradeIda grade Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeId is null
CompliancemandatoryThis method must be implemented.
MethodclearLevelIdTerms
Description

Clears all grade Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLevelQuery
Description

Tests if a GradeQuery is available.

Returnboolean true if a grade query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLevelQuery
Description

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

Returnosid.grading.GradeQuerythe grade query
ErrorsUNIMPLEMENTED supportsLevelQuery() is false
ComplianceoptionalThis method must be implemented if supportsLevelQuery() is true.
MethodmatchAnyLevel
Description

Matches positions with any level.

Parametersbooleanmatch true to match positions with any level, false to match positions with no level
CompliancemandatoryThis method must be implemented.
MethodclearLevelTerms
Description

Clears all level terms.

CompliancemandatoryThis method must be implemented.
MethodmatchQualificationId
Description

Sets an objective Id.

Parametersosid.id.IdobjectiveIdan objective Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectiveId is null
CompliancemandatoryThis method must be implemented.
MethodclearQualificationIdTerms
Description

Clears all objective Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsQualificationQuery
Description

Tests if an ObjectiveQuery is available.

Returnboolean true if an objective query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQualificationQuery
Description

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

Returnosid.learning.ObjectiveQuerythe grade query
ErrorsUNIMPLEMENTED supportsQualificationQuery() is false
ComplianceoptionalThis method must be implemented if supportsQualificationQuery() is true.
MethodmatchAnyQualification
Description

Matches positions with any qualification.

Parametersbooleanmatch true to match positions with any qualification, false to match positions with no qualifications
CompliancemandatoryThis method must be implemented.
MethodclearQualificationTerms
Description

Clears all qualification terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTargetAppointments
Description

Matches a target appointments between the given range inclusive.

Parameterscardinalfroma starting range
cardinaltoan ending range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTargetAppointments
Description

Matches positions with any target appointments.

Parametersbooleanmatch true to match positions with any target appointments, false to match positions with no target appointments
CompliancemandatoryThis method must be implemented.
MethodclearTargetAppointmentsTerms
Description

Clears all target appointments terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRequiredCommitment
Description

Matches a required commitment between the given range inclusive.

Parameterscardinalfroma starting range
cardinaltoan ending range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
CompliancemandatoryThis method must be implemented.
MethodmatchAnyRequiredCommitment
Description

Matches positions with any required commitment.

Parametersbooleanmatch true to match positions with any required commitment, false to match positions with no required commitment
CompliancemandatoryThis method must be implemented.
MethodclearRequiredCommitmentTerms
Description

Clears all required commitment terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLowSalaryRange
Description

Matches a low salary between the given range inclusive.

Parametersosid.financials.Currencyfroma starting salary
osid.financials.Currencytoan ending salary
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyLowSalaryRange
Description

Matches positions with any low salary.

Parametersbooleanmatch true to match positions with any low salary range, commitment, false to match positions with no low salary range
CompliancemandatoryThis method must be implemented.
MethodclearLowSalaryRangeTerms
Description

Clears all low salary terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMidpointSalaryRange
Description

Matches a midpoint salary between the given range inclusive.

Parametersosid.financials.Currencyfroma starting salary
osid.financials.Currencytoan ending salary
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyMidpointSalaryRange
Description

Matches positions with any midpoint salary.

Parametersbooleanmatch true to match positions with any midpoint salary range, commitment, false to match positions with no midpoint salary range
CompliancemandatoryThis method must be implemented.
MethodclearMidpointSalaryRangeTerms
Description

Clears all midpoint salary terms.

CompliancemandatoryThis method must be implemented.
MethodmatchHighSalaryRange
Description

Matches a high salary between the given range inclusive.

Parametersosid.financials.Currencyfroma starting salary
osid.financials.Currencytoan ending salary
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyHighSalaryRange
Description

Matches positions with any high salary.

Parametersbooleanmatch true to match positions with any high salary range, false to match positions with no high salary range
CompliancemandatoryThis method must be implemented.
MethodclearHighSalaryRangeTerms
Description

Clears all high salary terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCompensationFrequency
Description

Matches a compensation frequency between the given range inclusive.

Parametersosid.calendaring.Durationlowlow range of time frequency
osid.calendaring.Durationhighhigh range of time frequency
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT frequency is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCompensationFrequency
Description

Matches positions with any compensation frequency.

Parametersbooleanmatch true to match positions with any compensation frequency, false to match positions with no compensation frequency
CompliancemandatoryThis method must be implemented.
MethodclearCompensationFrequencyTerms
Description

Clears all compensation frequency terms.

CompliancemandatoryThis method must be implemented.
MethodmatchExempt
Description

Matches exempt positions.

Parametersbooleanmatch true to match exempt positions, false to match non-exempt positions
CompliancemandatoryThis method must be implemented.
MethodmatchAnyExempt
Description

Matches positions with any exempt flag set.

Parametersbooleanmatch true to match positions with any exempt status,, false to match positions with no exempt status
CompliancemandatoryThis method must be implemented.
MethodclearExemptTerms
Description

Clears all exempt terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBenefitsType
Description

Matches a benefits type.

Parametersosid.type.Typetypea benefits type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT type is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyBenefitsType
Description

Matches positions with any benefits type.

Parametersbooleanmatch true to match positions with any benefits type, false to match positions with no benefits type
CompliancemandatoryThis method must be implemented.
MethodclearBenefitsTypeTerms
Description

Clears all benefits type terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRealmId
Description

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

Parametersosid.id.IdrealmIda realm Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT realmId is null
CompliancemandatoryThis method must be implemented.
MethodclearRealmIdTerms
Description

Clears all realm Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRealmQuery
Description

Tests if a RealmQuery is available.

Returnboolean true if a realm query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRealmQuery
Description

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

Returnosid.personnel.RealmQuerythe realm query
ErrorsUNIMPLEMENTED supportsRealmQuery() is false
ComplianceoptionalThis method must be implemented if supportsRealmQuery() is true.
MethodclearRealmTerms
Description

Clears all realm terms.

CompliancemandatoryThis method must be implemented.
MethodgetPositionQueryRecord
Description

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

Parametersosid.type.TypepositionRecordTypea position record type
Returnosid.personnel.records.PositionQueryRecordthe position query record
ErrorsNULL_ARGUMENT positionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(positionRecordType) is false
CompliancemandatoryThis method must be implemented.