Interface DocetSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByModule

      void orderByModule(SearchOrderStyle style)
      Specified a preference for ordering results by the module.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsModuleSearchOrder

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

    • getModuleSearchOrder

      ModuleSearchOrder getModuleSearchOrder()
      Gets the search order for a module.
      Returns:
      the module search order
      Throws:
      UnimplementedException - supportsModuleSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsModuleSearchOrder()} is {@code true} .

    • orderByActivityUnit

      void orderByActivityUnit(SearchOrderStyle style)
      Specified a preference for ordering results by the activity unit.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityUnitSearchOrder

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

    • getActivityUnitSearchOrder

      ActivityUnitSearchOrder getActivityUnitSearchOrder()
      Gets the search order for an actvity unit.
      Returns:
      the activity unit search order
      Throws:
      UnimplementedException - supportsActivityUnitSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityUnitSearchOrder()} is {@code true} .

    • orderByInClass

      void orderByInClass(SearchOrderStyle style)
      Specified a preference for ordering results by the in class flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByDuration

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

    • getDocetSearchOrderRecord

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