public interface FiscalPeriodForm extends OsidObjectForm
This is the form for creating and updating FiscalPeriods.
Like all OsidForm
objects, 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.
Modifier and Type | Method and 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(java.lang.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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getDisplayLabelMetadata()
mandatory
- This method must be implemented. void setDisplayLabel(java.lang.String label)
label
- the new display labelInvalidArgumentException
- label
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- label
is
null
mandatory
- This method must be implemented. void clearDisplayLabel()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getFiscalYearMetadata()
mandatory
- This method must be implemented. void setFiscalYear(long year)
year
- the new fiscal yearInvalidArgumentException
- year
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearFiscalYear()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getStartDateMetadata()
mandatory
- This method must be implemented. void setStartDate(DateTime date)
date
- the new start dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearStartDate()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getEndDateMetadata()
mandatory
- This method must be implemented. void setEndDate(DateTime date)
date
- the new end dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearEndDate()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getBudgetDeadlineMetadata()
mandatory
- This method must be implemented. void setBudgetDeadline(DateTime date)
date
- the new budget deadlineInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearBudgetDeadline()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getPostingDeadlineMetadata()
mandatory
- This method must be implemented. void setPostingDeadline(DateTime date)
date
- the new posting deadlineInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearPostingDeadline()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getClosingMetadata()
mandatory
- This method must be implemented. void setClosing(DateTime date)
date
- the new closting dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearClosing()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. FiscalPeriodFormRecord getFiscalPeriodFormRecord(Type fiscalPeriodRecordType) throws OperationFailedException
FiscalPeriodFormRecord
corresponding to the
given fiscal period record Type.
fiscalPeriodRecordType
- a fiscal period record typeNullArgumentException
- fiscalPeriodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(fiscalPeriodRecordType)
is false
mandatory
- This method must be implemented.