OSID - osid.tracking.IssueSearchOrder Service Interface Definition

Interface	osid.tracking.IssueSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByQueue
Description	Orders the results by queue.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueSearchOrder
Description	Tests if a queue search order is available.
Return	`boolean`		`true` if a queue search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getQueueSearchOrder
Description	Gets the queue search order.
Return	`osid.tracking.QueueSearchOrder`		the queue search order
Errors	ILLEGAL_STATE		`supportsQueueSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCustomer
Description	Orders the results by the customer.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerSearchOrder
Description	Tests if a resource search order is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	ILLEGAL_STATE		`supportsCustomerSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByTopic
Description	Orders the results by the topic.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsTopicSearchOrder
Description	Tests if a subject search order is available.
Return	`boolean`		`true` if a subject search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTopicSearchOrder
Description	Gets the topic search order.
Return	`osid.ontology.SubjectSearchOrder`		the subject search order
Errors	ILLEGAL_STATE		`supportsTopicSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByMasterIssue
Description	Orders the results by the master issue.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsMasterIssueSearchOrder
Description	Tests if an issue search order is available.
Return	`boolean`		`true` if an issue search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMasterIssueSearchOrder
Description	Gets the issue search order.
Return	`osid.tracking.IssueSearchOrder`		the issue search order
Errors	ILLEGAL_STATE		`supportsMasterIssueSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRootIssue
Description	Orders the results by the root issue.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRootIssueSearchOrder
Description	Tests if an issue search order is available.
Return	`boolean`		`true` if an issue search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRootIssueSearchOrder
Description	Gets the issue search order.
Return	`osid.tracking.IssueSearchOrder`		the issue search order
Errors	ILLEGAL_STATE		`supportsRootIssueSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCreator
Description	Orders the results by the creator.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCreatorSearchOrder
Description	Tests if a resource search order is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCreatorSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	ILLEGAL_STATE		`supportsCreatorSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCreatingAgent
Description	Orders the results by the creator.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCreatingAgentSearchOrder
Description	Tests if an agent search order is available.
Return	`boolean`		`true` if an agent search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCreatingAgentSearchOrder
Description	Gets the agent search order.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	ILLEGAL_STATE		`supportsCreatingAgentSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCreatedDate
Description	Orders the results by the created date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByReopener
Description	Orders the results by the reopener.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsReopenerSearchOrder
Description	Tests if a resource search order is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getReopenerSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	ILLEGAL_STATE		`supportsReopenerSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByReopeningAgent
Description	Orders the results by the reopener.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsReopeningAgentSearchOrder
Description	Tests if an agent search order is available.
Return	`boolean`		`true` if an agent search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getReopeningAgentSearchOrder
Description	Gets the agent search order.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	ILLEGAL_STATE		`supportsReopeningAgentSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByReopenedDate
Description	Orders the results by the reopened date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByDueDate
Description	Orders the results by the due date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByPending
Description	Orders the results by the pending state.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByResolver
Description	Orders the results by the resolver.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsResolverSearchOrder
Description	Tests if a resource search order is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResolverSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	ILLEGAL_STATE		`supportsReopenerSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByResolvingAgent
Description	Orders the results by the resolving agent.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsResolvingAgentSearchOrder
Description	Tests if an agent search order is available.
Return	`boolean`		`true` if an agent search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResolvingAgentSearchOrder
Description	Gets the agent search order.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	ILLEGAL_STATE		`supportsReopeningAgentSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByResolvedDate
Description	Orders the results by the resolved date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByResolutionType
Description	Orders the results by the resolution type.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCloser
Description	Orders the results by the closer.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCloserSearchOrder
Description	Tests if a resource search order is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCloserSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	ILLEGAL_STATE		`supportsCloserSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByClosingAgent
Description	Orders the results by the closer.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsClosingAgentSearchOrder
Description	Tests if an agent search order is available.
Return	`boolean`		`true` if an agent search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getClosingAgentSearchOrder
Description	Gets the agent search order.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	ILLEGAL_STATE		`supportsClosingAgentSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByClosedDate
Description	Orders the results by the closed date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByAssignedResource
Description	Orders the results by the assigned resource.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssignedResourceSearchOrder
Description	Tests if a resource search order is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssignedResourceSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	ILLEGAL_STATE		`supportsAssignedResourceSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByStatus
Description	Orders the results by the issue status.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIssueSearchOrderRecord
Description	Gets the issue search order record corresponding to the given issue record `Type.` Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`issueRecordType`	a issue record type
Return	`osid.tracking.records.IssueSearchOrderRecord`		the issue order record
Errors	NULL_ARGUMENT		`issueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(issueRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.