Interface PositionBatchForm

All Superinterfaces:

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

public interface PositionBatchForm
extends PositionForm

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

Method Summary

Modifier and Type	Method	Description
Id	getOrganizationId()	Gets the Organization Id of the position if this is a create transaction.
Id	getPositionId()	Gets the Id of the position to be updated if this is an update transaction.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Methods inherited from interface PositionForm

clearBenefitsType, clearCompensationFrequency, clearExempt, clearHighSalaryRange, clearLevel, clearLowSalaryRange, clearMidpointSalaryRange, clearQualifications, clearRequiredCommitment, clearTargetAppointments, clearTitle, getBenefitsTypeMetadata, getCompensationFrequencyMetadata, getExemptMetadata, getHighSalaryRangeMetadata, getLevelMetadata, getLowSalaryRangeMetadata, getMidpointSalaryRangeMetadata, getPositionFormRecord, getQualificationsMetadata, getRequiredCommitmentMetadata, getTargetAppointmentsMetadata, getTitleMetadata, setBenefitsType, setCompensationFrequency, setExempt, setHighSalaryRange, setLevel, setLowSalaryRange, setMidpointSalaryRange, setQualifications, setRequiredCommitment, setTargetAppointments, setTitle

Modifier and Type	Method	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	getTargetAppointmentsMetadata()	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 exempt)	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(String title)	Sets the title.

Method Details

getOrganizationId

Id getOrganizationId()

Gets the Organization Id of the position if this is a create transaction.

Returns:

the organization Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getPositionId

Id getPositionId()

Gets the Id of the position to be updated if this is an update transaction.

Returns:

the position Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.