public interface CanonicalUnitForm extends OsidObjectForm, OsidOperableForm
This is the form for creating and updating CanonicalUnit
objects. Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
CanonicalUnitAdminSession.
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 |
clearCode()
Clears the code.
|
void |
clearOfferedCyclicTimePeriods()
Clears the cyclic time periods.
|
void |
clearResultOptions()
Removes the grading options.
|
void |
clearSponsors()
Removes the sponsors.
|
void |
clearTitle()
Clears the title.
|
CanonicalUnitFormRecord |
getCanonicalUnitFormRecord(Type canonicalUnitRecordType)
Gets the
CanonicalUnitFormRecord interface
corresponding to the given canonical unit record Type. |
Metadata |
getCodeMetadata()
Gets the metadata for a given name.
|
Metadata |
getOfferedCyclicTimePeriodsMetadata()
Gets the metadata for a the cyclic time periods.
|
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(java.lang.String code)
Sets the code.
|
void |
setOfferedCyclicTimePeriods(Id[] cyclicTimePeriodIds)
Sets the cyclic time periods.
|
void |
setResultOptions(Id[] gradeSystemIds)
Sets the grading options.
|
void |
setSponsors(Id[] sponsorIds)
Sets the sponsors.
|
void |
setTitle(java.lang.String title)
Sets the title.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getTitleMetadata()
mandatory
- This method must be implemented. void setTitle(java.lang.String title)
title
- the titleInvalidArgumentException
- title
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- title
is nullmandatory
- This method must be implemented. void clearTitle()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCodeMetadata()
mandatory
- This method must be implemented. void setCode(java.lang.String code)
code
- the codeInvalidArgumentException
- code
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- code
is nullmandatory
- This method must be implemented. void clearCode()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getOfferedCyclicTimePeriodsMetadata()
mandatory
- This method must be implemented. void setOfferedCyclicTimePeriods(Id[] cyclicTimePeriodIds)
cyclicTimePeriodIds
- the cyclic time periodsInvalidArgumentException
- cylciPeriodIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- cyclicPeriodIds
is nullmandatory
- This method must be implemented. void clearOfferedCyclicTimePeriods()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getResultOptionsMetadata()
mandatory
- This method must be implemented. void setResultOptions(Id[] gradeSystemIds)
gradeSystemIds
- the new grading optionsInvalidArgumentException
- gradeSystemIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeSystemIds
is null
mandatory
- This method must be implemented. void clearResultOptions()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getSponsorsMetadata()
mandatory
- This method must be implemented. void setSponsors(Id[] sponsorIds)
sponsorIds
- the new sponsorsInvalidArgumentException
- sponsorIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- sponsorIds
is
null
mandatory
- This method must be implemented. void clearSponsors()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. CanonicalUnitFormRecord getCanonicalUnitFormRecord(Type canonicalUnitRecordType) throws OperationFailedException
CanonicalUnitFormRecord
interface
corresponding to the given canonical unit record Type.
canonicalUnitRecordType
- the canonical unit record typeNullArgumentException
- canonicalUnitRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitRecordType)
is false
mandatory
- This method must be implemented.