Interface | osid.personnel.PositionQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidTemporalQuery | |||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching positions. Each method
specifies an | ||
Method | matchOrganizationId | ||
Description |
Sets an organization | ||
Parameters | osid.id.Id | organizationId | an organization Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | organizationId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearOrganizationIdTerms | ||
Description |
Clears all organization | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrganizationQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an organization query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationQuery | ||
Description |
Gets the query for an organization query. Multiple
retrievals produce a nested | ||
Return | osid.personnel.OrganizationQuery | the organization query | |
Errors | UNIMPLEMENTED | supportsOrganizationQuery() is false | |
Compliance | optional | This method must be implemented if supportsOrganizationQuery()
is true. | |
Method | clearOrganizationTerms | ||
Description |
Clears all organization terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTitle | ||
Description |
Matches a title. | ||
Parameters | string | title | a title |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | title is not of stringMatchType | |
NULL_ARGUMENT | title or stringMatchType is null
| ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyTitle | ||
Description |
Matches persons with any title. | ||
Parameters | boolean | match | true to match positions with any title, false
to match positions with no title |
Compliance | mandatory | This method must be implemented. | |
Method | clearTitleTerms | ||
Description |
Clears all title terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchLevelId | ||
Description |
Sets a grade | ||
Parameters | osid.id.Id | gradeId | a grade Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearLevelIdTerms | ||
Description |
Clears all grade | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsLevelQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a grade query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLevelQuery | ||
Description |
Gets the query for a grade query. Multiple retrievals
produce a nested | ||
Return | osid.grading.GradeQuery | the grade query | |
Errors | UNIMPLEMENTED | supportsLevelQuery() is false | |
Compliance | optional | This method must be implemented if supportsLevelQuery() is
true. | |
Method | matchAnyLevel | ||
Description |
Matches positions with any level. | ||
Parameters | boolean | match | true to match positions with any level, false
to match positions with no level |
Compliance | mandatory | This method must be implemented. | |
Method | clearLevelTerms | ||
Description |
Clears all level terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchQualificationId | ||
Description |
Sets an objective | ||
Parameters | osid.id.Id | objectiveId | an objective Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | objectiveId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearQualificationIdTerms | ||
Description |
Clears all objective | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsQualificationQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an objective query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQualificationQuery | ||
Description |
Gets the query for an objective query. Multiple
retrievals produce a nested | ||
Return | osid.learning.ObjectiveQuery | the grade query | |
Errors | UNIMPLEMENTED | supportsQualificationQuery() is false | |
Compliance | optional | This method must be implemented if supportsQualificationQuery()
is true. | |
Method | matchAnyQualification | ||
Description |
Matches positions with any qualification. | ||
Parameters | boolean | match | true to match positions with any qualification, false
to match positions with no qualifications |
Compliance | mandatory | This method must be implemented. | |
Method | clearQualificationTerms | ||
Description |
Clears all qualification terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTargetAppointments | ||
Description |
Matches a target appointments between the given range inclusive. | ||
Parameters | cardinal | from | a starting range |
cardinal | to | an ending range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyTargetAppointments | ||
Description |
Matches positions with any target appointments. | ||
Parameters | boolean | match | true to match positions with any target appointments,
false to match positions with no target appointments |
Compliance | mandatory | This method must be implemented. | |
Method | clearTargetAppointmentsTerms | ||
Description |
Clears all target appointments terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRequiredCommitment | ||
Description |
Matches a required commitment between the given range inclusive. | ||
Parameters | cardinal | from | a starting range |
cardinal | to | an ending range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyRequiredCommitment | ||
Description |
Matches positions with any required commitment. | ||
Parameters | boolean | match | true to match positions with any required commitment,
false to match positions with no required commitment |
Compliance | mandatory | This method must be implemented. | |
Method | clearRequiredCommitmentTerms | ||
Description |
Clears all required commitment terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchLowSalaryRange | ||
Description |
Matches a low salary between the given range inclusive. | ||
Parameters | osid.financials.Currency | from | a starting salary |
osid.financials.Currency | to | an ending salary | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyLowSalaryRange | ||
Description |
Matches positions with any low salary. | ||
Parameters | boolean | 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. | |
Method | clearLowSalaryRangeTerms | ||
Description |
Clears all low salary terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMidpointSalaryRange | ||
Description |
Matches a midpoint salary between the given range inclusive. | ||
Parameters | osid.financials.Currency | from | a starting salary |
osid.financials.Currency | to | an ending salary | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyMidpointSalaryRange | ||
Description |
Matches positions with any midpoint salary. | ||
Parameters | boolean | 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. | |
Method | clearMidpointSalaryRangeTerms | ||
Description |
Clears all midpoint salary terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchHighSalaryRange | ||
Description |
Matches a high salary between the given range inclusive. | ||
Parameters | osid.financials.Currency | from | a starting salary |
osid.financials.Currency | to | an ending salary | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyHighSalaryRange | ||
Description |
Matches positions with any high salary. | ||
Parameters | boolean | 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. | |
Method | clearHighSalaryRangeTerms | ||
Description |
Clears all high salary terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCompensationFrequency | ||
Description |
Matches a compensation frequency between the given range inclusive. | ||
Parameters | osid.calendaring.Duration | low | low range of time frequency |
osid.calendaring.Duration | high | high range of time frequency | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
NULL_ARGUMENT | frequency is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyCompensationFrequency | ||
Description |
Matches positions with any compensation frequency. | ||
Parameters | boolean | match | true to match positions with any compensation frequency,
false to match positions with no compensation frequency |
Compliance | mandatory | This method must be implemented. | |
Method | clearCompensationFrequencyTerms | ||
Description |
Clears all compensation frequency terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchExempt | ||
Description |
Matches exempt positions. | ||
Parameters | boolean | match | true to match exempt positions, false to
match non-exempt positions |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyExempt | ||
Description |
Matches positions with any exempt flag set. | ||
Parameters | boolean | match | true to match positions with any exempt status,,
false to match positions with no exempt status |
Compliance | mandatory | This method must be implemented. | |
Method | clearExemptTerms | ||
Description |
Clears all exempt terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchBenefitsType | ||
Description |
Matches a benefits type. | ||
Parameters | osid.type.Type | type | a benefits type |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | type is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyBenefitsType | ||
Description |
Matches positions with any benefits type. | ||
Parameters | boolean | match | true to match positions with any benefits type, false
to match positions with no benefits type |
Compliance | mandatory | This method must be implemented. | |
Method | clearBenefitsTypeTerms | ||
Description |
Clears all benefits type terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRealmId | ||
Description |
Sets the realm | ||
Parameters | osid.id.Id | realmId | a realm Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | realmId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRealmIdTerms | ||
Description |
Clears all realm | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRealmQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a realm query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRealmQuery | ||
Description |
Gets the query for a realm query. Multiple retrievals
produce a nested | ||
Return | osid.personnel.RealmQuery | the realm query | |
Errors | UNIMPLEMENTED | supportsRealmQuery() is false | |
Compliance | optional | This method must be implemented if supportsRealmQuery() is
true. | |
Method | clearRealmTerms | ||
Description |
Clears all realm terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPositionQueryRecord | ||
Description |
Gets the position query record corresponding to the
given | ||
Parameters | osid.type.Type | positionRecordType | a position record type |
Return | osid.personnel.records.PositionQueryRecord | the position query record | |
Errors | NULL_ARGUMENT | positionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(positionRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |