Interface OfferingForm

All Superinterfaces:

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

All Known Subinterfaces:

OfferingBatchForm

public interface OfferingForm
extends OsidRelationshipForm

This is the form for creating and updating Offerings . Like all OsidForms , various data elements may be set here for use in the create and update methods in the OfferingAdminSession . 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	clearCode()	Clears the code.
void	clearResultOptions()	Removes the grading options.
void	clearSponsors()	Removes the sponsors.
void	clearTitle()	Clears the title.
Metadata	getCodeMetadata()	Gets the metadata for a given name.
OfferingFormRecord	getOfferingFormRecord(Type offeringRecordType)	Gets the OfferingFormRecord interface corresponding to the given offering record Type .
Metadata	getResultOptionsMetadata()	Gets the metadata for the grading options.
Metadata	getSponsorsMetadata()	Gets the metadata for the sponsors.
Metadata	getTitleMetadata()	Gets the metadata for a title.
void	setCode(String code)	Sets the code.
void	setResultOptions(Id[] gradeSystemIds)	Sets the grading options.
void	setSponsors(Id[] sponsorIds)	Sets the sponsors.
void	setTitle(String title)	Sets the title.

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 OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Modifier and Type	Method	Description
void	clearEndReason()	Removes the end reason.
Metadata	getEndReasonMetadata()	Gets the metadata for the end reason.
void	setEndReason(Id stateId)	Sets the end reason.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getTitleMetadata

Metadata getTitleMetadata()

Gets the metadata for a title.

Returns:

metadata for the title

Compliance:

mandatory - This method must be implemented.

setTitle

void setTitle(String title)

Sets the title.

Parameters:

title - the title

Throws:

InvalidArgumentException - title is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - title is null

Compliance:

mandatory - This method must be implemented.

clearTitle

void clearTitle()

Clears the title.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCodeMetadata

Metadata getCodeMetadata()

Gets the metadata for a given name.

Returns:

metadata for the given name

Compliance:

mandatory - This method must be implemented.

setCode

void setCode(String code)

Sets the code.

Parameters:

code - the code

Throws:

InvalidArgumentException - code is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - code is null

Compliance:

mandatory - This method must be implemented.

clearCode

void clearCode()

Clears the code.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getResultOptionsMetadata

Metadata getResultOptionsMetadata()

Gets the metadata for the grading options.

Returns:

metadata for the prerequisite information

Compliance:

mandatory - This method must be implemented.

setResultOptions

void setResultOptions(Id[] gradeSystemIds)

Sets the grading options.

Parameters:

gradeSystemIds - the new grading options

Throws:

InvalidArgumentException - gradeSystemIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeSystemIds is null

Compliance:

mandatory - This method must be implemented.

clearResultOptions

void clearResultOptions()

Removes the grading options.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getSponsorsMetadata

Metadata getSponsorsMetadata()

Gets the metadata for the sponsors.

Returns:

metadata for the sponsors

Compliance:

mandatory - This method must be implemented.

setSponsors

void setSponsors(Id[] sponsorIds)

Sets the sponsors.

Parameters:

sponsorIds - the new sponsors

Throws:

InvalidArgumentException - sponsorIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - sponsorIds is null

Compliance:

mandatory - This method must be implemented.

clearSponsors

void clearSponsors()

Removes the sponsors.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getOfferingFormRecord

OfferingFormRecord getOfferingFormRecord(Type offeringRecordType)
                                  throws OperationFailedException

Gets the OfferingFormRecord interface corresponding to the given offering record Type .

Parameters:

offeringRecordType - the offering record type

Returns:

the record

Throws:

NullArgumentException - offeringRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offeringRecordType) is false

Compliance:

mandatory - This method must be implemented.