Interface | osid.tracking.IssueQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching issues. Each method match
specifies an | ||
Method | matchQueueId | ||
Description |
Sets the queue | ||
Parameters | osid.id.Id | queueId | the queue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | queueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearQueueIdTerms | ||
Description |
Clears the queue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsQueueQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a queue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueQuery | ||
Description |
Gets the query for a queue. Multiple retrievals produce
a nested | ||
Return | osid.tracking.QueueQuery | the queue query | |
Errors | UNIMPLEMENTED | supportsQueueQuery() is false | |
Compliance | optional | This method must be implemented if supportsQueueQuery() is
true. | |
Method | clearQueueTerms | ||
Description |
Clears the queue query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCustomerId | ||
Description |
Sets the customer | ||
Parameters | osid.id.Id | resourceId | the resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCustomerIdTerms | ||
Description |
Clears the customer | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCustomerQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a customer query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCustomerQuery | ||
Description |
Gets the query for a customer. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsCustomerQuery() is false | |
Compliance | optional | This method must be implemented if supportsCustomerQuery()
is true. | |
Method | clearCustomerTerms | ||
Description |
Clears the customer query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTopicId | ||
Description |
Sets the topic | ||
Parameters | osid.id.Id | topicId | the topic Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | topicId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearTopicIdTerms | ||
Description |
Clears the topic | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsTopicQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a topic query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTopicQuery | ||
Description |
Gets the query for a topic. Multiple retrievals produce
a nested | ||
Return | osid.ontology.SubjectQuery | the topic query | |
Errors | UNIMPLEMENTED | supportsTopicQuery() is false | |
Compliance | optional | This method must be implemented if supportsTopicQuery() is
true. | |
Method | matchAnyTopic | ||
Description |
Matches issues that have any topic. | ||
Parameters | boolean | match | true to match issues with any topic, false to
match issues with no topic |
Compliance | mandatory | This method must be implemented. | |
Method | clearTopicTerms | ||
Description |
Clears the topic query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSubtaskId | ||
Description |
Sets the subtask | ||
Parameters | osid.id.Id | issueId | the issue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | issueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSubtaskIdTerms | ||
Description |
Clears the subtask issue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSubtaskQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a subtask issue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubtaskQuery | ||
Description |
Gets the query for a subtask issue. Multiple retrievals
produce a nested | ||
Return | osid.tracking.IssueQuery | the subtask issue query | |
Errors | UNIMPLEMENTED | supportsSubtaskQuery() is false | |
Compliance | optional | This method must be implemented if supportsSubtaskQuery() is
true. | |
Method | matchAnySubtask | ||
Description |
Matches issues that have any subtask. | ||
Parameters | boolean | match | true to match issues with any subtasks, false
to match issues on no subtasks |
Compliance | mandatory | This method must be implemented. | |
Method | clearSubtaskTerms | ||
Description |
Clears the subtask query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMasterIssueId | ||
Description |
Sets the master issue | ||
Parameters | osid.id.Id | issueId | the issue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | issueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMasterIssueIdTerms | ||
Description |
Clears the master issue issue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsMasterIssueQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a master issue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMasterIssueQuery | ||
Description |
Gets the query for a master issue. Multiple retrievals
produce a nested | ||
Return | osid.tracking.IssueQuery | the master issue query | |
Errors | UNIMPLEMENTED | supportsMasterIssueQuery() is false | |
Compliance | optional | This method must be implemented if supportsMasterIssueQuery()
is true. | |
Method | matchAnyMasterIssue | ||
Description |
Matches issues that are subtasks. | ||
Parameters | boolean | match | true to match issues with any master issue, false
to match issues on no master issues |
Compliance | mandatory | This method must be implemented. | |
Method | clearMasterIssueTerms | ||
Description |
Clears the linked issue query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDuplicateIssueId | ||
Description |
Sets the linked issue | ||
Parameters | osid.id.Id | issueId | the issue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | issueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDuplicateIssueIdTerms | ||
Description |
Clears the duplicate issue issue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDuplicateIssueQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a duplicate issue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDuplicateIssueQuery | ||
Description |
Gets the query for a duplicate issue. Multiple
retrievals produce a nested | ||
Return | osid.tracking.IssueQuery | the duplicate issue query | |
Errors | UNIMPLEMENTED | supportsDuplicateIssueQuery() is false | |
Compliance | optional | This method must be implemented if supportsDuplicateIssueQuery()
is true. | |
Method | matchAnyDuplicateIssue | ||
Description |
Matches issues that are duplicated by any other issue. | ||
Parameters | boolean | match | true to match duplicate issues, false to
match unlinked issues |
Compliance | mandatory | This method must be implemented. | |
Method | clearDuplicateIssueTerms | ||
Description |
Clears the duplicate issue query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchBranchedIssueId | ||
Description |
Sets the branched issue | ||
Parameters | osid.id.Id | issueId | the issue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | issueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearBranchedIssueIdTerms | ||
Description |
Clears the branched issue issue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBranchedIssueQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a branched issue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBranchedIssueQuery | ||
Description |
Gets the query for a branched issue. Multiple
retrievals produce a nested | ||
Return | osid.tracking.IssueQuery | the branched issue query | |
Errors | UNIMPLEMENTED | supportsBranchedIssueQuery() is false | |
Compliance | optional | This method must be implemented if supportsBranchedIssueQuery()
is true. | |
Method | matchAnyBranchedIssue | ||
Description |
Matches issues that branched to any other issue. | ||
Parameters | boolean | match | true to match issues with branches, false to
match issues with no branches |
Compliance | mandatory | This method must be implemented. | |
Method | clearBranchedIssueTerms | ||
Description |
Clears the branched issue query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRootIssueId | ||
Description |
Sets the root of the branch issue | ||
Parameters | osid.id.Id | issueId | the issue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | issueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRootIssueIdTerms | ||
Description |
Clears the root issue issue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRootIssueQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a root issue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRootIssueQuery | ||
Description |
Gets the query for a root of the branch issue. Multiple
retrievals produce a nested | ||
Return | osid.tracking.IssueQuery | the root issue query | |
Errors | UNIMPLEMENTED | supportsRootIssueQuery() is false | |
Compliance | optional | This method must be implemented if supportsRootIssueQuery()
is true. | |
Method | matchAnyRootIssue | ||
Description |
Matches issue branches with a root. | ||
Parameters | boolean | match | true to match branches with a root, false to
match issues that are not a branch of another issue |
Compliance | mandatory | This method must be implemented. | |
Method | clearRootIssueTerms | ||
Description |
Clears the root issue query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchPriorityType | ||
Description |
Matches issues with the given priority type. | ||
Parameters | osid.type.Type | priorityType | the priority Type |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | priorityType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearPriorityTypeTerms | ||
Description |
Clears the priority type query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCreatorId | ||
Description |
Sets the creator | ||
Parameters | osid.id.Id | resourceId | the resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCreatorIdTerms | ||
Description |
Clears the creator | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreatorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreatorQuery | ||
Description |
Gets the query for a creator. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsCreatorQuery() is false | |
Compliance | optional | This method must be implemented if supportsCreatorQuery() is
true. | |
Method | clearCreatorTerms | ||
Description |
Clears the creator query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCreatingAgentId | ||
Description |
Sets the creating agent | ||
Parameters | osid.id.Id | agentId | the agent Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCreatingAgentIdTerms | ||
Description |
Clears the creator | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreatingAgentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agent query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreatingAgentQuery | ||
Description |
Gets the query for a creator. Multiple retrievals
produce a nested | ||
Return | osid.authentication.AgentQuery | the agent query | |
Errors | UNIMPLEMENTED | supportsCreatingAgentQuery() is false | |
Compliance | optional | This method must be implemented if supportsCreatingAgentQuery()
is true. | |
Method | clearCreatingAgentTerms | ||
Description |
Clears the creating agent query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCreatedDate | ||
Description |
Matches issues created within the given date range inclusive. | ||
Parameters | osid.calendaring.DateTime | from | the range start |
osid.calendaring.DateTime | to | the range end | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCreatedDateTerms | ||
Description |
Clears the created date query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchReopenerId | ||
Description |
Sets the reopener | ||
Parameters | osid.id.Id | resourceId | the resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearReopenerIdTerms | ||
Description |
Clears the reopener | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsReopenerQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getReopenerQuery | ||
Description |
Gets the query for the resource who reopened this
issue. Multiple retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsReopenerQuery() is false | |
Compliance | optional | This method must be implemented if supportsReopenerQuery()
is true. | |
Method | clearReopenerTerms | ||
Description |
Clears the reopener query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchReopeningAgentId | ||
Description |
Sets the reopening agent | ||
Parameters | osid.id.Id | agentId | the agent Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearReopeningAgentIdTerms | ||
Description |
Clears the reopening agent | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsReopeningAgentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agent query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getReopeningAgentQuery | ||
Description |
Gets the query for the agent who reopened this issue.
Multiple retrievals produce a nested | ||
Return | osid.authentication.AgentQuery | the agent query | |
Errors | UNIMPLEMENTED | supportsReopeningAgentQuery() is false | |
Compliance | optional | This method must be implemented if supportsReopeningAgentQuery()
is true. | |
Method | clearReopeningAgentTerms | ||
Description |
Clears the reopner query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchReopenedDate | ||
Description |
Matches issues reopened within the given date range inclusive. | ||
Parameters | osid.calendaring.DateTime | from | the range start |
osid.calendaring.DateTime | to | the range end | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyReopenedDate | ||
Description |
Matches issues that have any reopened date. | ||
Parameters | boolean | match | true to match issues with any reopened date, false
to match issues with no reopened date |
Compliance | mandatory | This method must be implemented. | |
Method | clearReopenedDateTerms | ||
Description |
Clears the reopened date query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDueDate | ||
Description |
Matches issue due dates within the given date range inclusive. | ||
Parameters | osid.calendaring.DateTime | from | the range start |
osid.calendaring.DateTime | to | the range end | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyDueDate | ||
Description |
Matches issues that have any due date. | ||
Parameters | boolean | match | true to match issues with any due date, false
to match issues with no due date |
Compliance | mandatory | This method must be implemented. | |
Method | clearDueDateTerms | ||
Description |
Clears the due date query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchPending | ||
Description |
Matches issues that are pending a customer response. | ||
Parameters | boolean | match | true to match pending issues, false otherwise |
Compliance | mandatory | This method must be implemented. | |
Method | clearPendingTerms | ||
Description |
Clears the pending query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchBlockingIssueId | ||
Description |
Sets the blocking issue | ||
Parameters | osid.id.Id | issueId | the issue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | issueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearBlockingIssueIdTerms | ||
Description |
Clears the blocking issue issue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBlockingIssueQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a blocking issue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlockingIssueQuery | ||
Description |
Gets the query for a blocking issue. Multiple
retrievals produce a nested | ||
Return | osid.tracking.IssueQuery | the blocking issue query | |
Errors | UNIMPLEMENTED | supportsBlockingIssueQuery() is false | |
Compliance | optional | This method must be implemented if supportsBlockingIssueQuery()
is true. | |
Method | matchAnyBlockingIssue | ||
Description |
Matches any blocking issue. | ||
Parameters | boolean | match | true to match blocking issues, false to match
issues not blocking |
Compliance | mandatory | This method must be implemented. | |
Method | clearBlockingIssueTerms | ||
Description |
Clears the blocking issue query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchBlockedIssueId | ||
Description |
Sets the blocked issue | ||
Parameters | osid.id.Id | issueId | the issue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | issueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearBlockedIssueIdTerms | ||
Description |
Clears the blocked issue issue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBlockedIssueQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a blocked issue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlockedIssueQuery | ||
Description |
Gets the query for a blocked issue. Multiple retrievals
produce a nested | ||
Return | osid.tracking.IssueQuery | the blocking issue query | |
Errors | UNIMPLEMENTED | supportsBlockedIssueQuery() is false | |
Compliance | optional | This method must be implemented if supportsBlockedIssueQuery()
is true. | |
Method | matchAnyBlockedIssue | ||
Description |
Matches any issue blocked. | ||
Parameters | boolean | match | true to match issues blocked, false to match
issues that are not blocked |
Compliance | mandatory | This method must be implemented. | |
Method | clearBlockedIssueTerms | ||
Description |
Clears the blocked issue query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchResolverId | ||
Description |
Sets the resolver | ||
Parameters | osid.id.Id | resourceId | the resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearResolverIdTerms | ||
Description |
Clears the resolver | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsResolverQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResolverQuery | ||
Description |
Gets the query for the resource who resolved this
issue. Multiple retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsResolverQuery() is false | |
Compliance | optional | This method must be implemented if supportsResolverQuery()
is true. | |
Method | clearResolverTerms | ||
Description |
Clears the resolver query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchResolvingAgentId | ||
Description |
Sets the resolving agent | ||
Parameters | osid.id.Id | agentId | the agent Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearResolvingAgentIdTerms | ||
Description |
Clears the resolving agent | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsResolvingAgentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agent query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResolvingAgentQuery | ||
Description |
Gets the query for the agent who resolved this issue.
Multiple retrievals produce a nested | ||
Return | osid.authentication.AgentQuery | the agent query | |
Errors | UNIMPLEMENTED | supportsResolvingAgentQuery() is false | |
Compliance | optional | This method must be implemented if supportsResolvingAgentQuery()
is true. | |
Method | clearResolvingAgentTerms | ||
Description |
Clears the resolving query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchResolvedDate | ||
Description |
Matches issue resolved dates within the given date range inclusive. | ||
Parameters | osid.calendaring.DateTime | from | the range start |
osid.calendaring.DateTime | to | the range end | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyResolvedDate | ||
Description |
Matches any issue that has been resolved. | ||
Parameters | boolean | match | true to match resolved issues, false to match
unresolved issues |
Compliance | mandatory | This method must be implemented. | |
Method | clearResolvedDateTerms | ||
Description |
Clears the resolved date query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchResolutionType | ||
Description |
Matches issues with the given resolution type. | ||
Parameters | osid.type.Type | resolutionType | the resolution Type |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resolutionType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearResolutionTypeTerms | ||
Description |
Clears the resolution type query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCloserId | ||
Description |
Sets the closer resource | ||
Parameters | osid.id.Id | resourceId | the resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCloserIdTerms | ||
Description |
Clears the closer resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCloserQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCloserQuery | ||
Description |
Gets the query for the agent who closed this issue.
Multiple retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsCloserQuery() is false | |
Compliance | optional | This method must be implemented if supportsCloserQuery() is
true. | |
Method | clearCloserTerms | ||
Description |
Clears the closer query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchClosingAgentId | ||
Description |
Sets the closing agent | ||
Parameters | osid.id.Id | agentId | the agent Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearClosingAgentIdTerms | ||
Description |
Clears the closing agent | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsClosingAgentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a closing agent query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getClosingAgentQuery | ||
Description |
Gets the query for the agent who closed this issue.
Multiple retrievals produce a nested | ||
Return | osid.authentication.AgentQuery | the agent query | |
Errors | UNIMPLEMENTED | supportsClosingAgentQuery() is false | |
Compliance | optional | This method must be implemented if supportsClosingAgentQuery()
is true. | |
Method | clearClosingAgentTerms | ||
Description |
Clears the closing agent query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchClosedDate | ||
Description |
Matches issue closed dates within the given date range inclusive. | ||
Parameters | osid.calendaring.DateTime | from | the range start |
osid.calendaring.DateTime | to | the range end | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyClosedDate | ||
Description |
Matches any issue that has been closed. | ||
Parameters | boolean | match | true to match closed issues, false to match
unclosed issues |
Compliance | mandatory | This method must be implemented. | |
Method | clearClosedDateTerms | ||
Description |
Clears the closed date query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAssignedResourceId | ||
Description |
Sets the currently assigned resource | ||
Parameters | osid.id.Id | resourceId | the resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAssignedResourceIdTerms | ||
Description |
Clears the currently assigned resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAssignedResourceQuery | ||
Description |
Tests if a | ||
Return | boolean | true if an assigned resource query is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignedResourceQuery | ||
Description |
Gets the query for the current assigned resource.
Multiple retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsAssignedResourceQuery() is false | |
Compliance | optional | This method must be implemented if supportsAssignedResourceQuery()
is true. | |
Method | matchAnyAssignedResource | ||
Description |
Matches any issue that has any current assigned resource. | ||
Parameters | boolean | match | true to match issues with any currently assigned resource,
false to match issues with no currently assigned resource |
Compliance | mandatory | This method must be implemented. | |
Method | clearAssignedResourceTerms | ||
Description |
Clears the current assigned resource query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchResourceId | ||
Description |
Sets the resource | ||
Parameters | osid.id.Id | resourceId | the resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearResourceIdTerms | ||
Description |
Clears the assigned resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsResourceQuery | ||
Description |
Tests if a | ||
Return | boolean | true if an assigned resource query is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceQuery | ||
Description |
Gets the query for the assigned resource. Multiple
retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsResourceQuery() is false | |
Compliance | optional | This method must be implemented if supportsResourceQuery()
is true. | |
Method | matchAnyResource | ||
Description |
Matches any issue that has any assigned resource. | ||
Parameters | boolean | match | true to match issues with any resource ever assigned,
false to match issues that never had an assigned resource |
Compliance | mandatory | This method must be implemented. | |
Method | clearResourceTerms | ||
Description |
Clears the resource query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchLogEntryId | ||
Description |
Sets the log entry | ||
Parameters | osid.id.Id | logEntryId | the log entry Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | logEntryId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearLogEntryIdTerms | ||
Description |
Clears the log entry | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogEntryQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a log entry query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntryQuery | ||
Description |
Gets the query for a log entry. Multiple retrievals
produce a nested | ||
Return | osid.tracking.LogEntryQuery | the log entry query | |
Errors | UNIMPLEMENTED | supportsLogEntryQuery() is false | |
Compliance | optional | This method must be implemented if supportsLogEntryQuery()
is true. | |
Method | matchAnyLogEntry | ||
Description |
Matches issues that are used on any log entry. | ||
Parameters | boolean | match | true to match issues with any log entry, false
to match issues with no log entries |
Compliance | mandatory | This method must be implemented. | |
Method | clearLogEntryTerms | ||
Description |
Clears the log entry query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchFrontOfficeId | ||
Description |
Sets the front office | ||
Parameters | osid.id.Id | frontOfficeId | the front office Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | frontOfficeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearFrontOfficeIdTerms | ||
Description |
Clears the front office | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsFrontOfficeQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a front office query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficeQuery | ||
Description |
Gets the query for a front office. Multiple retrievals
produce a nested | ||
Return | osid.tracking.FrontOfficeQuery | the front office query | |
Errors | UNIMPLEMENTED | supportsFrontOfficeQuery() is false | |
Compliance | optional | This method must be implemented if supportsFrontOfficeQuery()
is true. | |
Method | clearFrontOfficeTerms | ||
Description |
Clears the front office query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssueQueryRecord | ||
Description |
Gets the issue query record corresponding to the given
| ||
Parameters | osid.type.Type | issueRecordType | a issue record type |
Return | osid.tracking.records.IssueQueryRecord | the issue query 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. |