OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.AppointmentQuery
Implementsosid.OsidRelationshipQuery
Description

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

MethodmatchPersonId
Description

Sets a person Id.

Parametersosid.id.IdpersonIda person Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT personId is null
CompliancemandatoryThis method must be implemented.
MethodclearPersonIdTerms
Description

Clears all person Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPersonQuery
Description

Tests if a PersonQuery is available.

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

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

Returnosid.personnel.PersonQuerythe person query
ErrorsUNIMPLEMENTED supportsPersonQuery() is false
ComplianceoptionalThis method must be implemented if supportsPersonQuery() is true.
MethodclearPersonTerms
Description

Clears all person terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPositionId
Description

Sets a position Id.

Parametersosid.id.IdpositionIda position Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT positionId is null
CompliancemandatoryThis method must be implemented.
MethodclearPositionIdTerms
Description

Clears all position Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPositionQuery
Description

Tests if a PositionQuery is available.

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

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

Returnosid.personnel.PositionQuerythe position query
ErrorsUNIMPLEMENTED supportsPositionQuery() is false
ComplianceoptionalThis method must be implemented if supportsPositionQuery() is true.
MethodclearPositionTerms
Description

Clears all position terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCommitment
Description

Matches a 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.
MethodmatchAnyCommitment
Description

Matches positions with any low salary.

Parametersbooleanmatch true to match appointments with any commitment, false to match appointments with no commitment
CompliancemandatoryThis method must be implemented.
MethodclearCommitmentTerms
Description

Clears all commitment 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 appointments with any title, false to match appointments with no title
CompliancemandatoryThis method must be implemented.
MethodclearTitleTerms
Description

Clears all title terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSalary
Description

Matches a salary between the given range inclusive.

Parametersosid.financials.Currencyfroma starting salary range
osid.financials.Currencytoan ending salary range
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.
MethodmatchAnySalary
Description

Matches positions with any salary.

Parametersbooleanmatch true to match appointments with any salary, false to match appointments with no salary
CompliancemandatoryThis method must be implemented.
MethodclearSalaryTerms
Description

Clears all salary terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRealmId
Description

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

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

Parametersosid.type.TypeappointmentRecordTypean appointment record type
Returnosid.personnel.records.AppointmentQueryRecordthe appointment query record
ErrorsNULL_ARGUMENT appointmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(appointmentRecordType) is false
CompliancemandatoryThis method must be implemented.