org.osid.personnel

Interface PositionForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

PositionBatchForm

public interface PositionForm
extends OsidObjectForm, OsidTemporalForm, OsidSubjugateableForm

This is the form for creating and updating Position objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PositionAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearBenefitsType() Clears the benefits type.
void	clearCompensationFrequency() Clears the compensation frequency.
void	clearExempt() Clears the exempt flag.
void	clearHighSalaryRange() Clears the high salary.
void	clearLevel() Clears the level.
void	clearLowSalaryRange() Clears the low salary.
void	clearMidpointSalaryRange() Clears the midpoint salary.
void	clearQualifications() Clears the qualifications.
void	clearRequiredCommitment() Clears the required commitment.
void	clearTargetAppointments() Clears the target appointments.
void	clearTitle() Clears the title.
Metadata	getBenefitsTypeMetadata() Gets the metadata for a benefits type.
Metadata	getCompensationFrequencyMetadata() Gets the metadata for a compensation frequency.
Metadata	getExemptMetadata() Gets the metadata for the exempt flag.
Metadata	getHighSalaryRangeMetadata() Gets the metadata for a high salary range.
Metadata	getLevelMetadata() Gets the metadata for a level.
Metadata	getLowSalaryRangeMetadata() Gets the metadata for a low salary range.
Metadata	getMidpointSalaryRangeMetadata() Gets the metadata for a midpoint salary range.
PositionFormRecord	getPositionFormRecord(Type positionRecordType) Gets the PositionFormRecord interface corresponding to the given position record Type.
Metadata	getQualificationsMetadata() Gets the metadata for the qualifications.
Metadata	getRequiredCommitmentMetadata() Gets the metadata for a required commitment.
Metadata	getTargetAppointmenstMetadata() Gets the metadata for a target appointments.
Metadata	getTitleMetadata() Gets the metadata for a title.
void	setBenefitsType(Type type) Sets the benefits type.
void	setCompensationFrequency(Duration frequency) Sets the compensation frequency.
void	setExempt(boolean eempt) Sets the exempt flag.
void	setHighSalaryRange(Currency salary) Sets the high salary range.
void	setLevel(Id gradeId) Sets the job level.
void	setLowSalaryRange(Currency salary) Sets the low salary range.
void	setMidpointSalaryRange(Currency salary) Sets the midpoint salary range.
void	setQualifications(Id[] objectivesIds) Sets the position qualifications.
void	setRequiredCommitment(long commitment) Sets the required commitment percentage (0-100).
void	setTargetAppointments(long appointments) Sets the target appointments.
void	setTitle(java.lang.String title) Sets the title.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getTitleMetadata

Metadata getTitleMetadata()

Gets the metadata for a title.

Returns:

metadata for the title

Compliance:

mandatory - This method must be implemented.

setTitle

void setTitle(java.lang.String title)

Sets the title.

Parameters:

title - the title

Throws:

InvalidArgumentException - title is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - title is null

Compliance:

mandatory - This method must be implemented.

clearTitle

void clearTitle()

Clears the title.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getLevelMetadata

Metadata getLevelMetadata()

Gets the metadata for a level.

Returns:

metadata for the level

Compliance:

mandatory - This method must be implemented.

setLevel

void setLevel(Id gradeId)

Sets the job level.

Parameters:

gradeId - the level

Throws:

InvalidArgumentException - gradeId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearLevel

void clearLevel()

Clears the level.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getQualificationsMetadata

Metadata getQualificationsMetadata()

Gets the metadata for the qualifications.

Returns:

metadata for the qualifications

Compliance:

mandatory - This method must be implemented.

setQualifications

void setQualifications(Id[] objectivesIds)

Sets the position qualifications.

Parameters:

objectivesIds - the learning objective Ids

Throws:

InvalidArgumentException - objectiveIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - objectiveIds is null

Compliance:

mandatory - This method must be implemented.

clearQualifications

void clearQualifications()

Clears the qualifications.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTargetAppointmenstMetadata

Metadata getTargetAppointmenstMetadata()

Gets the metadata for a target appointments.

Returns:

metadata for the target appointments

Compliance:

mandatory - This method must be implemented.

setTargetAppointments

void setTargetAppointments(long appointments)

Sets the target appointments.

