com.adobe.icc.services.api
Interface BatchOperationService

public interface BatchOperationService

Method Summary

java.util.List	getAllBatchOperations(Query query) Retrieve the list of batch operations.
BatchOperation	getBatchOperationById(java.lang.String operationId) Fetch a BatchOperation object by the given GUID.
Downloadable	getReportForBatchOperation(java.lang.String operationId) Returns the Downloadable form of the Batch Operation report
BatchOperation	invokeBatchOperation(BatchOperation batchOperation) Invokes a specified batch operation and updates the BatchOperation object with the new run details.
BatchOperation	updateBatchOperation(BatchOperation batchOperation) Update the given BatchOperation.

Method Detail

getBatchOperationById

BatchOperation getBatchOperationById(java.lang.String operationId)
                                     throws ICCException

Fetch a BatchOperation object by the given GUID.

Parameters:

batchOperationName - GUID of the BatchOperation to be fetched.

Returns:

The BatchOperation object.

Throws:

ICCException

getAllBatchOperations

java.util.List getAllBatchOperations(Query query)
                                     throws ICCException

Retrieve the list of batch operations.

Parameters:

query - Query to select batch operations (supports only first level attributes/properties of an object).
The "attributeName" used in the Statement object should be the name of the property in the object (BatchOperation object, in this case).

Returns:

List of BatchOperation

Throws:

ICCException

See Also:

Statement, Query

invokeBatchOperation

BatchOperation invokeBatchOperation(BatchOperation batchOperation)
                                    throws ICCException

Invokes a specified batch operation and updates the BatchOperation object with the new run details.

Parameters:

batchOperationName - BatchOperation name.

triggeredAt - BatchOperation triggeredAt.

triggeredBy - BatchOperation triggeredBy.

status - BatchOperation status.

Returns:

Updated BatchOperation object.

Throws:

ICCException

getReportForBatchOperation

Downloadable getReportForBatchOperation(java.lang.String operationId)
                                        throws ICCException

Returns the Downloadable form of the Batch Operation report

Parameters:

operationId - BatchOperation id.

Returns:

Downloadable BatchOperation operationReport.

Throws:

ICCException

updateBatchOperation

BatchOperation updateBatchOperation(BatchOperation batchOperation)
                                    throws ICCException

Update the given BatchOperation.

Parameters:

batchOperation - BatchOperation object to be updated.

Returns:

updated BatchOperation object.

Throws:

ICCException