BatchJobResultService

• getBatchJobResult
• getBatchJobResultsByIds
• getBatchJobResultIdsByType
• getBatchJobResultIdsByTypeSinceDateCreated
• getBatchJobResultIdsByTypeAndParameter
• getBatchJobResultIdsByTypeAndGlobalResult
• createBatchJobResult
• updateBatchJobResult
• updateBatchJobProgress
• deleteBatchJobResult
• validateBatchJobResult
• getBatchJobResultItemsByResultId
• getBatchJobResultItemIdsByResultTypeAndSourceId
• getBatchJobResultItemIdsByResultTypeAndTargetId
• getBatchJobResultItem
• getBatchJobResultItemsByIds
• createBatchJobResultItem
• createBatchJobResultItems
• updateBatchJobResultItem
• deleteBatchJobResultItem
• validateBatchJobResultItem

• BatchJobResultInfo
• StatusInfo
• ValidationResultInfo
• BatchJobResultItemInfo

Method	getBatchJobResult
Description	Retrieve information about a BatchJobResult
Parameters	String	batchJobResultId	Unique Id of the BatchJobResult
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	BatchJobResultInfo		???
Errors	DoesNotExistException		batchJobResultId not found
	InvalidParameterException		invalid parameter
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBatchJobResultsByIds
Description	Retrieves a list of batch job results by id list.
Parameters	StringList	batchJobResultIds	List of unique Ids of BatchJobResult
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	BatchJobResultInfoList		???
Errors	DoesNotExistException		batchJobResultId in the list not found
	InvalidParameterException		invalid batchJobResultIds
	MissingParameterException		missing batchJobResultIds
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBatchJobResultIdsByType
Description	Retrieve BatchJobResult Ids by type
Parameters	String	typeKey	Unique key type of BatchJobResult
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		List of BatchJobResult Ids
Errors	DoesNotExistException		typeKey not found
	InvalidParameterException		invalid parameter
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBatchJobResultIdsByTypeSinceDateCreated
Description	Retrieve BatchJobResult Ids by type created on or after a date
Parameters	String	typeKey	Unique key type of BatchJobResult
	Date	sinceDateCreated	the date on which or after the result was created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		List of BatchJobResult Ids
Errors	DoesNotExistException		typeKey not found
	InvalidParameterException		invalid parameter
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBatchJobResultIdsByTypeAndParameter
Description	Retrieve BatchJobResult Ids by type and the value of a single parameter
Parameters	String	typeKey	Unique key type of BatchJobResult
	AttributeInfo	parameter	key value pair used to match an existing parameter
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		List of BatchJobResult Ids
Errors	DoesNotExistException		typeKey not found
	InvalidParameterException		invalid parameter
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBatchJobResultIdsByTypeAndGlobalResult
Description	Retrieve BatchJobResult Ids by type and the value of a single global result
Parameters	String	typeKey	Unique key type of BatchJobResult
	AttributeInfo	globalResult	key value pair used to match an single global result
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		List of BatchJobResult Ids
Errors	DoesNotExistException		typeKey not found
	InvalidParameterException		invalid parameter
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createBatchJobResult
Description	Creates a new BatchJobResult
Parameters	String	batchJobResultTypeKey	batch job result type key
	BatchJobResultInfo	batchJobResultInfo	object to be created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	BatchJobResultInfo		newly created BatchJobResultInfo
Errors	DoesNotExistException		termId or batchJobResultTypeKey not found
	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???

Back to Operations

Method	updateBatchJobResult
Description	Updates an existing BatchJobResult.
Parameters	String	batchJobResultId	Id of BatchJobResult to be updated
	BatchJobResultInfo	batchJobResultInfo	Details of updates to the BatchJobResult
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	BatchJobResultInfo		updated BatchJobResult
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		the BatchJobResult does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	updateBatchJobProgress
Description	Update progress information
Parameters	String	batchJobResultId	Id of BatchJobResult to be updated
	Integer	itemsProcessed	new count of the number of items processed
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	BatchJobResultInfo		StatusInfo indicates the update worked
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		the BatchJobResult does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	deleteBatchJobResult
Description	Deletes an existing BatchJobResult.
Parameters	String	batchJobResultId	the Id of the ActivityOffering to be deleted
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		the SeatPoolDefinition does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateBatchJobResult
Description	Validates a BatchJobResult. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the academic calendar and a record is found for that identifier, the validation checks if the academic calendar can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationType	Identifier of the extent of validation
	BatchJobResultInfo	batchJobResultInfo	the batchJobResult information to be tested.
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		the results from performing the validation
Errors	DoesNotExistException		validationTypeKey not found
	InvalidParameterException		invalid validationTypeKey, batchJobResultInfo
	MissingParameterException		missing validationTypeKey, batchJobResultInfo
	OperationFailedException		unable to complete request

