BatchJobResultInfo

Name BatchJobResultInfo
Usage BatchJobResultService
getBatchJobResult getBatchJobResultsByIds createBatchJobResult updateBatchJobResult updateBatchJobProgress validateBatchJobResult
Type Complex

Description

Object that holds the results of a batch job

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Unique Id String The system assigned unique id to identify this Object.
Could be implemented as as sequence number or as a UUID.

Attempts to set this value on creates should result in a ReadOnlyException being thrown

An Id:

  • An id is used when the actual value is unimportant and
    can therefore be a large hex value for example

  • An id value might be 23b9ca9bd203df902

  • An Id is never intended to be used directly by an end
    user.

  • Ids are assumed to be of different values in different
    KS implementations

  • Id values are generated by the service
    implementations

  • Id values are never expected to be used in
    Configuration or Application code

 Required on updates Read only One Yes  
typeKey Type Key String A unique identifier for the type of this object. Required Read only One Yes  
stateKey State Key String A unique identifier for the state of this object. Required   One Yes  
name Name String A display name for this entity.     One No  
descr Description RichTextInfo A description of the entity.     One No  
parameters Parameters AttributeInfoList The parameters or options specified when the batch job was run

Note the list may be empty but it cannot be null		 Required Read only Many No set during the createBatchJobResult operation
context Context ContextInfo The context under which this batch job was run Required Read only One No set during the createBatchJobResult operation
globalResults Parameters AttributeInfoList Any global results of running the batch job

This may be a number or a count or a newly created id.

This is in addition to individual Result Items that may be created.

Note the list may be empty but like other lists it must not be null		     Many No  
itemsProcessed Items Processed Integer Number of items processed

Used to indicate the progress of the batch job

The batch job does not have to update this field every time it processes
a job it may decide to update it every 10 or 100 or 1000 items processed.

This can be null if the job has not started yet or there are no items
This may or may not correspond with the corresponding Result Items that get created		     One No  
itemsExpected Items Expected Integer Number of items expected to be processed   Read only One No set during the #rolloverSoc operation
message Message RichTextInfo Messages describing details of the status.

Often left null if the status is that it is complete.		   Read only One No set during the #rolloverSoc operation
meta Meta MetaInfo Create and last update info for the structure. This is optional
and treated as read only since the data is set by the internals
of the service during maintenance operations.

Contains audit trail information about the creation and last
update of this object Also contains the version ind used for
optimistic locking.

Attempts to set or update should result in a ReadOnlyException
being thrown.		 Required on updates Read only One No  
attributes Dynamic Attributes AttributeInfoList List of dynamic attributes, each holding a key-value pair that
can be configured to hold additional information for an
implementing institution.

Note: the key may be repeated more than once to simulate a list
of values.		     Many No