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.
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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, getDisabledMetadata, setDisabled
clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider
Metadata getEnabledMetadata()
getEnabledMetadata
in interface OsidOperableForm
mandatory
- This method must be implemented. void setEnabled(boolean enabled)
setEnabled
in interface OsidOperableForm
enabled
- the new enabled flagInvalidArgumentException
- enabled
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearEnabled()
clearEnabled
in interface OsidOperableForm
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getInitialStepMetadata()
mandatory
- This method must be implemented. void setInitialStep(Id stepId)
stepId
- the new initial stepInvalidArgumentException
- stepId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- stepId
is
null
mandatory
- This method must be implemented. void clearInitialStep()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getInitialStateMetadata()
mandatory
- This method must be implemented. void setInitialState(Id stateId)
stateId
- the new initial stateInvalidArgumentException
- stateId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- stateId
is
null
mandatory
- This method must be implemented. void clearInitialState()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ProcessFormRecord getProcessFormRecord(Type processRecordType) throws OperationFailedException
ProcessFormRecord
corresponding to the given
process record Type.
processRecordType
- a process record typeNullArgumentException
- processRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(processRecordType)
is false
mandatory
- This method must be implemented.