Interface ProcessForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

ProcessBatchForm

public interface ProcessForm
extends OsidGovernatorForm

This is the form for creating and updating Processes. Like all OsidForms, 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.

Method Summary

Modifier and Type	Method	Description
void	clearEnabled()	Removes the enabled flag.
void	clearInitialState()	Removes the initial state.
void	clearInitialStep()	Removes the initial step.
void	clearOwners()	Removes the owners.
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.
Metadata	getOwnersMetadata()	Gets the metadata for the owners.
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.
void	setOwners(IdList ownerIds)	Sets the owners.

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, getDisabledMetadata, setDisabled

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

Methods inherited from interface OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Modifier and Type	Method	Description
void	clearBranding()	Removes the branding.
void	clearLicense()	Removes the license.
void	clearProvider()	Removes the provider.
Metadata	getBrandingMetadata()	Gets the metadata for the asset branding.
Metadata	getLicenseMetadata()	Gets the metadata for the license.
Metadata	getProviderMetadata()	Gets the metadata for a provider.
void	setBranding(Id[] assetIds)	Sets the branding.
void	setLicense(String license)	Sets the license.
void	setProvider(Id providerId)	Sets a provider.

Method Details

getOwnersMetadata

Metadata getOwnersMetadata()

Gets the metadata for the owners.

Returns:

metadata for the owners

Compliance:

mandatory - This method must be implemented.

setOwners

void setOwners(IdList ownerIds)

Sets the owners.

Parameters:

ownerIds - the new owners

Throws:

InvalidArgumentException - ownerIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - ownerIds is null

Compliance:

mandatory - This method must be implemented.

clearOwners

void clearOwners()

Removes the owners.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getEnabledMetadata

Metadata getEnabledMetadata()

Gets the metadata for the enabled flag.

Specified by:

getEnabledMetadata in interface OsidOperableForm

Returns:

metadata for the enabled flag

Compliance:

mandatory - This method must be implemented.

setEnabled

void setEnabled(boolean enabled)

Sets the enabled flag.

Specified by:

setEnabled in interface OsidOperableForm

Parameters:

enabled - the new enabled flag

Throws:

InvalidArgumentException - enabled is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearEnabled

void clearEnabled()

Removes the enabled flag.

Specified by:

clearEnabled in interface OsidOperableForm

Throws:

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

Compliance:

mandatory - This method must be implemented.

getInitialStepMetadata

Metadata getInitialStepMetadata()

Gets the metadata for the initial step.

Returns:

metadata for the initial step

Compliance:

mandatory - This method must be implemented.

setInitialStep

void setInitialStep(Id stepId)

Sets the initial step.

Parameters:

stepId - the new initial step

Throws:

InvalidArgumentException - stepId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - stepId is null

Compliance:

mandatory - This method must be implemented.

clearInitialStep

void clearInitialStep()

Removes the initial step.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getInitialStateMetadata

Metadata getInitialStateMetadata()

Gets the metadata for the initial state.

Returns:

metadata for the initial state

Compliance:

mandatory - This method must be implemented.

setInitialState

void setInitialState(Id stateId)

Sets the initial state.

Parameters:

stateId - the new initial state

Throws:

InvalidArgumentException - stateId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - stateId is null

Compliance:

mandatory - This method must be implemented.

clearInitialState

void clearInitialState()

Removes the initial state.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getProcessFormRecord

ProcessFormRecord getProcessFormRecord(Type processRecordType)
                                throws OperationFailedException

Gets the ProcessFormRecord corresponding to the given process record Type.

Parameters:

processRecordType - a process record type

Returns:

the process form record

Throws:

NullArgumentException - processRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processRecordType) is false

Compliance:

mandatory - This method must be implemented.