OSID - osid.workflow.StepForm Service Interface Definition

Interface	osid.workflow.StepForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.workflow.batch.StepBatchForm`
Used By	`osid.workflow.StepAdminSession`
Description	This is the form for creating and updating `Steps` . Like all `OsidForms` , various data elements may be set here for use in the create and update methods in the `StepAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getInputStatesMetadata
Description	Gets the metadata for the input states.
Return	`osid.Metadata`		metadata for the states
Compliance	`mandatory`		This method must be implemented.
Method	seInputStates
Description	Sets the input states.
Parameters	`osid.id.IdList`	`stateIds`	the new input states
Errors	INVALID_ARGUMENT		`stateId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`stateId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInputStates
Description	Removes the input states.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getNextStateMetadata
Description	Gets the metadata for the next state.
Return	`osid.Metadata`		metadata for the state
Compliance	`mandatory`		This method must be implemented.
Method	setNextState
Description	Sets the next state.
Parameters	`osid.id.Id`	`stateId`	the new next state
Errors	INVALID_ARGUMENT		`stateId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`stateId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearNextState
Description	Removes the next state.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getStepFormRecord
Description	Gets the `StepFormRecord` corresponding to the given step record `Type` .
Parameters	`osid.type.Type`	`stepRecordType`	a step record type
Return	`osid.workflow.records.StepFormRecord`		the step form record
Errors	NULL_ARGUMENT		`stepRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(stepRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.