OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.IssueSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByQueue
Description

Orders the results by queue.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsQueueSearchOrder
Description

Tests if a queue search order is available.

Returnboolean true if a queue search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQueueSearchOrder
Description

Gets the queue search order.

Returnosid.tracking.QueueSearchOrderthe queue search order
ErrorsILLEGAL_STATE supportsQueueSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByCustomer
Description

Orders the results by the customer.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCustomerSearchOrder
Description

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCustomerSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsILLEGAL_STATE supportsCustomerSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByTopic
Description

Orders the results by the topic.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsTopicSearchOrder
Description

Tests if a subject search order is available.

Returnboolean true if a subject search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTopicSearchOrder
Description

Gets the topic search order.

Returnosid.ontology.SubjectSearchOrderthe subject search order
ErrorsILLEGAL_STATE supportsTopicSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByMasterIssue
Description

Orders the results by the master issue.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsMasterIssueSearchOrder
Description

Tests if an issue search order is available.

Returnboolean true if an issue search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMasterIssueSearchOrder
Description

Gets the issue search order.

Returnosid.tracking.IssueSearchOrderthe issue search order
ErrorsILLEGAL_STATE supportsMasterIssueSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByRootIssue
Description

Orders the results by the root issue.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsRootIssueSearchOrder
Description

Tests if an issue search order is available.

Returnboolean true if an issue search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRootIssueSearchOrder
Description

Gets the issue search order.

Returnosid.tracking.IssueSearchOrderthe issue search order
ErrorsILLEGAL_STATE supportsRootIssueSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByCreator
Description

Orders the results by the creator.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCreatorSearchOrder
Description

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCreatorSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsILLEGAL_STATE supportsCreatorSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByCreatingAgent
Description

Orders the results by the creator.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCreatingAgentSearchOrder
Description

Tests if an agent search order is available.

Returnboolean true if an agent search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCreatingAgentSearchOrder
Description

Gets the agent search order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsILLEGAL_STATE supportsCreatingAgentSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByCreatedDate
Description

Orders the results by the created date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByReopener
Description

Orders the results by the reopener.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsReopenerSearchOrder
Description

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetReopenerSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsILLEGAL_STATE supportsReopenerSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByReopeningAgent
Description

Orders the results by the reopener.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsReopeningAgentSearchOrder
Description

Tests if an agent search order is available.

Returnboolean true if an agent search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetReopeningAgentSearchOrder
Description

Gets the agent search order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsILLEGAL_STATE supportsReopeningAgentSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByReopenedDate
Description

Orders the results by the reopened date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByDueDate
Description

Orders the results by the due date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByPending
Description

Orders the results by the pending state.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByResolver
Description

Orders the results by the resolver.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsResolverSearchOrder
Description

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResolverSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsILLEGAL_STATE supportsReopenerSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByResolvingAgent
Description

Orders the results by the resolving agent.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsResolvingAgentSearchOrder
Description

Tests if an agent search order is available.

Returnboolean true if an agent search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResolvingAgentSearchOrder
Description

Gets the agent search order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsILLEGAL_STATE supportsReopeningAgentSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByResolvedDate
Description

Orders the results by the resolved date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByResolutionType
Description

Orders the results by the resolution type.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCloser
Description

Orders the results by the closer.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCloserSearchOrder
Description

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCloserSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsILLEGAL_STATE supportsCloserSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByClosingAgent
Description

Orders the results by the closer.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsClosingAgentSearchOrder
Description

Tests if an agent search order is available.

Returnboolean true if an agent search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetClosingAgentSearchOrder
Description

Gets the agent search order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsILLEGAL_STATE supportsClosingAgentSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByClosedDate
Description

Orders the results by the closed date.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByAssignedResource
Description

Orders the results by the assigned resource.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsAssignedResourceSearchOrder
Description

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAssignedResourceSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsILLEGAL_STATE supportsAssignedResourceSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByStatus
Description

Orders the results by the issue status.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetIssueSearchOrderRecord
Description

Gets the issue search order record corresponding to the given issue record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypeissueRecordTypea issue record type
Returnosid.tracking.records.IssueSearchOrderRecordthe issue order record
ErrorsNULL_ARGUMENT issueRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(issueRecordType) is false
CompliancemandatoryThis method must be implemented.