public interface BatchJobResultService
| Modifier and Type | Method and Description |
|---|---|
StatusInfo |
changeBatchJobResultItemState(String batchJobResultItemId,
String nextStateKey,
ContextInfo contextInfo)
Updates the state of an existing BatchJobResultItem to another state
provided that it is valid to do so.
|
StatusInfo |
changeBatchJobResultState(String batchJobResultId,
String nextStateKey,
ContextInfo contextInfo)
Updates the state of an existing BatchJobResult to another state
provided that it is valid to do so.
|
BatchJobResultInfo |
createBatchJobResult(String batchJobResultTypeKey,
BatchJobResultInfo batchJobResultInfo,
ContextInfo context)
Creates a new BatchJobResult
|
BatchJobResultItemInfo |
createBatchJobResultItem(String batchJobResultId,
String batchJobResultItemTypeKey,
BatchJobResultItemInfo batchJobResultItemInfo,
ContextInfo context)
Creates a new BatchJobResultItem
|
Integer |
createBatchJobResultItems(String batchJobResultId,
List<BatchJobResultItemInfo> batchJobResultItemInfos,
ContextInfo context)
Bulk create of BatchJobResultItems
All must be for the same result but the types may vary.
|
StatusInfo |
deleteBatchJobResult(String batchJobResultId,
ContextInfo context)
Deletes an existing BatchJobResult.
|
StatusInfo |
deleteBatchJobResultItem(String batchJobResultItemId,
ContextInfo context)
Deletes an existing BatchJobResultItem.
|
BatchJobResultInfo |
getBatchJobResult(String batchJobResultId,
ContextInfo context)
Retrieve information about a BatchJobResult
|
List<String> |
getBatchJobResultIdsByType(String typeKey,
ContextInfo context)
Retrieve BatchJobResult Ids by type
|
List<String> |
getBatchJobResultIdsByTypeAndGlobalResult(String typeKey,
AttributeInfo globalResult,
ContextInfo context)
Retrieve BatchJobResult Ids by type and the value of a single global result
|
List<String> |
getBatchJobResultIdsByTypeAndParameter(String typeKey,
AttributeInfo parameter,
ContextInfo context)
Retrieve BatchJobResult Ids by type and the value of a single parameter
|
List<String> |
getBatchJobResultIdsByTypeSinceDateCreated(String typeKey,
Date sinceDateCreated,
ContextInfo context)
Retrieve BatchJobResult Ids by type created on or after a date
|
BatchJobResultItemInfo |
getBatchJobResultItem(String batchJobResultItemId,
ContextInfo context)
Retrieve information about a BatchJobResultItem
|
List<String> |
getBatchJobResultItemIdsByResultTypeAndSourceId(String batchJobResultTypeKey,
String sourceId,
ContextInfo context)
Retrieves a list of result item ids associated with a particular batch job
result type and a source id.
|
List<String> |
getBatchJobResultItemIdsByResultTypeAndTargetId(String batchJobResultTypeKey,
String targetId,
ContextInfo context)
Retrieves a list of result item ids associated with a particular batch job
result type and a source id.
|
List<BatchJobResultItemInfo> |
getBatchJobResultItemsByIds(List<String> batchJobResultItemIds,
ContextInfo context)
Retrieves a list of batch job result items by id list.
|
List<BatchJobResultItemInfo> |
getBatchJobResultItemsByResultId(String batchJobResultId,
ContextInfo context)
Retrieves a list of result items associated with the batch job result id
|
List<BatchJobResultInfo> |
getBatchJobResultsByIds(List<String> batchJobResultIds,
ContextInfo context)
Retrieves a list of batch job results by id list.
|
BatchJobResultInfo |
updateBatchJobProgress(String batchJobResultId,
Integer itemsProcessed,
ContextInfo context)
Update progress information
|
BatchJobResultInfo |
updateBatchJobResult(String batchJobResultId,
BatchJobResultInfo batchJobResultInfo,
ContextInfo context)
Updates an existing BatchJobResult.
|
BatchJobResultItemInfo |
updateBatchJobResultItem(String batchJobResultItemId,
BatchJobResultItemInfo batchJobResultItemInfo,
ContextInfo context)
Updates an existing BatchJobResultItem.
|
List<ValidationResultInfo> |
validateBatchJobResult(String validationType,
BatchJobResultInfo batchJobResultInfo,
ContextInfo context)
Validates a BatchJobResult.
|
List<ValidationResultInfo> |
validateBatchJobResultItem(String validationType,
BatchJobResultItemInfo batchJobResultItemInfo,
ContextInfo context)
Validates a BatchJobResultItem.
|
BatchJobResultInfo getBatchJobResult(String batchJobResultId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
batchJobResultId - Unique Id of the BatchJobResultcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - batchJobResultId not foundInvalidParameterException - invalid parameterMissingParameterException - missing parameterOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureList<BatchJobResultInfo> getBatchJobResultsByIds(List<String> batchJobResultIds, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
batchJobResultIds - List of unique Ids of BatchJobResultcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - batchJobResultId in the list not foundInvalidParameterException - invalid batchJobResultIdsMissingParameterException - missing batchJobResultIdsOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureList<String> getBatchJobResultIdsByType(String typeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
typeKey - Unique key type of BatchJobResultcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - typeKey not foundInvalidParameterException - invalid parameterMissingParameterException - missing parameterOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureList<String> getBatchJobResultIdsByTypeSinceDateCreated(String typeKey, Date sinceDateCreated, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
typeKey - Unique key type of BatchJobResultsinceDateCreated - the date on which or after the result was createdcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - typeKey not foundInvalidParameterException - invalid parameterMissingParameterException - missing parameterOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureList<String> getBatchJobResultIdsByTypeAndParameter(String typeKey, AttributeInfo parameter, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
typeKey - Unique key type of BatchJobResultparameter - key value pair used to match an existing parametercontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - typeKey not foundInvalidParameterException - invalid parameterMissingParameterException - missing parameterOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureList<String> getBatchJobResultIdsByTypeAndGlobalResult(String typeKey, AttributeInfo globalResult, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
typeKey - Unique key type of BatchJobResultglobalResult - key value pair used to match an single global resultcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - typeKey not foundInvalidParameterException - invalid parameterMissingParameterException - missing parameterOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureBatchJobResultInfo createBatchJobResult(String batchJobResultTypeKey, BatchJobResultInfo batchJobResultInfo, ContextInfo context) throws DoesNotExistException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
batchJobResultTypeKey - batch job result type keybatchJobResultInfo - object to be createdcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - termId or batchJobResultTypeKey not foundDataValidationErrorException - One or more values invalid for this operationInvalidParameterException - One or more parameters invalidMissingParameterException - One or more parameters missingOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureReadOnlyExceptionBatchJobResultInfo updateBatchJobResult(String batchJobResultId, BatchJobResultInfo batchJobResultInfo, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
batchJobResultId - Id of BatchJobResult to be updatedbatchJobResultInfo - Details of updates to the BatchJobResultcontext - Context information containing the principalId and locale
information about the caller of service operationDataValidationErrorException - One or more values invalid for this operationDoesNotExistException - the BatchJobResult does not existInvalidParameterException - One or more parameters invalidMissingParameterException - One or more parameters missingOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureVersionMismatchException - The action was attempted on an out of date version.ReadOnlyExceptionStatusInfo changeBatchJobResultState(String batchJobResultId, String nextStateKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
batchJobResultId - identifier of the BatchJobResult to be
updatednextStateKey - The State Key into which the identified
BatchJobResult will be placed if the
operation succeeds.contextInfo - Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException - the identified BatchJobResult does
not existInvalidParameterException - the contextInfo object is invalidMissingParameterException - One or more parameters missingOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureBatchJobResultInfo updateBatchJobProgress(String batchJobResultId, Integer itemsProcessed, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
batchJobResultId - Id of BatchJobResult to be updateditemsProcessed - new count of the number of items processedcontext - Context information containing the principalId and locale
information about the caller of service operationDataValidationErrorException - One or more values invalid for this operationDoesNotExistException - the BatchJobResult does not existInvalidParameterException - One or more parameters invalidMissingParameterException - One or more parameters missingOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureVersionMismatchException - The action was attempted on an out of date version.ReadOnlyExceptionStatusInfo deleteBatchJobResult(String batchJobResultId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
batchJobResultId - the Id of the ActivityOffering to be deletedcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - the SeatPoolDefinition does not existInvalidParameterException - One or more parameters invalidMissingParameterException - One or more parameters missingOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureList<ValidationResultInfo> validateBatchJobResult(String validationType, BatchJobResultInfo batchJobResultInfo, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
validationType - Identifier of the extent of validationbatchJobResultInfo - the batchJobResult information to be tested.context - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - validationTypeKey not foundInvalidParameterException - invalid validationTypeKey, batchJobResultInfoMissingParameterException - missing validationTypeKey, batchJobResultInfoOperationFailedException - unable to complete requestList<BatchJobResultItemInfo> getBatchJobResultItemsByResultId(String batchJobResultId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
batchJobResultId - Unique Ids of the rollover results for which the items are to be fetchedcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - batchJobResultId in the list not foundInvalidParameterException - invalid parameterMissingParameterException - missing parameterOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureList<String> getBatchJobResultItemIdsByResultTypeAndSourceId(String batchJobResultTypeKey, String sourceId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
batchJobResultTypeKey - Unique Ids of the rollover results for which the items are to be fetchedsourceId - source id to be matchedcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - batchJobResultId in the list not foundInvalidParameterException - invalid parameterMissingParameterException - missing parameterOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureList<String> getBatchJobResultItemIdsByResultTypeAndTargetId(String batchJobResultTypeKey, String targetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
batchJobResultTypeKey - Unique Ids of the rollover results for which the items are to be fetchedtargetId - target id to be matchedcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - batchJobResultId in the list not foundInvalidParameterException - invalid parameterMissingParameterException - missing parameterOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureBatchJobResultItemInfo getBatchJobResultItem(String batchJobResultItemId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
batchJobResultItemId - Unique Id of the BatchJobResultItemcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - batchJobResultItemId not foundInvalidParameterException - invalid parameterMissingParameterException - missing parameterOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureList<BatchJobResultItemInfo> getBatchJobResultItemsByIds(List<String> batchJobResultItemIds, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
batchJobResultItemIds - List of unique Ids of BatchJobResultItemcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - batchJobResultItemId in the list not foundInvalidParameterException - invalid batchJobResultItemIdsMissingParameterException - missing batchJobResultItemIdsOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureBatchJobResultItemInfo createBatchJobResultItem(String batchJobResultId, String batchJobResultItemTypeKey, BatchJobResultItemInfo batchJobResultItemInfo, ContextInfo context) throws DoesNotExistException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
batchJobResultId - Id of the corresponding batch job resultbatchJobResultItemTypeKey - batch job result type keybatchJobResultItemInfo - object to be createdcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - termId or batchJobResultItemTypeKey not foundDataValidationErrorException - One or more values invalid for this operationInvalidParameterException - One or more parameters invalidMissingParameterException - One or more parameters missingOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureReadOnlyExceptionInteger createBatchJobResultItems(String batchJobResultId, List<BatchJobResultItemInfo> batchJobResultItemInfos, ContextInfo context) throws DoesNotExistException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
batchJobResultId - Id of the corresponding batch job resultbatchJobResultItemInfos - objects to be createdcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - termId or batchJobResultItemTypeKey not foundDataValidationErrorException - One or more values invalid for this operationInvalidParameterException - One or more parameters invalidMissingParameterException - One or more parameters missingOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureReadOnlyExceptionBatchJobResultItemInfo updateBatchJobResultItem(String batchJobResultItemId, BatchJobResultItemInfo batchJobResultItemInfo, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
batchJobResultItemId - Id of BatchJobResultItem to be updatedbatchJobResultItemInfo - Details of updates to the BatchJobResultItemcontext - Context information containing the principalId and locale
information about the caller of service operationDataValidationErrorException - One or more values invalid for this operationDoesNotExistException - the BatchJobResultItem does not existInvalidParameterException - One or more parameters invalidMissingParameterException - One or more parameters missingOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureVersionMismatchException - The action was attempted on an out of date version.ReadOnlyExceptionStatusInfo changeBatchJobResultItemState(String batchJobResultItemId, String nextStateKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
batchJobResultItemId - identifier of the BatchJobResultItem to be
updatednextStateKey - The State Key into which the identified
BatchJobResultItem will be placed if the
operation succeeds.contextInfo - Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException - the identified BatchJobResultItem does
not existInvalidParameterException - the contextInfo object is invalidMissingParameterException - One or more parameters missingOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureStatusInfo deleteBatchJobResultItem(String batchJobResultItemId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
batchJobResultItemId - the Id of the ActivityOffering to be deletedcontext - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - the SeatPoolDefinition does not existInvalidParameterException - One or more parameters invalidMissingParameterException - One or more parameters missingOperationFailedException - unable to complete requestPermissionDeniedException - authorization failureList<ValidationResultInfo> validateBatchJobResultItem(String validationType, BatchJobResultItemInfo batchJobResultItemInfo, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
validationType - Identifier of the extent of validationbatchJobResultItemInfo - the batchJobResultItem information to be tested.context - Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException - validationTypeKey not foundInvalidParameterException - invalid validationTypeKey, batchJobResultItemInfoMissingParameterException - missing validationTypeKey, batchJobResultItemInfoOperationFailedException - unable to complete requestCopyright © 2004-2014 The Kuali Foundation. All Rights Reserved.