Interface OfferingConstrainerSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidConstrainerSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable
public interface OfferingConstrainerSearchOrder extends OsidConstrainerSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByOverrideDescription

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

    • orderByOverrideTitle

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

    • orderByOverrideCode

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

    • orderByOverrideTimePeriods

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

    • orderByConstrainTimePeriods

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

    • orderByOverrideResultOptions

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

    • orderByConstrainResultOptions

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

    • orderByOverrideSponsors

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

    • orderByConstrainSponsors

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

    • getOfferingConstrainerSearchOrderRecord

      OfferingConstrainerSearchOrderRecord getOfferingConstrainerSearchOrderRecord(Type offeringConstrainerRecordType) throws OperationFailedException
      Gets the offering constrainer search order record corresponding to the given offering constrainer record Type . Multiple retrievals return the same underlying object.
      Parameters:
      offeringConstrainerRecordType - an offering constrainer record type
      Returns:
      the offering constrainer search order record
      Throws:
      NullArgumentException - offeringConstrainerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(offeringConstrainerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.