Back to Operations

Method	getBatchJobResultItemsByResultId
Description	Retrieves a list of result items associated with the batch job result id
Parameters	String	batchJobResultId	Unique Ids of the rollover results for which the items are to be fetched
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	BatchJobResultItemInfoList		???
Errors	DoesNotExistException		batchJobResultId in the list not found
	InvalidParameterException		invalid parameter
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBatchJobResultItemIdsByResultTypeAndSourceId
Description	Retrieves a list of result item ids associated with a particular batch job result type and a source id. This would allows you to get all the result items associated with a particular course offering that has been rolled over.
Parameters	String	batchJobResultTypeKey	Unique Ids of the rollover results for which the items are to be fetched
	String	sourceId	source id to be matched
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		???
Errors	DoesNotExistException		batchJobResultId in the list not found
	InvalidParameterException		invalid parameter
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBatchJobResultItemIdsByResultTypeAndTargetId
Description	Retrieves a list of result item ids associated with a particular batch job result type and a source id. This would allows you to get all the result items associated with a particular course offering that has been created via a rolled over.
Parameters	String	batchJobResultTypeKey	Unique Ids of the rollover results for which the items are to be fetched
	String	targetId	target id to be matched
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		???
Errors	DoesNotExistException		batchJobResultId in the list not found
	InvalidParameterException		invalid parameter
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBatchJobResultItem
Description	Retrieve information about a BatchJobResultItem
Parameters	String	batchJobResultItemId	Unique Id of the BatchJobResultItem
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	BatchJobResultItemInfo		???
Errors	DoesNotExistException		batchJobResultItemId not found
	InvalidParameterException		invalid parameter
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBatchJobResultItemsByIds
Description	Retrieves a list of batch job result items by id list.
Parameters	StringList	batchJobResultItemIds	List of unique Ids of BatchJobResultItem
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	BatchJobResultItemInfoList		???
Errors	DoesNotExistException		batchJobResultItemId in the list not found
	InvalidParameterException		invalid batchJobResultItemIds
	MissingParameterException		missing batchJobResultItemIds
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createBatchJobResultItem
Description	Creates a new BatchJobResultItem
Parameters	String	batchJobResultId	Id of the corresponding batch job result
	String	batchJobResultItemTypeKey	batch job result type key
	BatchJobResultItemInfo	batchJobResultItemInfo	object to be created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	BatchJobResultItemInfo		newly created BatchJobResultItemInfo
Errors	DoesNotExistException		termId or batchJobResultItemTypeKey not found
	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???

Back to Operations

Method	createBatchJobResultItems
Description	Bulk create of BatchJobResultItems All must be for the same result but the types may vary.
Parameters	String	batchJobResultId	Id of the corresponding batch job result
	BatchJobResultItemInfoList	batchJobResultItemInfos	objects to be created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	Integer		count of number of items created
Errors	DoesNotExistException		termId or batchJobResultItemTypeKey not found
	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???

Back to Operations

Method	updateBatchJobResultItem
Description	Updates an existing BatchJobResultItem.
Parameters	String	batchJobResultItemId	Id of BatchJobResultItem to be updated
	BatchJobResultItemInfo	batchJobResultItemInfo	Details of updates to the BatchJobResultItem
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	BatchJobResultItemInfo		updated BatchJobResultItem
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		the BatchJobResultItem does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		???
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	deleteBatchJobResultItem
Description	Deletes an existing BatchJobResultItem.
Parameters	String	batchJobResultItemId	the Id of the ActivityOffering to be deleted
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		the SeatPoolDefinition does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateBatchJobResultItem
Description	Validates a BatchJobResultItem. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the academic calendar and a record is found for that identifier, the validation checks if the academic calendar can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationType	Identifier of the extent of validation
	BatchJobResultItemInfo	batchJobResultItemInfo	the batchJobResultItem information to be tested.
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		the results from performing the validation
Errors	DoesNotExistException		validationTypeKey not found
	InvalidParameterException		invalid validationTypeKey, batchJobResultItemInfo
	MissingParameterException		missing validationTypeKey, batchJobResultItemInfo
	OperationFailedException		unable to complete request

Back to Operations