Interface PlanForm

All Superinterfaces:

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

public interface PlanForm
extends OsidRelationshipForm

This is the form for creating and updating Plans . Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PlanAdminSession . 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	clearModules()	Clears the modules.
Metadata	getModulesMetadata()	Gets the metadata for the modules.
PlanFormRecord	getPlanFormRecord(Type planRecordType)	Gets the PlanFormRecord corresponding to the given plan record Type .
void	setModules(IdList moduleIds)	Sets the modules to which this plan applies.

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

getModulesMetadata

Metadata getModulesMetadata()

Gets the metadata for the modules.

Returns:

metadata for the modules

Compliance:

mandatory - This method must be implemented.

setModules

void setModules(IdList moduleIds)

Sets the modules to which this plan applies.

Parameters:

moduleIds - the new modules

Throws:

InvalidArgumentException - moduleIds is invalid

NoAccessException - moduleIds cannot be modified

NullArgumentException - moduleIds is null

Compliance:

mandatory - This method must be implemented.

clearModules

void clearModules()

Clears the modules.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getPlanFormRecord

PlanFormRecord getPlanFormRecord(Type planRecordType)
                          throws OperationFailedException

Gets the PlanFormRecord corresponding to the given plan record Type .

Parameters:

planRecordType - the plan record type

Returns:

the plan form record

Throws:

NullArgumentException - planRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(planRecordType) is false

Compliance:

mandatory - This method must be implemented.