Interface FiscalPeriodForm

All Superinterfaces:

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

All Known Subinterfaces:

FiscalPeriodBatchForm

public interface FiscalPeriodForm
extends OsidObjectForm

This is the form for creating and updating FiscalPeriods. Like all OsidForms, various data elements may be set here for use in the create and update methods in the FiscalPeriodAdminSession. 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	clearBudgetDeadline()	Removes the budget deadline.
void	clearClosing()	Removes the closting date.
void	clearDisplayLabel()	Removes the display label.
void	clearEndDate()	Removes the end date.
void	clearFiscalYear()	Removes the fiscal year.
void	clearPostingDeadline()	Removes the posting deadline.
void	clearStartDate()	Removes the start date.
Metadata	getBudgetDeadlineMetadata()	Gets the metadata for the budget deadline.
Metadata	getClosingMetadata()	Gets the metadata for the closing date.
Metadata	getDisplayLabelMetadata()	Gets the metadata for a display label.
Metadata	getEndDateMetadata()	Gets the metadata for the end date.
FiscalPeriodFormRecord	getFiscalPeriodFormRecord(Type fiscalPeriodRecordType)	Gets the FiscalPeriodFormRecord corresponding to the given fiscal period record Type.
Metadata	getFiscalYearMetadata()	Gets the metadata for a fiscal year.
Metadata	getPostingDeadlineMetadata()	Gets the metadata for the posting deadline.
Metadata	getStartDateMetadata()	Gets the metadata for the start date.
void	setBudgetDeadline(DateTime date)	Sets the budget deadline.
void	setClosing(DateTime date)	Sets the closing date.
void	setDisplayLabel(String label)	Sets the display label.
void	setEndDate(DateTime date)	Sets the end date.
void	setFiscalYear(long year)	Sets the fiscal year.
void	setPostingDeadline(DateTime date)	Sets the posting deadline.
void	setStartDate(DateTime date)	Sets the start 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.

Returns:

metadata for the display label

Compliance:

mandatory - This method must be implemented.

setDisplayLabel

void setDisplayLabel(String label)

Sets the display label.

Parameters:

label - the new display label

Throws:

InvalidArgumentException - label is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - label 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.

getFiscalYearMetadata

Metadata getFiscalYearMetadata()

Gets the metadata for a fiscal year.

Returns:

metadata for the fiscal year

Compliance:

mandatory - This method must be implemented.

setFiscalYear

void setFiscalYear(long year)

Sets the fiscal year.

Parameters:

year - the new fiscal year

Throws:

InvalidArgumentException - year is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearFiscalYear

void clearFiscalYear()

Removes the fiscal year.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getStartDateMetadata

Metadata getStartDateMetadata()

Gets the metadata for the start date.

Returns:

metadata for the start date

Compliance:

mandatory - This method must be implemented.

setStartDate

void setStartDate(DateTime date)

Sets the start date.

Parameters:

date - the new start date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearStartDate

void clearStartDate()

Removes the start date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getEndDateMetadata

Metadata getEndDateMetadata()

Gets the metadata for the end date.

Returns:

metadata for the end date

Compliance:

mandatory - This method must be implemented.

setEndDate

void setEndDate(DateTime date)

Sets the end date.

Parameters:

date - the new end date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearEndDate

void clearEndDate()

Removes the end date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getBudgetDeadlineMetadata

Metadata getBudgetDeadlineMetadata()

Gets the metadata for the budget deadline.

Returns:

metadata for the budget deadline

Compliance:

mandatory - This method must be implemented.

setBudgetDeadline

void setBudgetDeadline(DateTime date)

Sets the budget deadline.

Parameters:

date - the new budget deadline

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearBudgetDeadline

void clearBudgetDeadline()

Removes the budget deadline.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getPostingDeadlineMetadata

Metadata getPostingDeadlineMetadata()

Gets the metadata for the posting deadline.

Returns:

metadata for the posting deadline

Compliance:

mandatory - This method must be implemented.

setPostingDeadline

void setPostingDeadline(DateTime date)

Sets the posting deadline.

Parameters:

date - the new posting deadline

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearPostingDeadline

void clearPostingDeadline()

Removes the posting deadline.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getClosingMetadata

Metadata getClosingMetadata()

Gets the metadata for the closing date.

Returns:

metadata for the closing date

Compliance:

mandatory - This method must be implemented.

setClosing

void setClosing(DateTime date)

Sets the closing date.

Parameters:

date - the new closting date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearClosing

void clearClosing()

Removes the closting date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodFormRecord

FiscalPeriodFormRecord getFiscalPeriodFormRecord(Type fiscalPeriodRecordType)
                                          throws OperationFailedException

Gets the FiscalPeriodFormRecord corresponding to the given fiscal period record Type.

Parameters:

fiscalPeriodRecordType - a fiscal period record type

Returns:

the fiscal period form record

Throws:

NullArgumentException - fiscalPeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(fiscalPeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.