OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.ActionForm
Implementsosid.OsidRuleForm
osid.OsidSubjugateableForm
Description

This is the form for creating and updating actions. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ActionGroupAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetDelayMetadata
Description

Gets the metadata for the delay.

Returnosid.Metadatametadata for the delay
CompliancemandatoryThis method must be implemented.
MethodsetDelay
Description

Sets the delay.

Parametersosid.calendaring.Durationdelaythe new delay
ErrorsINVALID_ARGUMENT delay is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT delay is null
CompliancemandatoryThis method must be implemented.
MethodclearDelay
Description

Removes the delay.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetBlockingMetadata
Description

Gets the metadata for the blocking flag.

Returnosid.Metadatametadata for the blocking flag
CompliancemandatoryThis method must be implemented.
MethodsetBlocking
Description

Sets the blocking flag.

Parametersbooleanblocking true if blocking, false if unblocking
ErrorsINVALID_ARGUMENT blocking is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearBlocking
Description

Removes the blocking flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetNextActionGroupMetadata
Description

Gets the metadata for the action group to be executed.

Returnosid.Metadatametadata for the action group
CompliancemandatoryThis method must be implemented.
MethodsetNextActionGroup
Description

Sets the next action group.

Parametersosid.id.IdactionGroupIdthe new action group
ErrorsINVALID_ARGUMENT actionGroupId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT actionGroupId is null
CompliancemandatoryThis method must be implemented.
MethodclearNextActionGroup
Description

Removes the next action group.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetSceneMetadata
Description

Gets the metadata for the scene.

Returnosid.Metadatametadata for the scene
CompliancemandatoryThis method must be implemented.
MethodsetScene
Description

Sets the scene.

Parametersosid.id.IdsceneIdthe new scene
ErrorsINVALID_ARGUMENT sceneId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT sceneId is null
CompliancemandatoryThis method must be implemented.
MethodclearScene
Description

Removes the scene.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetSettingMetadata
Description

Gets the metadata for the setting.

Returnosid.Metadatametadata for the setting
CompliancemandatoryThis method must be implemented.
MethodsetSetting
Description

Sets the setting.

Parametersosid.id.IdsettingIdthe new setting
ErrorsINVALID_ARGUMENT settingId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT settingId is null
CompliancemandatoryThis method must be implemented.
MethodclearSetting
Description

Removes the setting.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetActionFormRecord
Description

Gets the ActionFormRecord corresponding to the given action record Type.

Parametersosid.type.TypeactionRecordTypean action record type
Returnosid.control.records.ActionFormRecordthe action form record
ErrorsNULL_ARGUMENT actionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(actionRecordType) is false
CompliancemandatoryThis method must be implemented.