Interface BudgetSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface BudgetSearchOrder extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByActivity

      void orderByActivity(SearchOrderStyle style)
      Specifies a preference for ordering the result set by activity.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivitySearchOrder

      boolean supportsActivitySearchOrder()
      Tests if an activity search order is available.
      Returns:
      true if an activity search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getActivitySearchOrder

      ActivitySearchOrder getActivitySearchOrder()
      Gets the activity search order.
      Returns:
      the activity search order
      Throws:
      UnimplementedException - supportsActivitySearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivitySearchOrder()} is {@code true} .

    • orderByFiscalPeriod

      void orderByFiscalPeriod(SearchOrderStyle style)
      Specifies a preference for ordering the result set by fiscal period.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsFiscalPeriodSearchOrder

      boolean supportsFiscalPeriodSearchOrder()
      Tests if a fiscal period search order is available.
      Returns:
      true if a fiscal period search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getFiscalPeriodSearchOrder

      FiscalPeriodSearchOrder getFiscalPeriodSearchOrder()
      Gets the fiscal period search order.
      Returns:
      the fiscal period search order
      Throws:
      UnimplementedException - supportsFiscalPeriodSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsFiscalPeriodSearchOrder()} is {@code true} .

    • getBudgetSearchOrderRecord

      BudgetSearchOrderRecord getBudgetSearchOrderRecord(Type budgetRecordType) throws OperationFailedException
      Gets the budget search order record corresponding to the given budget record Type . Multiple retrievals return the same underlying object.
      Parameters:
      budgetRecordType - a budget record type
      Returns:
      the budget search order record
      Throws:
      NullArgumentException - budgetRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(budgetRecordType) is false
      Compliance:
      mandatory - This method must be implemented.