Parameters:

appointments - the target appointments

Throws:

InvalidArgumentException - appointments is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearTargetAppointments

void clearTargetAppointments()

Clears the target appointments.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRequiredCommitmentMetadata

Metadata getRequiredCommitmentMetadata()

Gets the metadata for a required commitment.

Returns:

metadata for the required commitment

Compliance:

mandatory - This method must be implemented.

setRequiredCommitment

void setRequiredCommitment(long commitment)

Sets the required commitment percentage (0-100).

Parameters:

commitment - the required commitment

Throws:

InvalidArgumentException - commitment is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearRequiredCommitment

void clearRequiredCommitment()

Clears the required commitment.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getLowSalaryRangeMetadata

Metadata getLowSalaryRangeMetadata()

Gets the metadata for a low salary range.

Returns:

metadata for the low salary range

Compliance:

mandatory - This method must be implemented.

setLowSalaryRange

void setLowSalaryRange(Currency salary)

Sets the low salary range.

Parameters:

salary - the low salary range

Throws:

InvalidArgumentException - salary is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - salary is null

Compliance:

mandatory - This method must be implemented.

clearLowSalaryRange

void clearLowSalaryRange()

Clears the low salary.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getMidpointSalaryRangeMetadata

Metadata getMidpointSalaryRangeMetadata()

Gets the metadata for a midpoint salary range.

Returns:

metadata for the midpoint salary range

Compliance:

mandatory - This method must be implemented.

setMidpointSalaryRange

void setMidpointSalaryRange(Currency salary)

Sets the midpoint salary range.

Parameters:

salary - the midpoint salary range

Throws:

InvalidArgumentException - salary is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - salary is null

Compliance:

mandatory - This method must be implemented.

clearMidpointSalaryRange

void clearMidpointSalaryRange()

Clears the midpoint salary.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getHighSalaryRangeMetadata

Metadata getHighSalaryRangeMetadata()

Gets the metadata for a high salary range.

Returns:

metadata for the high salary range

Compliance:

mandatory - This method must be implemented.

setHighSalaryRange

void setHighSalaryRange(Currency salary)

Sets the high salary range.

Parameters:

salary - the high salary range

Throws:

InvalidArgumentException - salary is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - salary is null

Compliance:

mandatory - This method must be implemented.

clearHighSalaryRange

void clearHighSalaryRange()

Clears the high salary.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCompensationFrequencyMetadata

Metadata getCompensationFrequencyMetadata()

Gets the metadata for a compensation frequency.

Returns:

metadata for the compensation frequency

Compliance:

mandatory - This method must be implemented.

setCompensationFrequency

void setCompensationFrequency(Duration frequency)

Sets the compensation frequency.

Parameters:

frequency - the compensation frequency

Throws:

InvalidArgumentException - frequency is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - frequency is null

Compliance:

mandatory - This method must be implemented.

clearCompensationFrequency

void clearCompensationFrequency()

Clears the compensation frequency.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getExemptMetadata

Metadata getExemptMetadata()

Gets the metadata for the exempt flag.

Returns:

metadata for the exempt flag

Compliance:

mandatory - This method must be implemented.

setExempt

void setExempt(boolean eempt)

Sets the exempt flag.

Parameters:

eempt - the exempt flag

Throws:

InvalidArgumentException - exempt is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearExempt

void clearExempt()

Clears the exempt flag.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getBenefitsTypeMetadata

Metadata getBenefitsTypeMetadata()

Gets the metadata for a benefits type.

Returns:

metadata for the benefits type

Compliance:

mandatory - This method must be implemented.

setBenefitsType

void setBenefitsType(Type type)

Sets the benefits type.

Parameters:

type - the benefits type

Throws:

InvalidArgumentException - type is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - type is null

Compliance:

mandatory - This method must be implemented.

clearBenefitsType

void clearBenefitsType()

Clears the benefits type.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getPositionFormRecord

PositionFormRecord getPositionFormRecord(Type positionRecordType)
                                         throws OperationFailedException

Gets the PositionFormRecord interface corresponding to the given position record Type.

Parameters:

positionRecordType - the position record type

Returns:

the record

Throws:

NullArgumentException - positionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(positionRecordType) is false

Compliance:

mandatory - This method must be implemented.