OSID Logo
OSID Specifications
financials batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.batch.ActivityBatchAdminSession
Implementsosid.financials.ActivityAdminSession
Description

This session creates, updates, and deletes Activities 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 Activity, an ActivityForm is requested using getActivityFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned ActivityForms 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 ActivityForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ActivityForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Activities in bulk. To unmap an Activity from the current Business, the ActivityBusinessAssignmentSession should be used. These delete operations attempt to remove the Activity itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetActivityFormsForCreate
Description

Gets the activityforms for creating a bunch of new activities.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]activityRecordTypesarray of activity record types to be included in each create operation or an empty list if none
Returnosid.financials.batch.ActivityBatchFormListthe activity forms
ErrorsNULL_ARGUMENT activityRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateActivities
Description

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

Parametersosid.financials.batch.ActivityBatchFormListactivityFormsthe activity forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT activityForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityFormsForUpdate
Description

Gets the activity forms for updating an existing set of activities. A new activityform should be requested for each update transaction.

Parametersosid.id.IdListactivityIdsthe Ids of the Activity
Returnosid.financials.batch.ActivityBatchFormListthe activity form
ErrorsNOT_FOUNDan activityId is not found
NULL_ARGUMENT activityIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateActivities
Description

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

Parametersosid.financials.batch.ActivityBatchFormListactivityFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT activityForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllActivities
Description

Deletes all Activities in this Business .

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

Deletes activities for the given Ids.

Parametersosid.id.IdListactivityIdsthe Ids of the activities to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT activityIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasActivities
Description

Adds an Id to an Activity for the purpose of creating compatibility. The primary Id of the Activity is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another activity, it is reassigned to the given activity 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.