Interface WorkflowEventForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

public interface WorkflowEventForm
extends OsidObjectForm

This is the form for creating and updating WorkflowEvents. Like all OsidForms, various data elements may be set here for use in the create and update methods in the WorkflowEventAdminSession. 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	cleaCanceled()	Clears the canceled flag.
void	clearProcess()	Clears the process.
void	clearTimestamp()	Clears the timestamp.
void	clearWork()	Clears the work.
void	clearWorker()	Clears the worker.
void	clearWorkingAgent()	Clears the working agent.
void	cleaStep()	Clears the step.
Metadata	getCanceledMetadata()	Gets the metadata for a canceled.
Metadata	getProcessMetadata()	Gets the metadata for a process.
Metadata	getStepMetadata()	Gets the metadata for a step.
Metadata	getTimestampMetadata()	Gets the metadata for a timestamp.
Metadata	getWorkerMetadata()	Gets the metadata for a worker.
WorkflowEventFormRecord	getWorkflowEventFormRecord(Type workflowEventRecordType)	Gets the WorkflowEventFormRecord corresponding to the given workflow event record Type.
Metadata	getWorkingAgentMetadata()	Gets the metadata for a working agent.
Metadata	getWorkMetadata()	Gets the metadata for a work.
void	setCanceled(boolean canceled)	Sets the canceled flag.
void	setProcess(Id processId)	Sets the process.
void	setStep(Id stepId)	Sets the step.
void	setTimestamp(DateTime date)	Sets the timestamp.
void	setWork(Id workId)	Sets the work.
void	setWorker(Id resourceId)	Sets the resource.
void	setWorkingAgent(Id agentId)	Sets the agent.

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.

Method Details

getTimestampMetadata

Metadata getTimestampMetadata()

Gets the metadata for a timestamp.

Returns:

metadata for the date

Compliance:

mandatory - This method must be implemented.

setTimestamp

void setTimestamp(DateTime date)

Sets the timestamp.

Parameters:

date - the new timestamp

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearTimestamp

void clearTimestamp()

Clears the timestamp.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getProcessMetadata

Metadata getProcessMetadata()

Gets the metadata for a process.

Returns:

metadata for the process

Compliance:

mandatory - This method must be implemented.

setProcess

void setProcess(Id processId)

Sets the process.

Parameters:

processId - the new process

Throws:

InvalidArgumentException - processId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - processId is null

Compliance:

mandatory - This method must be implemented.

clearProcess

void clearProcess()

Clears the process.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getWorkerMetadata

Metadata getWorkerMetadata()

Gets the metadata for a worker.

Returns:

metadata for the worker

Compliance:

mandatory - This method must be implemented.

setWorker

void setWorker(Id resourceId)

Sets the resource.

Parameters:

resourceId - the new worker resource

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearWorker

void clearWorker()

Clears the worker.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getWorkingAgentMetadata

Metadata getWorkingAgentMetadata()

Gets the metadata for a working agent.

Returns:

metadata for the worker

Compliance:

mandatory - This method must be implemented.

setWorkingAgent

void setWorkingAgent(Id agentId)

Sets the agent.

Parameters:

agentId - the new working agent

Throws:

InvalidArgumentException - agentId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearWorkingAgent

void clearWorkingAgent()

Clears the working agent.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getWorkMetadata

Metadata getWorkMetadata()

Gets the metadata for a work.

Returns:

metadata for the work

Compliance:

mandatory - This method must be implemented.

setWork

void setWork(Id workId)

Sets the work.

Parameters:

workId - the new work

Throws:

InvalidArgumentException - workId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - workId is null

Compliance:

mandatory - This method must be implemented.

clearWork

void clearWork()

Clears the work.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCanceledMetadata

Metadata getCanceledMetadata()

Gets the metadata for a canceled.

Returns:

metadata for the canceled

Compliance:

mandatory - This method must be implemented.

setCanceled

void setCanceled(boolean canceled)

Sets the canceled flag.

Parameters:

canceled - the new canceled flag

Throws:

InvalidArgumentException - canceled is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

cleaCanceled

void cleaCanceled()

Clears the canceled flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getStepMetadata

Metadata getStepMetadata()

Gets the metadata for a step.

Returns:

metadata for the step

Compliance:

mandatory - This method must be implemented.

setStep

void setStep(Id stepId)

Sets the step.

Parameters:

stepId - the new step

Throws:

InvalidArgumentException - stepId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - stepId is null

Compliance:

mandatory - This method must be implemented.

cleaStep

void cleaStep()

Clears the step.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getWorkflowEventFormRecord

WorkflowEventFormRecord getWorkflowEventFormRecord(Type workflowEventRecordType)
                                            throws OperationFailedException

Gets the WorkflowEventFormRecord corresponding to the given workflow event record Type.

Parameters:

workflowEventRecordType - a workflow event record type

Returns:

the workflow event form record

Throws:

NullArgumentException - workflowEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workflowEventRecordType) is false

Compliance:

mandatory - This method must be implemented.