Interface FiscalPeriodSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable
public interface FiscalPeriodSearchOrder extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByDisplayLabel

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

    • orderByFiscalYear

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

    • orderByStartDate

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

    • orderByEndDate

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

    • orderByDuration

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

    • orderByBudgetDeadline

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

    • orderByPostingDeadline

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

    • orderByClosing

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

    • getFiscalPeriodSearchOrderRecord

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