Interface TimePeriodForm

All Superinterfaces:

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

All Known Subinterfaces:

TimePeriodBatchForm

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.

Method Summary

Modifier and Type	Method	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.

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.

Method Details

getStartMetadata

Metadata getStartMetadata()

Gets the metadata for a start time.

Returns:

metadata for the start time

Compliance:

mandatory - This method must be implemented.

setStart

void setStart(DateTime start)

Sets the start time.

Parameters:

start - the new start time

Throws:

InvalidArgumentException - start is invalid

NoAccessException - start cannot be modified

NullArgumentException - start is null

Compliance:

mandatory - This method must be implemented.

clearStart

void clearStart()

Clears the start time.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getEndMetadata

Metadata getEndMetadata()

Gets the metadata for an end time.

Returns:

metadata for the end time

Compliance:

mandatory - This method must be implemented.

setEnd

void setEnd(DateTime end)

Sets the end time.

Parameters:

end - the new end time

Throws:

InvalidArgumentException - end is invalid

NoAccessException - end cannot be modified

NullArgumentException - end is null

Compliance:

mandatory - This method must be implemented.

clearEnd

void clearEnd()

Clears the time period end.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getTimePeriodFormRecord

TimePeriodFormRecord getTimePeriodFormRecord(Type timePeriodRecordType)
                                      throws OperationFailedException

Gets the TimePeriodFormRecord corresponding to the given time period record Type .

Parameters:

timePeriodRecordType - the time period record type

Returns:

the time period form record

Throws:

NullArgumentException - timePeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(timePeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.