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 IJob

Represents the Job Definition for a Batch.

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

batchClass description
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

createBatch() getAllowedImageModes() getAllowedPageSideMode() getAllowedResolutions() getAllowedScanProfiles() getBatchClass() getDescription() getDocumentClasses() getFolderClasses() getJobImage() getRecognitionProfile() getStatuses() isDecryptionAllowed() isPdfsAsImages() isSupportEDocs()
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

batchClass

see IJob.getBatchClass()

Declaration
readonly batchClass: IBatchClass;
Property Value
Type Description
IBatchClass

description

The description of this Job Definition.

Declaration
readonly description: string;
Property Value
Type Description
string

Methods

createBatch()

Creates a new Batch.

Declaration
createBatch(): IBatch;
Returns
Type Description
IBatch

getAllowedImageModes()

Returns a list of the ImageColorModes that are assigned to this IJob. The following rules apply regarding to which ImageColorMode can be used when scanning:

  • If the IJob has specific ImageColorMode assigned to it, then only these can be used to scan documents.
  • If the IJob does not have ImageColorMode assigned to it, then any ImageColorMode can be used.

context
returns a java.util.List\<ImageColorMode\> instead of ImageColorMode[] and also has an additional GUIPermissions check
context
returns a java.util.List\<ImageColorMode\> instead of ImageColorMode[] and also has an additional GUIPermissions check
Declaration
getAllowedImageModes(): ImageColorMode[];
Returns
Type Description
ImageColorMode[]

getAllowedPageSideMode()

Returns the PageSideMode that is assigned to this IJob. The following rules apply regarding to which PageSideMode can be used when scanning:

  • If the IJob has specific PageSideMode assigned to it, then only this PageSideMode can be used to scan documents.
  • If the IJob does not have PageSideMode assigned to it, then any PageSideMode can be used.

context
has an additional GUIPermissions check
context
has an additional GUIPermissions check
Declaration
getAllowedPageSideMode(): PageSideMode;
Returns
Type Description
PageSideMode

getAllowedResolutions()

Returns a list of the resolution settings (in dpi) that are assigned to this IJob. The following rules apply regarding to which resolutions can be used when scanning:

  • If the IJob has specific resolutions assigned to it, then only these can be used to scan documents.
  • If the IJob does not have any resolutions assigned to it, then any resolution can be used.

context
returns a java.util.List\<Integer\> instead of number[] and also has an additional GUIPermissions check
context
returns a java.util.List\<Integer\> instead of number[] and also has an additional GUIPermissions check
Declaration
getAllowedResolutions(): number[];
Returns
Type Description
number[]

getAllowedScanProfiles()

Returns a list of the IScanProfile that are assigned to this IJob. The following rules apply regarding to which IScanProfile can be used when scanning:

  • If the IJob has specific IScanProfile assigned to it, then only these can be used to scan documents. In this case, local IScanProfile cannot be used.
  • If the IJob does not have IScanProfile assigned to it, then local IScanProfile can be used.

context
returns a java.util.List<IScanProfile> instead of IScanProfile[] and also has an additional GUIPermissions check
context
returns a java.util.List<IScanProfile> instead of IScanProfile[] and also has an additional GUIPermissions check
Declaration
getAllowedScanProfiles(): IScanProfile[];
Returns
Type Description
IScanProfile[]

getBatchClass()

Returns the unique IBatchClass of this job

Declaration
getBatchClass(): IBatchClass;
Returns
Type Description
IBatchClass

getDescription()

The description of this Job Definition.

Declaration
getDescription(): string;
Returns
Type Description
string

getDocumentClasses()

Returns the list of assigned IDocumentClass

context
returns a java.util.List<IDocumentClass> instead of IDocumentClass[]
context
returns a java.util.List<IDocumentClass> instead of IDocumentClass[]
Declaration
getDocumentClasses(): IDocumentClass[];
Returns
Type Description
IDocumentClass[]

getFolderClasses()

Returns the list of assigned IFolderClass

context
returns a java.util.List<IFolderClass> instead of IFolderClass[]
context
returns a java.util.List<IFolderClass> instead of IFolderClass[]
Declaration
getFolderClasses(): IFolderClass[];
Returns
Type Description
IFolderClass[]

getJobImage()

Returns the BufferedImage that was assigned to the IJob. This image is shown on the New Batch dialog, on the combo box that holds the Jobs.

context
is not supported and it always returns undefined
Declaration
getJobImage(): any;
Returns
Type Description
any

getRecognitionProfile()

Returns the Recognition profile that is used by the Job. The recognition operations assigned to the profile will be executed upon import/scanning.

Declaration
getRecognitionProfile(): IRecognitionProfile;
Returns
Type Description
IRecognitionProfile

getStatuses()

Returns a list of available Statuses for this Job

context
returns a java.util.List\<java.lang.String\> instead of string[]
context
returns a java.util.List\<java.lang.String\> instead of string[]
Declaration
getStatuses(): string[];
Returns
Type Description
string[]

isDecryptionAllowed()

Returns whether this Job allows encrypted eDocuments to be decrypted. For this option to be enabled, the Job must also support eDocuments.

Declaration
isDecryptionAllowed(): boolean;
Returns
Type Description
boolean

isPdfsAsImages()

Returns whether pdf files are imported as images. If true, then pdf files are broken into single pages and displayed separately. If false, then pdf files are imported as E-Documents (if IJob.isSupportEDocs() is true).

Declaration
isPdfsAsImages(): boolean;
Returns
Type Description
boolean

isSupportEDocs()

Returns whether this Job support E-Documents. If a Job does not support E-Documents, then only image files (tiff, jpg, bmp etc) can be imported. If a Job supports E-Documents, then all types of files can be imported.

Declaration
isSupportEDocs(): boolean;
Returns
Type Description
boolean
Back to top Generated by DocFX