org.osid.resourcing

Interface WorkForm

All Superinterfaces:

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

All Known Subinterfaces:

WorkBatchForm

public interface WorkForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating Works. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the WorkAdminSession. 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.
WorkFormRecord	getWorkFormRecord(Type workRecordType) Gets the WorkFormRecord corresponding to the given work record Type.
void	setCompetencies(IdList competencyIds) Sets specific competencies required for this work.

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

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 specific competencies required for this work.

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.

getWorkFormRecord

WorkFormRecord getWorkFormRecord(Type workRecordType)
                                 throws OperationFailedException

Gets the WorkFormRecord corresponding to the given work record Type.

Parameters:

workRecordType - a work record type

Returns:

the work form record

Throws:

NullArgumentException - workRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workRecordType) is false

Compliance:

mandatory - This method must be implemented.