Interface FiscalPeriod

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface FiscalPeriod extends OsidObject

A FiscalPeriod represents a period of time on a fiscal calendar.

  • Method Details

    • getDisplayLabel

      DisplayText getDisplayLabel()
      Gets a display label for this fiscal period which may be less formal than the display name.
      Returns:
      the display label
      Compliance:
      mandatory - This method must be implemented.

    • getFiscalYear

      long getFiscalYear()
      Ges the fiscal year.
      Returns:
      the fiscal year
      Compliance:
      mandatory - This method must be implemented.

    • getStartDate

      DateTime getStartDate()
      Get sthe start date of this period.
      Returns:
      the start date
      Compliance:
      mandatory - This method must be implemented.

    • getEndDate

      DateTime getEndDate()
      Get sthe end date of this period.
      Returns:
      the end date
      Compliance:
      mandatory - This method must be implemented.

    • hasMilestones

      boolean hasMilestones()
      Tests if this fiscal period has milestones.
      Returns:
      true if milestones are available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • requiresBudgetSubmission

      boolean requiresBudgetSubmission()
      Tests if budgets need to be submiited for this fiscal period.
      Returns:
      true if budgets require submission, false otherwise
      Throws:
      IllegalStateException - hasMilestones() is false
      Compliance:
      mandatory - This method must be implemented.

    • getBudgetDeadline

      DateTime getBudgetDeadline()
      Gets the budget deadline.
      Returns:
      the closing date
      Throws:
      IllegalStateException - hasMilestones() or requiresBudgetSubmission() is false
      Compliance:
      mandatory - This method must be implemented.

    • hasPostingDeadline

      boolean hasPostingDeadline()
      Tests if this period has a cutoff date for posting transactions.
      Returns:
      true if a posting deadline date is available, false otherwise
      Throws:
      IllegalStateException - hasMilestones() is false
      Compliance:
      mandatory - This method must be implemented.

    • getPostingDeadline

      DateTime getPostingDeadline()
      Gets the last date transactions can be posted for this period.
      Returns:
      the cutoff date
      Throws:
      IllegalStateException - hasMilestones() or hasPostingDeadline() is false
      Compliance:
      mandatory - This method must be implemented.

    • hasClosing

      boolean hasClosing()
      Tests if this period has a closing date.
      Returns:
      true if a closing date is available, false otherwise
      Throws:
      IllegalStateException - hasMilestones() is false
      Compliance:
      mandatory - This method must be implemented.

    • getClosing

      DateTime getClosing()
      Gets the date of the closing for this period.
      Returns:
      the closing date
      Throws:
      IllegalStateException - hasMilestones() or hasClosing() is false
      Compliance:
      mandatory - This method must be implemented.

    • getFiscalPeriodRecord

      FiscalPeriodRecord getFiscalPeriodRecord(Type fiscalPeriodRecordType) throws OperationFailedException
      Gets the fiscal period record corresponding to the given FiscalPeriod record Type. This method is used to retrieve an object implementing the requested record. The fiscalPeriodRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(fiscalPeriodRecordType) is true.
      Parameters:
      fiscalPeriodRecordType - the type of fiscal period record to retrieve
      Returns:
      the fiscal period record
      Throws:
      NullArgumentException - fiscalPeriodRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(fiscalPeriodRecordType) is false
      Compliance:
      mandatory - This method must be implemented.