Interface Summary

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidCompendium, OsidObject, Subjugateable
public interface Summary extends OsidCompendium

A Summary represents a financial summary of an Account in a time period.

  • Method Details

    • getAccountId

      Id getAccountId()
      Gets the Id of the account.
      Returns:
      the account Id
      Compliance:
      mandatory - This method must be implemented.

    • getAccount

      Account getAccount() throws OperationFailedException
      Gets the account.
      Returns:
      the account
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getFiscalPeriodId

      Id getFiscalPeriodId()
      Gets the Id of the fiscal period
      Returns:
      the fiscal period Id
      Compliance:
      mandatory - This method must be implemented.

    • getFiscalPeriod

      FiscalPeriod getFiscalPeriod() throws OperationFailedException
      Gets the fiscal period
      Returns:
      the fiscal period
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCredits

      Currency getCredits()
      Gets the credits for this fiscal period.
      Returns:
      the credits
      Compliance:
      mandatory - This method must be implemented.

    • getDebits

      Currency getDebits()
      Gets the debits for this fiscal period.
      Returns:
      the debits
      Compliance:
      mandatory - This method must be implemented.

    • isBudgeted

      boolean isBudgeted()
      Tests if this the account on this activity has a budget for this time period.
      Returns:
      true if a budget is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBudget

      Currency getBudget()
      Gets the budget.
      Returns:
      the budget
      Throws:
      IllegalStateException - isBudgeted() is false
      Compliance:
      mandatory - This method must be implemented.

    • hasForecast

      boolean hasForecast()
      Tests if this the account on this activity has a forecast for this time period.
      Returns:
      true if a forecast is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getForecast

      Currency getForecast()
      Gets the forecast
      Returns:
      the forecast
      Throws:
      IllegalStateException - hasForecast() is false
      Compliance:
      mandatory - This method must be implemented.

    • getSummaryRecord

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