Interface RegistrationRequestForm

All Superinterfaces:

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

public interface RegistrationRequestForm
extends OsidRequestForm

This is the form for creating and updating RegistrationRequ ests. Like all OsidForms , various data elements may be set here for use in the create and update methods in the RegistrationRequestAdminSes sion. 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
RegistrationRequestFormRecord	getRegistrationRequestFormRecord(Type registrationRequestRecordType)	Gets the RegistrationRequestFormRecord corresponding to the given registration request record Type .

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 OsidRequestForm

clearCanceled, clearCanceledDate, clearErrorState, clearPostingDate, clearProcessed, clearProcessedDate, clearRequester, clearSubmittedDate, clearSubmitter, clearSubmittingAgent, getCanceledDateMetadata, getCanceledMetadata, getErrorMetadata, getPostingDateMetadata, getProcessedDateMetadata, getProcessedMetadata, getRequesterMetadata, getSubmittedDateMetadata, getSubmitterMetadata, getSubmittingAgentMetadata, setCanceled, setCanceledDate, setError, setPostingDate, setProcessed, setProcessedDate, setRequester, setSubmittedDate, setSubmitter, setSubmittingAgent

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.

Method Details

getRegistrationRequestFormRecord

RegistrationRequestFormRecord getRegistrationRequestFormRecord(Type registrationRequestRecordType)
                                                        throws OperationFailedException

Gets the RegistrationRequestFormRecord corresponding to the given registration request record Type .

Parameters:

registrationRequestRecordType - a registration request record type

Returns:

the registration request form record

Throws:

NullArgumentException - registrationRequestRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRequestRecordType) is false

Compliance:

mandatory - This method must be implemented.