Interface | osid.control.ActionForm | ||
---|---|---|---|
Implements | osid.OsidRuleForm | ||
osid.OsidSubjugateableForm | |||
Description |
This is the form for creating and updating actions. | ||
Method | getDelayMetadata | ||
Description |
Gets the metadata for the delay. | ||
Return | osid.Metadata | metadata for the delay | |
Compliance | mandatory | This method must be implemented. | |
Method | setDelay | ||
Description |
Sets the delay. | ||
Parameters | osid.calendaring.Duration | delay | the new delay |
Errors | INVALID_ARGUMENT | delay is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | delay is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearDelay | ||
Description |
Removes the delay. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlockingMetadata | ||
Description |
Gets the metadata for the blocking flag. | ||
Return | osid.Metadata | metadata for the blocking flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setBlocking | ||
Description |
Sets the blocking flag. | ||
Parameters | boolean | blocking | true if blocking, false if unblocking |
Errors | INVALID_ARGUMENT | blocking is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearBlocking | ||
Description |
Removes the blocking flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getNextActionGroupMetadata | ||
Description |
Gets the metadata for the action group to be executed. | ||
Return | osid.Metadata | metadata for the action group | |
Compliance | mandatory | This method must be implemented. | |
Method | setNextActionGroup | ||
Description |
Sets the next action group. | ||
Parameters | osid.id.Id | actionGroupId | the new action group |
Errors | INVALID_ARGUMENT | actionGroupId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | actionGroupId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearNextActionGroup | ||
Description |
Removes the next action group. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getSceneMetadata | ||
Description |
Gets the metadata for the scene. | ||
Return | osid.Metadata | metadata for the scene | |
Compliance | mandatory | This method must be implemented. | |
Method | setScene | ||
Description |
Sets the scene. | ||
Parameters | osid.id.Id | sceneId | the new scene |
Errors | INVALID_ARGUMENT | sceneId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | sceneId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearScene | ||
Description |
Removes the scene. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getSettingMetadata | ||
Description |
Gets the metadata for the setting. | ||
Return | osid.Metadata | metadata for the setting | |
Compliance | mandatory | This method must be implemented. | |
Method | setSetting | ||
Description |
Sets the setting. | ||
Parameters | osid.id.Id | settingId | the new setting |
Errors | INVALID_ARGUMENT | settingId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | settingId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSetting | ||
Description |
Removes the setting. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | actionRecordType | an action record type |
Return | osid.control.records.ActionFormRecord | the action form record | |
Errors | NULL_ARGUMENT | actionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(actionRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |