Interface OsidRequestForm

All Superinterfaces:

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

All Known Subinterfaces:

RegistrationRequestForm

public interface OsidRequestForm
extends OsidObjectForm

This form is used to create and update rules.

Method Summary

Modifier and Type	Method	Description
void	clearCanceled()	Removes canceled.
void	clearCanceledDate()	Removes the canceled date.
void	clearErrorState()	Removes the error state.
void	clearPostingDate()	Removes the posting date.
void	clearProcessed()	Removes processed.
void	clearProcessedDate()	Removes the processed date.
void	clearRequester()	Removes the requester.
void	clearSubmittedDate()	Removes the submitted date.
void	clearSubmitter()	Removes the submitter.
void	clearSubmittingAgent()	Removes the submitting agent.
Metadata	getCanceledDateMetadata()	Gets the metadata for the canceled date.
Metadata	getCanceledMetadata()	Gets the metadata for the cancelation.
Metadata	getErrorMetadata()	Gets the metadata for the error state.
Metadata	getPostingDateMetadata()	Gets the metadata for the posting date.
Metadata	getProcessedDateMetadata()	Gets the metadata for the processed date.
Metadata	getProcessedMetadata()	Gets the metadata for the processed flag.
Metadata	getRequesterMetadata()	Gets the metadata for the requester.
Metadata	getSubmittedDateMetadata()	Gets the metadata for the submitted date.
Metadata	getSubmitterMetadata()	Gets the metadata for the submitter.
Metadata	getSubmittingAgentMetadata()	Gets the metadata for the submitting agent.
void	setCanceled(boolean canceled)	Sets canceled.
void	setCanceledDate(DateTime date)	Sets the canceled date.
void	setError(Id stateId)	Sets the error state.
void	setPostingDate(DateTime date)	Sets the posting date.
void	setProcessed(boolean processed)	Sets processed.
void	setProcessedDate(DateTime date)	Sets the processed date.
void	setRequester(Id resourceId)	Sets the requester.
void	setSubmittedDate(DateTime date)	Sets the submitted date.
void	setSubmitter(Id resourceId)	Sets the submitter.
void	setSubmittingAgent(Id agentId)	Sets the submitting 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

getPostingDateMetadata

Metadata getPostingDateMetadata()

Gets the metadata for the posting date.

Returns:

metadata for the posting date

Compliance:

mandatory - This method must be implemented.

setPostingDate

void setPostingDate(DateTime date)

Sets the posting date.

Parameters:

date - the new posting date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearPostingDate

void clearPostingDate()

Removes the posting date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getRequesterMetadata

Metadata getRequesterMetadata()

Gets the metadata for the requester.

Returns:

metadata for the requester.

Compliance:

mandatory - This method must be implemented.

setRequester

void setRequester(Id resourceId)

Sets the requester.

Parameters:

resourceId - the new requester

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearRequester

void clearRequester()

Removes the requester.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getSubmittedDateMetadata

Metadata getSubmittedDateMetadata()

Gets the metadata for the submitted date.

Returns:

metadata for the submitted date

Compliance:

mandatory - This method must be implemented.

setSubmittedDate

void setSubmittedDate(DateTime date)

Sets the submitted date.

Parameters:

date - the new submitted date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearSubmittedDate

void clearSubmittedDate()

Removes the submitted date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getSubmitterMetadata

Metadata getSubmitterMetadata()

Gets the metadata for the submitter.

Returns:

metadata for the submitter

Compliance:

mandatory - This method must be implemented.

setSubmitter

void setSubmitter(Id resourceId)

Sets the submitter.

Parameters:

resourceId - the new submitter

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearSubmitter

void clearSubmitter()

Removes the submitter.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getSubmittingAgentMetadata

Metadata getSubmittingAgentMetadata()

Gets the metadata for the submitting agent.

Returns:

metadata for the submitting agent.

Compliance:

mandatory - This method must be implemented.

setSubmittingAgent

void setSubmittingAgent(Id agentId)

Sets the submitting agent.

Parameters:

agentId - the new submitting agent

Throws:

InvalidArgumentException - agentId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearSubmittingAgent

void clearSubmittingAgent()

Removes the submitting agent.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCanceledMetadata

Metadata getCanceledMetadata()

Gets the metadata for the cancelation.

Returns:

metadata for the cancelation

Compliance:

mandatory - This method must be implemented.

setCanceled

void setCanceled(boolean canceled)

Sets canceled.

Parameters:

canceled - the new canceled state

Throws:

InvalidArgumentException - canceled is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearCanceled

void clearCanceled()

Removes canceled.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCanceledDateMetadata

Metadata getCanceledDateMetadata()

Gets the metadata for the canceled date.

Returns:

metadata for the canceled date

Compliance:

mandatory - This method must be implemented.

setCanceledDate

void setCanceledDate(DateTime date)

Sets the canceled date.

Parameters:

date - the new canceled date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearCanceledDate

void clearCanceledDate()

Removes the canceled date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getProcessedMetadata

Metadata getProcessedMetadata()

Gets the metadata for the processed flag.

Returns:

metadata for processed

Compliance:

mandatory - This method must be implemented.

setProcessed

void setProcessed(boolean processed)

Sets processed.

Parameters:

processed - the new processed state

Throws:

InvalidArgumentException - processed is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearProcessed

void clearProcessed()

Removes processed.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getProcessedDateMetadata

Metadata getProcessedDateMetadata()

Gets the metadata for the processed date.

Returns:

metadata for the processed date

Compliance:

mandatory - This method must be implemented.

setProcessedDate

void setProcessedDate(DateTime date)

Sets the processed date.

Parameters:

date - the new processed date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearProcessedDate

void clearProcessedDate()

Removes the processed date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getErrorMetadata

Metadata getErrorMetadata()

Gets the metadata for the error state.

Returns:

metadata for the error state

Compliance:

mandatory - This method must be implemented.

setError

void setError(Id stateId)

Sets the error state.

Parameters:

stateId - the new error state

Throws:

InvalidArgumentException - stateId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - stateId is null

Compliance:

mandatory - This method must be implemented.

clearErrorState

void clearErrorState()

Removes the error state.

Throws:

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

Compliance:

mandatory - This method must be implemented.