public interface TimePeriodForm extends OsidObjectForm
This is the form for creating and updating TimePeriods.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
TimePeriodAdminSession.
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 |
clearEnd()
Clears the time period end.
|
void |
clearStart()
Clears the start time.
|
Metadata |
getEndMetadata()
Gets the metadata for an end time.
|
Metadata |
getStartMetadata()
Gets the metadata for a start time.
|
TimePeriodFormRecord |
getTimePeriodFormRecord(Type timePeriodRecordType)
Gets the
TimePeriodFormRecord corresponding to the
given time period record Type. |
void |
setEnd(DateTime end)
Sets the end time.
|
void |
setStart(DateTime start)
Sets the start time.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getStartMetadata()
mandatory
- This method must be implemented. void setStart(DateTime start)
start
- the new start timeInvalidArgumentException
- start
is
invalidNoAccessException
- start
cannot be
modifiedNullArgumentException
- start
is
null
mandatory
- This method must be implemented. void clearStart()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getEndMetadata()
mandatory
- This method must be implemented. void setEnd(DateTime end)
end
- the new end timeInvalidArgumentException
- end
is
invalidNoAccessException
- end
cannot be
modifiedNullArgumentException
- end
is
null
mandatory
- This method must be implemented. void clearEnd()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. TimePeriodFormRecord getTimePeriodFormRecord(Type timePeriodRecordType) throws OperationFailedException
TimePeriodFormRecord
corresponding to the
given time period record Type.
timePeriodRecordType
- the time period record typeNullArgumentException
- timePeriodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(timePeriodRecordType)
is false
mandatory
- This method must be implemented.