Interface BudgetEntrySearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByBudget

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

    • supportsBudgetSearchOrder

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

    • getBudgetSearchOrder

      BudgetSearchOrder getBudgetSearchOrder()
      Gets the budget order.
      Returns:
      the budget search order
      Throws:
      UnimplementedException - supportsBudgetSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBudgetSearchOrder()} is {@code true} .

    • orderByAccount

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

    • supportsAccountSearchOrder

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

    • getAccountSearchOrder

      AccountSearchOrder getAccountSearchOrder()
      Gets the account order.
      Returns:
      the account search order
      Throws:
      UnimplementedException - supportsAccountSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAccountSearchOrder()} is {@code true} .

    • orderByAmount

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

    • orderByDebit

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

    • getBudgetEntrySearchOrderRecord

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