org.osid.calendaring

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

Methods

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.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

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.