public interface TermForm extends OsidObjectForm, OsidFederateableForm
This is the form for creating and updating Terms.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the TermAdminSession.
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 |
clearAddDate()
Clears the add date.
|
void |
clearClassesEnd()
Clears the classes end date.
|
void |
clearClassesStart()
Clears the classes start date.
|
void |
clearCloseDate()
Clears the close date.
|
void |
clearDisplayLabel()
Removes the display label.
|
void |
clearDropDate()
Clears the drop date.
|
void |
clearFinalExamEnd()
Clears the final exam end date.
|
void |
clearFinalExamStart()
Clears the final exam start date.
|
void |
clearOpenDate()
Clears the open date.
|
void |
clearRegistrationEnd()
Clears the registration end date.
|
void |
clearRegistrationStart()
Clears the registration start date.
|
Metadata |
getAddDateMetadata()
Gets the metadata for the add date.
|
Metadata |
getClassesEndMetadata()
Gets the metadata for the classes end date.
|
Metadata |
getClassesStartMetadata()
Gets the metadata for the classes start date.
|
Metadata |
getCloseDateMetadata()
Gets the metadata for the close date.
|
Metadata |
getDisplayLabelMetadata()
Gets the metadata for a display label title.
|
Metadata |
getDropDateMetadata()
Gets the metadata for the drop date.
|
Metadata |
getFinalExamEndMetadata()
Gets the metadata for the final exam end date.
|
Metadata |
getFinalExamStartMetadata()
Gets the metadata for the classes start date.
|
Metadata |
getOpenDateMetadata()
Gets the metadata for an open date.
|
Metadata |
getRegistrationEndMetadata()
Gets the metadata for the registration end date.
|
Metadata |
getRegistrationStartMetadata()
Gets the metadata for the registration start date.
|
TermFormRecord |
getTermFormRecord(Type termRecordType)
Gets the
TermFormRecord corresponding to the given term
record Type. |
void |
setAddDate(DateTime date)
Sets the add date.
|
void |
setClassesEnd(DateTime date)
Sets the classes end date.
|
void |
setClassesStart(DateTime date)
Sets the classes start date.
|
void |
setCloseDate(DateTime date)
Sets the close date.
|
void |
setDisplayLabel(java.lang.String displayLabel)
Sets the display label.
|
void |
setDropDate(DateTime date)
Sets the drop date.
|
void |
setFinalExamEnd(DateTime date)
Sets the final exam end date.
|
void |
setFinalExamStart(DateTime date)
Sets the final exam start date.
|
void |
setOpenDate(DateTime date)
Sets the open date.
|
void |
setRegistrationEnd(DateTime date)
Sets the registration end date.
|
void |
setRegistrationStart(DateTime date)
Sets the registration start date.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getDisplayLabelMetadata()
mandatory
- This method must be implemented. void setDisplayLabel(java.lang.String displayLabel)
displayLabel
- the new display labelInvalidArgumentException
- displayLabel
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- displayLabel
is
null
mandatory
- This method must be implemented. void clearDisplayLabel()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getOpenDateMetadata()
mandatory
- This method must be implemented. void setOpenDate(DateTime date)
date
- the new open dateInvalidArgumentException
- date
is
invalidNoAccessException
- date
cannot be
modifiedNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearOpenDate()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRegistrationStartMetadata()
mandatory
- This method must be implemented. void setRegistrationStart(DateTime date)
date
- the new registration start dateInvalidArgumentException
- date
is
invalidNoAccessException
- date
cannot be
modifiedNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearRegistrationStart()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRegistrationEndMetadata()
mandatory
- This method must be implemented. void setRegistrationEnd(DateTime date)
date
- the new registration end dateInvalidArgumentException
- date
is
invalidNoAccessException
- date
cannot be
modifiedNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearRegistrationEnd()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getClassesStartMetadata()
mandatory
- This method must be implemented. void setClassesStart(DateTime date)
date
- the new classes start dateInvalidArgumentException
- date
is
invalidNoAccessException
- date
cannot be
modifiedNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearClassesStart()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getClassesEndMetadata()
mandatory
- This method must be implemented. void setClassesEnd(DateTime date)
date
- the new classes end dateInvalidArgumentException
- date
is
invalidNoAccessException
- date
cannot be
modifiedNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearClassesEnd()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAddDateMetadata()
mandatory
- This method must be implemented. void setAddDate(DateTime date)
date
- the new add dateInvalidArgumentException
- date
is
invalidNoAccessException
- date
cannot be
modifiedNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearAddDate()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDropDateMetadata()
mandatory
- This method must be implemented. void setDropDate(DateTime date)
date
- the new drop dateInvalidArgumentException
- date
is
invalidNoAccessException
- date
cannot be
modifiedNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearDropDate()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getFinalExamStartMetadata()
mandatory
- This method must be implemented. void setFinalExamStart(DateTime date)
date
- the new final exam start dateInvalidArgumentException
- date
is
invalidNoAccessException
- date
cannot be
modifiedNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearFinalExamStart()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getFinalExamEndMetadata()
mandatory
- This method must be implemented. void setFinalExamEnd(DateTime date)
date
- the new final exam end dateInvalidArgumentException
- date
is
invalidNoAccessException
- date
cannot be
modifiedNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearFinalExamEnd()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCloseDateMetadata()
mandatory
- This method must be implemented. void setCloseDate(DateTime date)
date
- the new close dateInvalidArgumentException
- date
is
invalidNoAccessException
- date
cannot be
modifiedNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearCloseDate()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. TermFormRecord getTermFormRecord(Type termRecordType) throws OperationFailedException
TermFormRecord
corresponding to the given term
record Type.
termRecordType
- a term record typeNullArgumentException
- termRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(termRecordType)
is false
mandatory
- This method must be implemented.