public interface PlanForm extends OsidRelationshipForm
This is the form for creating and updating Plan
objects.
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.
Modifier and Type | Method and 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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getModulesMetadata()
mandatory
- This method must be implemented. void setModules(IdList moduleIds)
moduleIds
- the new modulesInvalidArgumentException
- moduleIds
is
invalidNoAccessException
- moduleIds
cannot be
modifiedNullArgumentException
- moduleIds
is
null
mandatory
- This method must be implemented. void clearModules()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. PlanFormRecord getPlanFormRecord(Type planRecordType) throws OperationFailedException
PlanFormRecord
corresponding to the given plan
record Type.
planRecordType
- the plan record typeNullArgumentException
- planRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(planRecordType)
is false
mandatory
- This method must be implemented.