Show / Hide Table of Contents
  • BC HTML Api reference
    • html-api
      • AnnotationArrowOrientation
      • AnnotationTextAlignment
      • AnnotationTextFontFamily
      • BarcodeOrientation
      • BarcodeThresholdMode
      • BarcodeType
      • BatchEnums
        • Mode
        • Queue
      • CallContext
      • DbClient
      • DbServer
      • FileMimeType
      • FileType
      • IAnnotation
      • IAnnotationProperties
      • IApplication
      • IBarcodeData
      • IBaseControl
      • IBatch
      • IBatchClass
      • IButton
      • ICheckBox
      • IComboBox
      • ICustomThemeConfig
      • IDocument
      • IDocumentClass
      • IField
      • IFieldValidation
      • IFileInfo
      • IFolder
      • IFolderClass
      • IFormType
      • IGroup
      • IIndexClass
      • IITModule
      • IJob
      • ILabel
      • ILicenseGroup
      • IListItem
      • IListView
      • ImageColorMode
      • ImageOperationType
      • INode
      • INodeComment
      • INodeReviewComment
      • INuanceEngineConfig
      • IOCRConfiguration
      • IPage
        • Side
      • IRadioButton
      • IRecognitionProfile
      • IRectangle
      • IRegexValidation
      • IScanProfile
      • ITable
      • ITabView
      • ITextBox
      • IthConfig
      • ITitledPanel
      • IUser
      • LevelName
      • NodeReviewStatus
      • NuanceEngine
      • NuanceLanguage
      • NuanceMode
      • PageSideMode
      • RecognitionEngine
      • RpcService
      • ScanService
      • ScanSource
      • ScriptActionType
      • ScriptResultConsts
      • ScriptResultProp
      • UnloadReason

Interface IBatch

Represents a Batch in the ImageTrust system.

Note: Write-access to properties depends on the context in which the model is used. When in a read-only context, set* methods will throw an UnmodifiableException.

Inheritance
INode

Properties list

createDate createUser creator description imprinterIndex name notes priority status
Inherited Properties
allNodes
batch
childCount
children
documentCount
documents
fields
folderCount
folders
id
indexClass
job
jobName
levelIndex
levelName
name
nodeIndex
pageCount
pages
parent
properties
reviewComments
stackCount
stacks
typeName
userObject
uuid

Methods list

createDocument() createFolder() createPage() getClientStepName() getCreateDate() getCreateUser() getCreator() getDescription() getImprinterIndex() getNextNodeToIndex() getNotes() getPriority() getSplitFromOriginalBatchId() getStatus() setDescription(description) setImprinterIndex(imprinterIndex) setName(name) setPriority(priority) setStatus(status)
Inherited Methods
add(newChild)
assignDefaultValuesToEmptyIndexFields(doChildren)
deleteProperty(name)
duplicate()
evaluate(expression)
executeDbActions(onMultipleResultsUseFirst)
getAllNodes()
getBatch()
getChildCount()
getChildren()
getDocumentCount()
getDocuments()
getField(name)
getFields()
getFieldsAsList()
getFieldValue(field)
getFieldValues(field)
getFolderCount()
getFolders()
getId()
getIndexClass()
getIndexClasses()
getJob()
getJobName()
getLevelIndex()
getLevelName()
getName()
getNodeIndex()
getPageCount()
getPages()
getParent()
getProperties()
getProperty(name)
getReviewComments()
getStackCount()
getStacks()
getTable(name)
getTypeName()
getUserObject()
getUuid()
insert(newChild, childIndex)
isAtLeastOneFieldEmptyOrInvalid(checkRequiredFieldsOnly)
isNodeRejected(checkChildren)
merge(target, childIndex)
removeAllChildren()
removeFromParent()
setIndexClass(indexClass)
setProperty(name, value, deleteIfEmpty)
setUserObject(userObject)

Properties

createDate

The date and time this Batch was created. see IBatch.getCreateDate()

Declaration
readonly createDate: Date;
Property Value
Type Description
Date

createUser

see IBatch.getCreateUser()

Declaration
readonly createUser: string;
Property Value
Type Description
string

creator

The User that created this Batch

see IBatch.getCreator()

Declaration
readonly creator: IUser;
Property Value
Type Description
IUser

description

see IBatch.getDescription(), IBatch.setDescription()

Declaration
description: string;
Property Value
Type Description
string

imprinterIndex

see IBatch.getImprinterIndex()

Declaration
imprinterIndex: number;
Property Value
Type Description
number

name

see IBatch.setName()

Declaration
name: string;
Property Value
Type Description
string

