|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.imaging.Batch
public class Batch
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.
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 |
---|
public Batch()
public Batch(long id)
Method Detail |
---|
public void setBatchId(long batchId)
batchId
- A unique ID to assign to a Batch.public long getBatchId()
public void setSuccessfulDocCount(java.lang.Integer successfulDocCount)
successfulDocCount
- The number of good documents in the batch.public java.lang.Integer getSuccessfulDocCount()
public void setFailedDocCount(java.lang.Integer failedDocCount)
failedDocCount
- The bad document count to set in the batch.public java.lang.Integer getFailedDocCount()
public void setCreatedByProcess(java.lang.String originatingApp)
originatingApp
- The name of the application that filed the batchpublic java.lang.String getCreatedByProcess()
public void setOriginatingInput(NameId originatingInput)
originatingInput
- The NameId of the source Input.public NameId getOriginatingInput()
public void setTargetApp(NameId newtargetApp)
newtargetApp
- The application object.public NameId getTargetApp()
public void setStartTime(java.util.Date time)
time
- The time to set the Batch Start time to.public java.util.Date getStartTime()
public void setEndTime(java.util.Date endTime)
endTime
- The end sourceTime of the batch.public java.util.Date getEndTime()
public void setCurrentState(Batch.BatchState currentState)
BatchService.commitBatch(Batch)
currentState
- The new state of the batch.public Batch.BatchState getCurrentState()
public void setSourceName(java.lang.String name)
name
- The sourceName of the batch source.public java.lang.String getSourceName()
public void setSourceTime(java.util.Date time)
time
- The batch source sourceTime.public java.util.Date getSourceTime()
|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |