Skip navigation links

oracle.imaging
Class Batch

java.lang.Object
oracle.imaging.Batch

public class Batch

extends java.lang.Object

A Batch represents a set of documents that were indexed together into the system. After the Batch is created with the Batch Service createBatch method documents can be added to it until it is completed. Once a batch is completed then no new documents can be added to it. Batches can only index into one Application and cannot span multiple Applications.

See Also:

BatchService

Nested Class Summary

static class

Batch.BatchState The flags of the various stages of a batch

Constructor Summary

Batch()

Batch(long id)

Method Summary

long	getBatchId() Queries for the unique identifier for the batch.
java.lang.String	getCreatedByProcess() Returns the name of the process or application that created the batch.
Batch.BatchState	getCurrentState() Gets the current state of the batch.
java.util.Date	getEndTime() Retrieves the end sourceTime for a completed batch.
java.lang.Integer	getFailedDocCount() Returns the number of documents in the batch that failed the filing process.
NameId	getOriginatingInput() Retrieves the Name Id value of the Input that generated the batch.
java.lang.String	getSourceName() Returns the batch source sourceName.
java.util.Date	getSourceTime() Gets the batch source sourceTime value, for example the file sourceTime.
java.util.Date	getStartTime() Retrieves the sourceTime the filing was started.
java.lang.Integer	getSuccessfulDocCount() Returns the number of documents that were successfully indexed in the batch.
NameId	getTargetApp() Fetches the application the batch is hitting.
void	setBatchId(long batchId) The Batch ID is the system identifier for a specific batch and is used by the system to look up specific batches.
void	setCreatedByProcess(java.lang.String originatingApp) Saves the name of the application that processed the filing into the batch structure.
void	setCurrentState(Batch.BatchState currentState) Updates the current batch state.
void	setEndTime(java.util.Date endTime) This sets the filing stop sourceTime to the batch, which should represent when the last object was saved to the system.
void	setFailedDocCount(java.lang.Integer failedDocCount) Sets the number of documents that were processed during the batch but could not be indexed.
void	setOriginatingInput(NameId originatingInput) This method stores the name guid value of the Input that was used to generate the batch.
void	setSourceName(java.lang.String name) Applies a new source sourceName to the batch.
void	setSourceTime(java.util.Date time) Saves a new sourceTime of the batch source.
void	setStartTime(java.util.Date time) Applies a new Batch Start time to the Batch.
void	setSuccessfulDocCount(java.lang.Integer successfulDocCount) Applies the number of documents that were successfully processed in the batch.
void	setTargetApp(NameId newtargetApp) Sets the targetItemId application that the batch is filing against.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Batch

public Batch()

Batch

public Batch(long id)

Method Detail

setBatchId

public void setBatchId(long batchId)

The Batch ID is the system identifier for a specific batch and is used by the system to look up specific batches. This setter is used by the IPM system and should not be used outside of the API. Setting a Batch ID to something other than the system provided value has unspecified results.

Parameters:

batchId - A unique ID to assign to a Batch.

getBatchId

public long getBatchId()

Queries for the unique identifier for the batch.

Returns:

The Batch ID

setSuccessfulDocCount

public void setSuccessfulDocCount(java.lang.Integer successfulDocCount)

Applies the number of documents that were successfully processed in the batch.

Parameters:

successfulDocCount - The number of good documents in the batch.

getSuccessfulDocCount

public java.lang.Integer getSuccessfulDocCount()

Returns the number of documents that were successfully indexed in the batch.

Returns:

The successful document count

setFailedDocCount

public void setFailedDocCount(java.lang.Integer failedDocCount)

Sets the number of documents that were processed during the batch but could not be indexed.

Parameters:

failedDocCount - The bad document count to set in the batch.

getFailedDocCount

public java.lang.Integer getFailedDocCount()

Returns the number of documents in the batch that failed the filing process.

Returns:

The number of bad documents in the batch.

setCreatedByProcess

public void setCreatedByProcess(java.lang.String originatingApp)

Saves the name of the application that processed the filing into the batch structure. This is useful for keeping a history of what process or application processed the batch.

Parameters:

originatingApp - The name of the application that filed the batch

getCreatedByProcess

public java.lang.String getCreatedByProcess()

Returns the name of the process or application that created the batch.

Returns:

The process or application name for the batch.

setOriginatingInput

public void setOriginatingInput(NameId originatingInput)

This method stores the name guid value of the Input that was used to generate the batch.

Parameters:

originatingInput - The NameId of the source Input.

getOriginatingInput

public NameId getOriginatingInput()

Retrieves the Name Id value of the Input that generated the batch.

Returns:

The NameId of the source Input

setTargetApp

public void setTargetApp(NameId newtargetApp)

Sets the targetItemId application that the batch is filing against.

Parameters:

newtargetApp - The application object.

getTargetApp

public NameId getTargetApp()

Fetches the application the batch is hitting.

Returns:

The application the batch is filing to.

setStartTime

public void setStartTime(java.util.Date time)

Applies a new Batch Start time to the Batch.

Parameters:

time - The time to set the Batch Start time to.

getStartTime

public java.util.Date getStartTime()

Retrieves the sourceTime the filing was started.

Returns:

The batch start sourceTime.

setEndTime

public void setEndTime(java.util.Date endTime)

This sets the filing stop sourceTime to the batch, which should represent when the last object was saved to the system. If the end sourceTime is not set when BatchService.commitBatch is called the batch service will apply an end sourceTime to the batch.

Parameters:

endTime - The end sourceTime of the batch.

getEndTime

public java.util.Date getEndTime()

Retrieves the end sourceTime for a completed batch.

Returns:

The sourceTime that the batch object completed processing.

setCurrentState

public void setCurrentState(Batch.BatchState currentState)

Updates the current batch state. Note that changing the batch state by itself will not have any effect on the API, a bacth will only get locked out of further processing by calling BatchService.commitBatch(Batch)

Parameters:

currentState - The new state of the batch.

getCurrentState

public Batch.BatchState getCurrentState()

Gets the current state of the batch.

Returns:

The current batch state.

setSourceName

public void setSourceName(java.lang.String name)

Applies a new source sourceName to the batch.

Parameters:

name - The sourceName of the batch source.

getSourceName

public java.lang.String getSourceName()

Returns the batch source sourceName.

Returns:

Name of the batch source.

setSourceTime

public void setSourceTime(java.util.Date time)

Saves a new sourceTime of the batch source.

Parameters:

time - The batch source sourceTime.

getSourceTime

public java.util.Date getSourceTime()

Gets the batch source sourceTime value, for example the file sourceTime.

Returns:

The batch source sourceTime.

Skip navigation links