notes

see IBatch.getNotes()

Declaration
readonly notes: string;
Property Value
Type Description
string

priority

see IBatch.getPriority(), IBatch.setPriority()

Declaration
priority: number;
Property Value
Type Description
number

status

see IBatch.getStatus(), IBatch.setStatus()

Declaration
status: string;
Property Value
Type Description
string

Methods

createDocument()

Creates a new Document

**Only available in Core Service and Import Service contexts**

context
Not available.
context
Not available.
Declaration
createDocument(): IDocument;
Returns
Type Description
IDocument

the newly created document

createFolder()

Creates a new Folder

**Only available in Core Service and Import Service contexts**

context
Not available.
context
Not available.
Declaration
createFolder(): IFolder;
Returns
Type Description
IFolder

the newly created folder

createPage()

Creates a new Page

**Only available in Core Service and Import Service contexts**

context
Not available.
context
Not available.
Declaration
createPage(): IPage;
Returns
Type Description
IPage

getClientStepName()

Returns the name of the Workflow Step where this Batch is currently placed by the client. Normally the Process defines the current Step, which is the Workflow Step where the Batch was when it was opened or created. The name of this Step may be different than the name returned by this function, if the User has advanced the Batch in its Workflow by going into an Index step.

Declaration
getClientStepName(): string;
Returns
Type Description
string

the name of an Indexing step if the Batch has advanced from the opening Workflow Step, or null

getCreateDate()

Returns the date and time this Batch was created.

Declaration
getCreateDate(): Date;
Returns
Type Description
Date

the date of batch creation

getCreateUser()

Returns the username of the user that created this Batch.

Declaration
getCreateUser(): string;
Returns
Type Description
string

the username of the user that created this Batch

getCreator()

Returns the IUser that created this Batch.

Declaration
getCreator(): IUser;
Returns
Type Description
IUser

the User that created this Batch

getDescription()

Returns the description of this Batch.

Declaration
getDescription(): string;
Returns
Type Description
string

string

getImprinterIndex()

Declaration
getImprinterIndex(): number;
Returns
Type Description
number

the current imprinter index value

getNextNodeToIndex()

Returns the next node that should be indexed. This method can be used to see if indexing has been completed for this batch.

Declaration
getNextNodeToIndex(): INode;
Returns
Type Description
INode

the next node that required indexing, null if indexing has been completed

getNotes()

Returns any notes made for this Batch.

Declaration
getNotes(): string;
Returns
Type Description
string

string

getPriority()

Returns the priority of this Batch. Higher numbers denote a higher priority.

Declaration
getPriority(): number;
Returns
Type Description
number

number

getSplitFromOriginalBatchId()

If this Batch is the outcome of a Split Batch action, then this method will return the id of the original Batch on which the first Split Batch action was performed. When a Batch is split, the existing Batch retains its id and a new Batch is created which receives a new id. After the split, on both batches this method will return the same id. If either Batch is split again, the resulting batches will also have the same SplitFromOriginalBathId, which is the id of the first Batch.

For example:
BatchA is split and BatchB is created
BatchA is split and BatchC is created
BatchB is split and BatchD is created
then
for all the Batches above, method getSplitFromOriginalBatchId will return the id of BatchA.

Declaration
getSplitFromOriginalBatchId(): number;
Returns
Type Description
number

if this Batch is the outcome of a Split Batch action, the id of the first Batch, otherwise 0

getStatus()

Returns the current status of this Batch.

Declaration
getStatus(): string;
Returns
Type Description
string

string

setDescription(description)

Sets the description of the Batch.

Declaration
setDescription(description: string): any;
Parameters
Type Name Description
string description

the new description of the Batch

Returns
Type Description
any

setImprinterIndex(imprinterIndex)

Set the current imprinter index value.

Declaration
setImprinterIndex(imprinterIndex: number): any;
Parameters
Type Name Description
number imprinterIndex

index value

Returns
Type Description
any

setName(name)

Sets the name of the Batch to the specified value.

Declaration
setName(name: string): any;
Parameters
Type Name Description
string name

the name of the batch

Returns
Type Description
any

setPriority(priority)

Set the priority of this Batch.

Declaration
setPriority(priority: number): any;
Parameters
Type Name Description
number priority

the new priority of the Batch.

Returns
Type Description
any

setStatus(status)

Set the status of the Batch. This should be one of the values of the IJob.getStatuses().

Declaration
setStatus(status: string): any;
Parameters
Type Name Description
string status

the new status.

Returns
Type Description
any
Back to top Generated by DocFX