OSID Logo
OSID Specifications
tracking batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.batch.IssueBatchAdminSession
Implementsosid.tracking.IssueAdminSession
Description

This session creates, updates, and deletes Issues in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create an Issue, an IssueForm is requested using getIssueFormsForCreate() specifying the desired queues, resources, and record Types or none if no record Types are needed. Each of the returned IssueForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once an IssueForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each IssueForm corresponds to an attempted transaction.

The IssueForms returned from getIssueFormsForCreate() may be linked to the originating request through the peer Ids of the IssueForm. In the case where there may be duplicates, any IssueForm of the same peer Ids may be used for a create operation.

Once a batch of IssueForms are submitted for create, a CreateResponse is returned for each IssueForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createIssues(), errors specific to an individual IssueForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating IssueForm through the IssueForm Id .

For updates, IssueForms are requested to the Issue Id that is to be updated using getIssueFormsForUpdate() where the reference Id in the IssueForm may be used to link the request. Similarly, the IssueForm has metadata about the data that can be updated and it can perform validation before submitting the update. The IssueForm can only be used once for a successful update and cannot be reused.

Once a batch of IssueForms are submitted for update, an UpdateResponse is returned for each IssueForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateIssues(), errors specific to an individual IssueForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating IssueForm through the IssueForm Id.

The delete operations delete Issues in bulk. To unmap an Issue from the current FrontOffice, the IssueFrontOfficeAssignmentSession should be used. These delete operations attempt to remove the Issue itself thus removing it from all known FrontOffice catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetIssueFormsForCreate
Description

Gets the issue forms for creating a bunch of new issues. An issue form is returned for each set of queues and resources.

Parametersosid.tracking.batch.IssuePeerListpeersthe issue peers
osid.type.Type[]issueRecordTypesarray of issue record types to be included in each create operation or an empty list if none
Returnosid.tracking.batch.IssueBatchFormListthe issue forms
ErrorsNOT_FOUNDa resourceId or queueId is not found
NULL_ARGUMENT peers or issueRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateIssues
Description

Creates a new set of Issues. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.tracking.batch.IssueBatchFormListissueFormsthe issue forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT issueForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIssueFormsForUpdate
Description

Gets the issue forms for updating an existing set of issues. A new issue form should be requested for each update transaction.

Parametersosid.id.IdListissueIdsthe Ids of the Issue
Returnosid.tracking.batch.IssueBatchFormListthe issue forms
ErrorsNOT_FOUNDan issueId is not found
NULL_ARGUMENT issueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateIssues
Description

Updates existing issues. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.tracking.batch.IssueBatchFormListissueFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT issueForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllIssues
Description

Deletes all Issues in this FrontOffice .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIssues
Description

Deletes issues for the given Ids.

Parametersosid.id.IdListissueIdsthe Ids of the issues to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT issueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIssuesForQueue
Description

Deletes issues for the given queue.

Parametersosid.id.IdqueueIdthe Ids of a queue
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIssuesForResource
Description

Deletes issues for the given resource.

Parametersosid.id.IdresourceIdthe Ids of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIssuesByDate
Description

Deletes issues ineffective before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasIssues
Description

Adds an Id to an Issue for the purpose of creating compatibility. The primary Id of the Issue is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another issue, it is reassigned to the given issue Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.