Interface OfferingConstrainerEnablerSearch

All Superinterfaces:
Extensible, OsidCondition, OsidSearch, Suppliable
public interface OfferingConstrainerEnablerSearch extends OsidSearch

The search interface for governing offering constrainer enabler searches.

  • Method Details

    • searchAmongOfferingConstrainerEnablers

      void searchAmongOfferingConstrainerEnablers(IdList offeringConstrainerEnablerIds)
      Execute this search among the given list of offering constrainer enablers.
      Parameters:
      offeringConstrainerEnablerIds - list of offering constrainer enablers
      Throws:
      NullArgumentException - offeringConstrainerEnablerIds is null
      Compliance:
      mandatory - This method must be implemented.

    • orderOfferingConstrainerEnablerResults

      void orderOfferingConstrainerEnablerResults(OfferingConstrainerEnablerSearchOrder offeringConstrainerEnablerSearchOrder)
      Specify an ordering to the search results.
      Parameters:
      offeringConstrainerEnablerSearchOrder - offering constrainer enabler search order
      Throws:
      NullArgumentException - offeringConstrainerEnablerSearchOrder is null
      UnsupportedException - offeringConstrainerEnablerSearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingConstrainerEnablerSearchRecord

      OfferingConstrainerEnablerSearchRecord getOfferingConstrainerEnablerSearchRecord(Type offeringConstrainerEnablerSearchRecordType) throws OperationFailedException
      Gets the offering constrainer enabler search record corresponding to the given offering constrainer enabler search record Type. This method is used to retrieve an object implementing the requested record.
      Parameters:
      offeringConstrainerEnablerSearchRecordType - an offering constrainer enabler search record type
      Returns:
      the offering constrainer enabler search record
      Throws:
      NullArgumentException - offeringConstrainerEnablerSearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(offeringConstrainerEnablerSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.