org.osid.workflow

Interface ProcessForm

All Superinterfaces:

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

All Known Subinterfaces:

ProcessBatchForm

public interface ProcessForm
extends OsidGovernatorForm

This is the form for creating and updating Processes. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProcessAdminSession. 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	clearEnabled() Removes the enabled flag.
void	clearInitialState() Removes the initial state.
void	clearInitialStep() Removes the initial step.
Metadata	getEnabledMetadata() Gets the metadata for the enabled flag.
Metadata	getInitialStateMetadata() Gets the metadata for the initial state.
Metadata	getInitialStepMetadata() Gets the metadata for the initial step.
ProcessFormRecord	getProcessFormRecord(Type processRecordType) Gets the ProcessFormRecord corresponding to the given process record Type.
void	setEnabled(boolean enabled) Sets the enabled flag.
void	setInitialState(Id stateId) Sets the initial state.
void	setInitialStep(Id stepId) Sets the initial step.

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, getDisabledMetadata, setDisabled

Methods inherited from interface org.osid.OsidSourceableForm

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

Method Detail

getEnabledMetadata

Metadata getEnabledMetadata()

Gets the metadata for the enabled flag.

Specified by:

getEnabledMetadata in interface OsidOperableForm

Returns:

metadata for the enabled flag

Compliance:

mandatory - This method must be implemented.

setEnabled

void setEnabled(boolean enabled)

Sets the enabled flag.

Specified by:

setEnabled in interface OsidOperableForm

Parameters:

enabled - the new enabled flag

Throws:

InvalidArgumentException - enabled is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearEnabled

void clearEnabled()

Removes the enabled flag.

Specified by:

clearEnabled in interface OsidOperableForm

Throws:

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

Compliance:

mandatory - This method must be implemented.

getInitialStepMetadata

Metadata getInitialStepMetadata()

Gets the metadata for the initial step.

Returns:

metadata for the initial step

Compliance:

mandatory - This method must be implemented.

setInitialStep

void setInitialStep(Id stepId)

Sets the initial step.

Parameters:

stepId - the new initial step

Throws:

InvalidArgumentException - stepId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - stepId is null

Compliance:

mandatory - This method must be implemented.

clearInitialStep

void clearInitialStep()

Removes the initial step.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getInitialStateMetadata

Metadata getInitialStateMetadata()

Gets the metadata for the initial state.

Returns:

metadata for the initial state

Compliance:

mandatory - This method must be implemented.

setInitialState

void setInitialState(Id stateId)

Sets the initial state.

Parameters:

stateId - the new initial state

Throws:

InvalidArgumentException - stateId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - stateId is null

Compliance:

mandatory - This method must be implemented.

clearInitialState

void clearInitialState()

Removes the initial state.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getProcessFormRecord

ProcessFormRecord getProcessFormRecord(Type processRecordType)
                                       throws OperationFailedException

Gets the ProcessFormRecord corresponding to the given process record Type.

Parameters:

processRecordType - a process record type

Returns:

the process form record

Throws:

NullArgumentException - processRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processRecordType) is false

Compliance:

mandatory - This method must be implemented.