Interface PeriodForm

All Superinterfaces:

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

All Known Subinterfaces:

PeriodBatchForm

public interface PeriodForm
extends OsidObjectForm

This is the form for creating and updating Periods. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PeriodAdminSession. 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	clearBillingDate()	Clears the billing date.
void	clearCloseDate()	Clears the close date.
void	clearDisplayLabel()	Removes the display label.
void	clearDueDate()	Clears the due date.
void	clearOpenDate()	Clears the open date.
Metadata	getBillingDateMetadata()	Gets the metadata for the billing date.
Metadata	getCloseDateMetadata()	Gets the metadata for the close date.
Metadata	getDisplayLabelMetadata()	Gets the metadata for a display label title.
Metadata	getDueDateMetadata()	Gets the metadata for the due date.
Metadata	getOpenDateMetadata()	Gets the metadata for an open date.
PeriodFormRecord	getPeriodFormRecord(Type periodRecordType)	Gets the PeriodFormRecord corresponding to the given period record Type.
void	setBillingDate(DateTime date)	Sets the billing date.
void	setCloseDate(DateTime date)	Sets the close date.
void	setDisplayLabel(String displayLabel)	Sets the display label.
void	setDueDate(DateTime date)	Sets the due date.
void	setOpenDate(DateTime date)	Sets the open date.

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

getDisplayLabelMetadata

Metadata getDisplayLabelMetadata()

Gets the metadata for a display label title.

Returns:

metadata for the display label

Compliance:

mandatory - This method must be implemented.

setDisplayLabel

void setDisplayLabel(String displayLabel)

Sets the display label.

Parameters:

displayLabel - the new display label

Throws:

InvalidArgumentException - displayLabel is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - displayLabel is null

Compliance:

mandatory - This method must be implemented.

clearDisplayLabel

void clearDisplayLabel()

Removes the display label.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getOpenDateMetadata

Metadata getOpenDateMetadata()

Gets the metadata for an open date.

Returns:

metadata for the open date

Compliance:

mandatory - This method must be implemented.

setOpenDate

void setOpenDate(DateTime date)

Sets the open date.

Parameters:

date - the new open date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - date cannot be modified

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearOpenDate

void clearOpenDate()

Clears the open date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCloseDateMetadata

Metadata getCloseDateMetadata()

Gets the metadata for the close date.

Returns:

metadata for the close date

Compliance:

mandatory - This method must be implemented.

setCloseDate

void setCloseDate(DateTime date)

Sets the close date.

Parameters:

date - the new close date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - date cannot be modified

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearCloseDate

void clearCloseDate()

Clears the close date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getBillingDateMetadata

Metadata getBillingDateMetadata()

Gets the metadata for the billing date.

Returns:

metadata for the billing date

Compliance:

mandatory - This method must be implemented.

setBillingDate

void setBillingDate(DateTime date)

Sets the billing date.

Parameters:

date - the new billing date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - date cannot be modified

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearBillingDate

void clearBillingDate()

Clears the billing date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getDueDateMetadata

Metadata getDueDateMetadata()

Gets the metadata for the due date.

Returns:

metadata for the due date

Compliance:

mandatory - This method must be implemented.

setDueDate

void setDueDate(DateTime date)

Sets the due date.

Parameters:

date - the new due date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - date cannot be modified

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearDueDate

void clearDueDate()

Clears the due date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getPeriodFormRecord

PeriodFormRecord getPeriodFormRecord(Type periodRecordType)
                              throws OperationFailedException

Gets the PeriodFormRecord corresponding to the given period record Type.

Parameters:

periodRecordType - a period record type

Returns:

the period form record

Throws:

NullArgumentException - periodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(periodRecordType) is false

Compliance:

mandatory - This method must be implemented.