org.osid.resourcing

Interface JobForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

JobBatchForm

public interface JobForm
extends OsidGovernatorForm

This is the form for creating and updating Jobs. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the JobAdminSession. 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	clearCompetencies() Removes the competencies.
Metadata	getCompetenciesMetadata() Gets the metadata for the competencies.
JobFormRecord	getJobFormRecord(Type jobRecordType) Gets the JobFormRecord corresponding to the given job record Type.
void	setCompetencies(IdList competencyIds) Sets the competencies.

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.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getCompetenciesMetadata

Metadata getCompetenciesMetadata()

Gets the metadata for the competencies.

Returns:

metadata for the competency

Compliance:

mandatory - This method must be implemented.

setCompetencies

void setCompetencies(IdList competencyIds)

Sets the competencies.

Parameters:

competencyIds - the new competencies

Throws:

InvalidArgumentException - competencyIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - competencyId is null

Compliance:

mandatory - This method must be implemented.

clearCompetencies

void clearCompetencies()

Removes the competencies.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getJobFormRecord

JobFormRecord getJobFormRecord(Type jobRecordType)
                               throws OperationFailedException

Gets the JobFormRecord corresponding to the given job record Type.

Parameters:

jobRecordType - a job record type

Returns:

the job form record

Throws:

NullArgumentException - jobRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobRecordType) is false

Compliance:

mandatory - This method must be implemented.