Interface RegistrationRequestItemForm

All Superinterfaces:

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

public interface RegistrationRequestItemForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating RegistrationRequ estItems. Like all OsidForms , various data elements may be set here for use in the create and update methods in the RegistrationRequestItemAdmi nSession. 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	clearCreditOption()	Removes the credit option.
void	clearExistingRegistration()	Removes the existing registration.
void	clearGradingOption()	Removes the grading option.
void	clearRegistrationTarget()	Removes the registration target.
void	clearStudent()	Removes the student.
Metadata	getCreditOptionMetadata()	Gets the metadata for the credit option.
Metadata	getExistingRegistrationMetadata()	Gets the metadata for the existing registration.
Metadata	getGradingOptionMetadata()	Gets the metadata for the grading option.
RegistrationRequestItemFormRecord	getRegistrationRequestItemFormRecord(Type registrationRequestItemRecordType)	Gets the RegistrationRequestItemFormRecord corresponding to the given registration request item record Type .
Metadata	getRegistrationTargetMetadata()	Gets the metadata for the registration target.
Metadata	getStudentMetadata()	Gets the metadata for the student.
void	setCreditOption(BigDecimal credits)	Sets the credit option.
void	setExistingRegistration(Id registrationId)	Sets the existing registration.
void	setGradingOption(Id gradeSystemId)	Sets the grading option.
void	setRegistrationTarget(Id registrationTargetId)	Sets the registration target.
void	setStudent(Id resourceId)	Sets the student resource.

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

getStudentMetadata

Metadata getStudentMetadata()

Gets the metadata for the student.

Returns:

metadata for the student

Compliance:

mandatory - This method must be implemented.

setStudent

void setStudent(Id resourceId)

Sets the student resource.

Parameters:

resourceId - the new student

Throws:

InvalidArgumentException - resourceiId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearStudent

void clearStudent()

Removes the student.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getRegistrationTargetMetadata

Metadata getRegistrationTargetMetadata()

Gets the metadata for the registration target.

Returns:

metadata for the registration target

Compliance:

mandatory - This method must be implemented.

setRegistrationTarget

void setRegistrationTarget(Id registrationTargetId)

Sets the registration target.

Parameters:

registrationTargetId - the new student

Throws:

InvalidArgumentException - registrationTargetId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - registrationTargetId is null

Compliance:

mandatory - This method must be implemented.

clearRegistrationTarget

void clearRegistrationTarget()

Removes the registration target.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getExistingRegistrationMetadata

Metadata getExistingRegistrationMetadata()

Gets the metadata for the existing registration.

Returns:

metadata for the existing registration

Compliance:

mandatory - This method must be implemented.

setExistingRegistration

void setExistingRegistration(Id registrationId)

Sets the existing registration.

Parameters:

registrationId - the new existing registration

Throws:

InvalidArgumentException - registrationId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - registrationId is null

Compliance:

mandatory - This method must be implemented.

clearExistingRegistration

void clearExistingRegistration()

Removes the existing registration.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCreditOptionMetadata

Metadata getCreditOptionMetadata()

Gets the metadata for the credit option.

Returns:

metadata for the credit option

Compliance:

mandatory - This method must be implemented.

setCreditOption

void setCreditOption(BigDecimal credits)

Sets the credit option.

Parameters:

credits - the new credit option

Throws:

InvalidArgumentException - credits is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearCreditOption

void clearCreditOption()

Removes the credit option.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getGradingOptionMetadata

Metadata getGradingOptionMetadata()

Gets the metadata for the grading option.

Returns:

metadata for the grading option

Compliance:

mandatory - This method must be implemented.

setGradingOption

void setGradingOption(Id gradeSystemId)

Sets the grading option.

Parameters:

gradeSystemId - the new grading option

Throws:

InvalidArgumentException - gradeSystemId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearGradingOption

void clearGradingOption()

Removes the grading option.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getRegistrationRequestItemFormRecord

RegistrationRequestItemFormRecord getRegistrationRequestItemFormRecord(Type registrationRequestItemRecordType)
                                                                throws OperationFailedException

Gets the RegistrationRequestItemFormRecord corresponding to the given registration request item record Type .

Parameters:

registrationRequestItemRecordType - a registration request item record type

Returns:

the registration request item form record

Throws:

NullArgumentException - registrationRequestItemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRequestItemRecordType) is false

Compliance:

mandatory - This method must be implemented.