Interface IssueSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByQueue

      void orderByQueue(SearchOrderStyle style)
      Orders the results by queue.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsQueueSearchOrder

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

    • getQueueSearchOrder

      QueueSearchOrder getQueueSearchOrder()
      Gets the queue search order.
      Returns:
      the queue search order
      Throws:
      IllegalStateException - supportsQueueSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByCustomer

      void orderByCustomer(SearchOrderStyle style)
      Orders the results by the customer.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCustomerSearchOrder

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

    • getCustomerSearchOrder

      ResourceSearchOrder getCustomerSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsCustomerSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByTopic

      void orderByTopic(SearchOrderStyle style)
      Orders the results by the topic.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsTopicSearchOrder

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

    • getTopicSearchOrder

      SubjectSearchOrder getTopicSearchOrder()
      Gets the topic search order.
      Returns:
      the subject search order
      Throws:
      IllegalStateException - supportsTopicSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByMasterIssue

      void orderByMasterIssue(SearchOrderStyle style)
      Orders the results by the master issue.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsMasterIssueSearchOrder

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

    • getMasterIssueSearchOrder

      IssueSearchOrder getMasterIssueSearchOrder()
      Gets the issue search order.
      Returns:
      the issue search order
      Throws:
      IllegalStateException - supportsMasterIssueSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByRootIssue

      void orderByRootIssue(SearchOrderStyle style)
      Orders the results by the root issue.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsRootIssueSearchOrder

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

    • getRootIssueSearchOrder

      IssueSearchOrder getRootIssueSearchOrder()
      Gets the issue search order.
      Returns:
      the issue search order
      Throws:
      IllegalStateException - supportsRootIssueSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByCreator

      void orderByCreator(SearchOrderStyle style)
      Orders the results by the creator.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCreatorSearchOrder

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

    • getCreatorSearchOrder

      ResourceSearchOrder getCreatorSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsCreatorSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByCreatingAgent

      void orderByCreatingAgent(SearchOrderStyle style)
      Orders the results by the creator.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCreatingAgentSearchOrder

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

    • getCreatingAgentSearchOrder

      AgentSearchOrder getCreatingAgentSearchOrder()
      Gets the agent search order.
      Returns:
      the agent search order
      Throws:
      IllegalStateException - supportsCreatingAgentSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByCreatedDate

      void orderByCreatedDate(SearchOrderStyle style)
      Orders the results by the created date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByReopener

      void orderByReopener(SearchOrderStyle style)
      Orders the results by the reopener.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsReopenerSearchOrder

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

    • getReopenerSearchOrder

      ResourceSearchOrder getReopenerSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsReopenerSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByReopeningAgent

      void orderByReopeningAgent(SearchOrderStyle style)
      Orders the results by the reopener.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsReopeningAgentSearchOrder

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

    • getReopeningAgentSearchOrder

      AgentSearchOrder getReopeningAgentSearchOrder()
      Gets the agent search order.
      Returns:
      the agent search order
      Throws:
      IllegalStateException - supportsReopeningAgentSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByReopenedDate

      void orderByReopenedDate(SearchOrderStyle style)
      Orders the results by the reopened date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByDueDate

      void orderByDueDate(SearchOrderStyle style)
      Orders the results by the due date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByPending

      void orderByPending(SearchOrderStyle style)
      Orders the results by the pending state.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByResolver

      void orderByResolver(SearchOrderStyle style)
      Orders the results by the resolver.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsResolverSearchOrder

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

    • getResolverSearchOrder

      ResourceSearchOrder getResolverSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsReopenerSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByResolvingAgent

      void orderByResolvingAgent(SearchOrderStyle style)
      Orders the results by the resolving agent.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsResolvingAgentSearchOrder

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

    • getResolvingAgentSearchOrder

      AgentSearchOrder getResolvingAgentSearchOrder()
      Gets the agent search order.
      Returns:
      the agent search order
      Throws:
      IllegalStateException - supportsReopeningAgentSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByResolvedDate

      void orderByResolvedDate(SearchOrderStyle style)
      Orders the results by the resolved date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByResolutionType

      void orderByResolutionType(SearchOrderStyle style)
      Orders the results by the resolution type.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByCloser

      void orderByCloser(SearchOrderStyle style)
      Orders the results by the closer.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCloserSearchOrder

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

    • getCloserSearchOrder

      ResourceSearchOrder getCloserSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsCloserSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByClosingAgent

      void orderByClosingAgent(SearchOrderStyle style)
      Orders the results by the closer.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsClosingAgentSearchOrder

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

    • getClosingAgentSearchOrder

      AgentSearchOrder getClosingAgentSearchOrder()
      Gets the agent search order.
      Returns:
      the agent search order
      Throws:
      IllegalStateException - supportsClosingAgentSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByClosedDate

      void orderByClosedDate(SearchOrderStyle style)
      Orders the results by the closed date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByAssignedResource

      void orderByAssignedResource(SearchOrderStyle style)
      Orders the results by the assigned resource.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsAssignedResourceSearchOrder

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

    • getAssignedResourceSearchOrder

      ResourceSearchOrder getAssignedResourceSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsAssignedResourceSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByStatus

      void orderByStatus(SearchOrderStyle style)
      Orders the results by the issue status.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getIssueSearchOrderRecord

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