Interface ActionForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:

ActionBatchForm

public interface ActionForm
extends OsidRuleForm, OsidSubjugateableForm

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.

Method Summary

Modifier and Type	Method	Description
void	clearBlocking()	Removes the blocking flag.
void	clearDelay()	Removes the delay.
void	clearNextActionGroup()	Removes the next action group.
void	clearScene()	Removes the scene.
void	clearSetting()	Removes the setting.
ActionFormRecord	getActionFormRecord(Type actionRecordType)	Gets the ActionFormRecord corresponding to the given action record Type .
Metadata	getBlockingMetadata()	Gets the metadata for the blocking flag.
Metadata	getDelayMetadata()	Gets the metadata for the delay.
Metadata	getNextActionGroupMetadata()	Gets the metadata for the action group to be executed.
Metadata	getSceneMetadata()	Gets the metadata for the scene.
Metadata	getSettingMetadata()	Gets the metadata for the setting.
void	setBlocking(boolean blocking)	Sets the blocking flag.
void	setDelay(Duration delay)	Sets the delay.
void	setNextActionGroup(Id actionGroupId)	Sets the next action group.
void	setScene(Id sceneId)	Sets the scene.
void	setSetting(Id settingId)	Sets the setting.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

getDelayMetadata

Metadata getDelayMetadata()

Gets the metadata for the delay.

Returns:

metadata for the delay

Compliance:

mandatory - This method must be implemented.

setDelay

void setDelay(Duration delay)

Sets the delay.

Parameters:

delay - the new delay

Throws:

InvalidArgumentException - delay is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - delay is null

Compliance:

mandatory - This method must be implemented.

clearDelay

void clearDelay()

Removes the delay.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getBlockingMetadata

Metadata getBlockingMetadata()

Gets the metadata for the blocking flag.

Returns:

metadata for the blocking flag

Compliance:

mandatory - This method must be implemented.

setBlocking

void setBlocking(boolean blocking)

Sets the blocking flag.

Parameters:

blocking - true if blocking, false if unblocking

Throws:

InvalidArgumentException - blocking is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearBlocking

void clearBlocking()

Removes the blocking flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getNextActionGroupMetadata

Metadata getNextActionGroupMetadata()

Gets the metadata for the action group to be executed.

Returns:

metadata for the action group

Compliance:

mandatory - This method must be implemented.

setNextActionGroup

void setNextActionGroup(Id actionGroupId)

Sets the next action group.

Parameters:

actionGroupId - the new action group

Throws:

InvalidArgumentException - actionGroupId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - actionGroupId is null

Compliance:

mandatory - This method must be implemented.

clearNextActionGroup

void clearNextActionGroup()

Removes the next action group.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getSceneMetadata

Metadata getSceneMetadata()

Gets the metadata for the scene.

Returns:

metadata for the scene

Compliance:

mandatory - This method must be implemented.

setScene

void setScene(Id sceneId)

Sets the scene.

Parameters:

sceneId - the new scene

Throws:

InvalidArgumentException - sceneId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - sceneId is null

Compliance:

mandatory - This method must be implemented.

clearScene

void clearScene()

Removes the scene.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getSettingMetadata

Metadata getSettingMetadata()

Gets the metadata for the setting.

Returns:

metadata for the setting

Compliance:

mandatory - This method must be implemented.

setSetting

void setSetting(Id settingId)

Sets the setting.

Parameters:

settingId - the new setting

Throws:

InvalidArgumentException - settingId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - settingId is null

Compliance:

mandatory - This method must be implemented.

clearSetting

void clearSetting()

Removes the setting.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getActionFormRecord

ActionFormRecord getActionFormRecord(Type actionRecordType)
                              throws OperationFailedException

Gets the ActionFormRecord corresponding to the given action record Type .

Parameters:

actionRecordType - an action record type

Returns:

the action form record

Throws:

NullArgumentException - actionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionRecordType) is false

Compliance:

mandatory - This method must be implemented.