Interface InstallationSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderBySite

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

    • supportsSiteSearchOrder

      boolean supportsSiteSearchOrder()
      Tests if a SiteSearchOrder is available for sites.
      Returns:
      true if a site search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSiteSearchOrder

      SiteSearchOrder getSiteSearchOrder()
      Gets the search order for a site.
      Returns:
      the site search order
      Throws:
      UnimplementedException - supportsSiteSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSiteSearchOrder()} is {@code true} .

    • orderByPackage

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

    • supportsPackageSearchOrder

      boolean supportsPackageSearchOrder()
      Tests if a PackageSearchOrder is available for packages.
      Returns:
      true if a package search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPackageSearchOrder

      PackageSearchOrder getPackageSearchOrder()
      Gets the search order for a package.
      Returns:
      the package search order
      Throws:
      UnimplementedException - supportsPackageSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPackageSearchOrder()} is {@code true} .

    • orderByInstallDate

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

    • orderByAgent

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

    • supportsAgentSearchOrder

      boolean supportsAgentSearchOrder()
      Tests if an AgenteSearchOrder is available for agents.
      Returns:
      true if an agent search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAgentSearchOrder

      AgentSearchOrder getAgentSearchOrder()
      Gets the search order for an agent.
      Returns:
      the agent search order
      Throws:
      UnimplementedException - supportsAgentSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAgentSearchOrder()} is {@code true} .

    • orderByLastCheckDate

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

    • getInstallationSearchOrderRecord

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