3 クライアント・スクリプトの作成

この章では、Captureクライアント用のスクリプトを作成するために使用できる様々なイベントおよびクラスについて説明します。

Captureでは、ビジネス要件に応じてカスタム・スクリプトを作成できます。スクリプトは、クライアント・イベントに対するフックとなります。特定のCaptureクライアント・イベントがトリガーされたときに実行されるクライアント・スクリプトを作成できます。

拡張機能を使用すると、クライアント・スクリプトをカスタマイズできます。JavaScript拡張機能を記述して組み込むことにより、Capture機能を拡張できます。JavaScript拡張機能の詳細は、『Oracle WebCenter Enterprise Captureのマネージング』を参照してください。

この章では、次の項目について説明します。

クライアント・イベント

クライアント・スクリプトは、特定のクライアント・イベントの動作をカスタマイズできるJavaScriptモジュールです。

この項では、次のイベントについて説明します:

AttachmentCreated

AttachmentCreatedイベントは、添付が作成された後に発生します。

構文 パラメータ
public void AttachmentCreated(AttachmentCreatedEvent event); AttachmentCreatedEventイベント

AttachmentRemoved

AttachmentRemovedイベントは、添付が削除された後に発生します。

構文 パラメータ
public void AttachmentRemoved(AttachmentRemoveEvent event); AttachmentRemoveEventイベント

AttachmentSelected

AttachmentSelectedイベントは、添付が選択されたときに発生します。

構文 パラメータ
public void AttachmentSelected(AttachmentSelectedEvent event); AttachmentSelectedEventイベント

BatchScanBegin

BatchScanBeginイベントは、バッチのスキャンが開始される直前に発生します。

構文 パラメータ
public void BatchScanBegin(BatchScanEvent event); BatchScanEventイベント

BatchScanComplete

BatchScanCompleteイベントは、バッチのスキャンが完了したときに発生します。

構文 パラメータ
public void BatchScanComplete(BatchScanEvent event); BatchScanEventイベント

BatchSelected

BatchSelectedイベントは、バッチが選択されたときに発生します。

構文 パラメータ
public void BatchSelected(BatchSelectedEvent event); BatchScanEventイベント

CaptureImage

CaptureImageイベントは、イメージがスキャン・ソースからキャプチャされる直前に発生します。

構文 パラメータ
public void CaptureImage(ImageCaptureEvent event); ImageCaptureEventイベント

CaptureInitialize

CaptureInitializeイベントは、イメージがキャプチャされる前に発生し、キャプチャ・ソースのプロパティを初期化するために使用できます。

構文 パラメータ
public void CaptureInitialize(ImageCaptureEvent event); ImageCaptureEventイベント

DBSearchComplete

DBSearchCompleteイベントは、データベース検索が完了して結果が処理される前に発生します。

構文 パラメータ
public void DBSearchComplete(DBSearchEvent event); DBSearchEventイベント

DBSearchResults

DBSearchResultsイベントは、データベース検索結果の処理中に発生します。

構文 パラメータ
public void DBSearchResults(DBSearchEvent event); DBSearchEventイベント

DBSearchStart

DBSearchStartイベントは、データベース検索の直前に発生します。

構文 パラメータ
public void DBSearchStart(DBSearchEvent event); DBSearchEventイベント

DocumentCreated

DocumentCreatedイベントは、ドキュメントが作成された後に発生します。

構文 パラメータ
public void DocumentCreated(CaptureDocument document); CaptureDocumentドキュメント

DocumentRemoved

DocumentRemovedイベントは、ドキュメントが削除された後に発生します。

構文 パラメータ
public void DocumentRemoved(DocumentRemoveEvent event); DocumentRemoveEventイベント

DocumentSelected

DocumentSelectedイベントは、ドキュメントが選択されたときに発生します。

構文 パラメータ
public void DocumentSelected(DocumentSelectedEvent event); DocumentSelectedEventイベント

FieldGotFocus

FieldGotFocusイベントは、メタデータ・フィールドが入力フォーカスを受け取ったときに発生します。

構文 パラメータ
public void FieldGotFocus(FieldEvent event); FieldEventイベント

FieldLostFocus

FieldLostFocusイベントは、フィールドが入力フォーカスを失ったときに発生します。

構文 パラメータ
public void FieldLostFocus(FieldEvent event); FieldEventイベント

FieldProcessKey

FieldProcessKeyイベントは、フォーカスがメタデータ・フィールドにある状態でキー・イベントが発生したときに発生します。

構文 パラメータ
public void FieldProcessKey(FieldEvent event); FieldEventイベント

InitializeFields

InitializeFieldsイベントは、dataFieldsモデルが初期化される前に発生します。

構文 パラメータ
public void InitializeFields(InitializeFieldsEvent event) InitializeFieldsEventイベント

PageCreated

PageCreatedイベントは、ページがドキュメントに追加される前に発生します。

構文 パラメータ
public void PageCreated(PageCreatedEvent event); PageCreatedEventイベント

PreBatchDelete

PreBatchDeleteイベントは、バッチが削除される直前に発生します。

構文 パラメータ
public void PreBatchDelete(BatchDeleteEvent event); BatchDeleteEventイベント

PreBatchScan

PreBatchScanイベントは、バッチがスキャンされる直前に発生します。

構文 パラメータ
public void PreBatchScan(BatchScanEvent event); BatchScanEventイベント

PreCaptureImage

PreCaptureImageイベントは、イメージがスキャン・ソースからキャプチャされる前に発生します。

構文 パラメータ
public void PreCaptureImage(ImageCaptureEvent event); ImageCaptureEventイベント

PreDocumentProfileChange

PreDocumentProfileChangeイベントは、ドキュメント・プロファイルが変更される直前に発生します。

構文 パラメータ
public void PreDocumentProfileChange(PreDocumentProfileChangeEvent event); PreDocumentProfileChangeEventイベント

DocumentProfileChanged

DocumentProfileChangedイベントは、ドキュメント・プロファイルが変更された後に発生します。

構文 パラメータ
public void DocumentProfileChanged(DocumentProfileChangedEvent event); DocumentProfileChangedEventイベント

PreDownloadItem

PreDownloadItemイベントは、バッチ・アイテムがダウンロードされる直前に発生します。

構文 パラメータ
public void PreDownloadItem(DownloadItemEvent event); DownloadItemEventイベント

PrePageDelete

PrePageDeleteイベントは、1つ以上のページが削除される直前に発生します。

構文 パラメータ
public void PrePageDelete(PageDeleteEvent event); PageDeleteEventイベント

PreReleaseBatch

PreReleaseBatchイベントは、バッチがリリースされる直前に発生します。

構文 パラメータ
public void PreReleaseBatch(ReleaseBatchEvent event); ReleaseBatchEventイベント

PreUploadItem

PreUploadItemイベントは、バッチ・アイテムがアップロードされる直前に発生します。

構文 パラメータ
public void PreUploadItem(UploadItemEvent event); UploadItemEventイベント

PostCaptureImage

PostCaptureImageイベントは、イメージがスキャン・ソースからキャプチャされた後に発生します。

構文 パラメータ
public void PostCaptureImage(ImageCaptureEvent event); ImageCaptureEventイベント

PostDownloadItem

PostDownloadItemイベントは、バッチ・アイテムがダウンロードされた後に発生します。

構文 パラメータ
public void PostDownloadItem(DownloadItemEvent event); DownloadItemEventイベント

PostUploadItem

PostUploadItemイベントは、バッチ・アイテムがアップロードされた後に発生します。

構文 パラメータ
public void PostUploadItem(UploadItemEvent event); UploadItemEventイベント

RegionSelected

RegionSelectedイベントは、ドキュメント・ページでリージョンが選択されたときに発生します。

構文 パラメータ
public void RegionSelected(RegionSelectedEvent event); RegionSelectedEventイベント

ScriptStart

ScriptStartイベントは、スクリプト処理が最初に初期化されたときに発生します。

このイベントの構文: public void ScriptStart();

イベント・クラス

イベント・クラスは、イベントを定義するために使用されます。この項では、次のイベント・クラスについて説明します:

AttachmentCreatedEvent

AttachmentCreatedEventクラスは、添付が作成されたときに発生するイベントで使用されます。

プロパティ タイプ 説明
attachment CaptureAttachment 作成された添付。

AttachmentRemoveEvent

AttachmentRemoveEventクラスは、ユーザーがドキュメントから1つ以上の添付を削除するときに発生するイベントで使用されます。

プロパティ タイプ 説明
attachments List<CaptureAttachment> ドキュメントから削除される添付。

AttachmentSelectedEvent

AttachmentSelectedEventクラスは、ユーザーが添付を選択するときに発生するイベントで使用されます。

プロパティ タイプ 説明
attachment CaptureAttachment バッチ・ペインで選択された添付。

BatchDeleteEvent

BatchDeleteEventクラスは、ユーザーがバッチを削除するときに発生するイベントで使用されます。

プロパティ タイプ 説明
batches List<CaptureBatch> 削除されるバッチのリスト。
canceled boolean Trueに設定すると、削除操作は取り消されます。

BatchScanEvent

BatchScanEventクラスは、ユーザーがバッチをスキャンするときに発生するイベントで使用されます。

プロパティ タイプ 説明
batch CaptureBatch スキャンまたはインポート中に新しいアイテムが追加されるバッチ。
canceled boolean Trueに設定すると、スキャンまたはインポートが取り消されます。
sourceFiles List<File> インポート・ソースを使用するときに、インポートされるファイルのリストがここに格納されます。
operation CaptureOperation このイベントをトリガーした操作を示します。
allowConfiguration boolean PreBatchScanイベントでこのプロパティをTrueに設定すると、スキャナは最初のページのスキャン前に構成ダイアログを表示できます。

BatchSelectedEvent

BatchSelectedEventクラスは、ユーザーがバッチを選択するときに発生するイベントで使用されます。

プロパティ タイプ 説明
batch CaptureBatch バッチ・ペインで選択されたバッチ。

DBSearchEvent

DBSearchEventクラスは、ユーザーがデータベース参照を開始するときに発生するイベントで使用されます。

プロパティ タイプ 説明
displayHitlist boolean Trueに設定すると、データベース参照の結果が表示されます。
exactMatch boolean Trueに設定すると、検索値が完全に一致することが必要になります。
metadataID String 検索されるメタデータ・フィールドの一意識別子。
metadataValue String 検索されるメタデータ・フィールドの値。
rowResults List<DbSearchResultRow> 検索で返される行結果のリスト。
canceled boolean Trueに設定すると、検索が取り消されます。

DocumentRemoveEvent

DocumentRemoveEventクラスは、ユーザーがバッチからドキュメントを削除するときに発生するイベントで使用されます。

プロパティ タイプ 説明
documents List<CaptureDocument> バッチから削除されるドキュメントのリスト。
destinationDocument CaptureDocument ドキュメント区切りを削除する場合、このプロパティにはすべてのページの移動先のドキュメントが含まれます。

次の表では、isRemove()メソッドの構文について説明します:

構文 説明
public boolean isRemove() ドキュメント区切りが削除される場合、Trueを返します。

次の表では、isDelete()メソッドの構文について説明します:

構文 説明
public boolean isDelete() ドキュメントのリストが削除される場合、Trueを返します。

DocumentSelectedEvent

DocumentSelectedEventクラスは、ユーザーがドキュメントを選択するときに発生するイベントで使用されます。

プロパティ タイプ 説明
document CaptureDocument バッチ・ペインで選択されたドキュメント。

PreDocumentProfileChangeEvent

PreDocumentProfileChangeEventクラスは、ユーザーがドキュメント・プロファイルを変更しようとすると発生するイベントで使用されます。

プロパティ タイプ 説明
oldDocumentType DocumentType 変更前のドキュメント・タイプまたはドキュメント・プロファイル。
newDocumentType DocumentType 現在選択されているドキュメント・タイプまたはドキュメント・プロファイル。
canceled Boolean trueに設定すると、ドキュメント・タイプまたはプロファイルのドロップダウンで変更が元に戻ります。

DocumentProfileChangedEvent

DocumentProfileChangedEventクラスは、ユーザーがドキュメント・プロファイルを変更したときに発生するイベントで使用されます。

プロパティ タイプ 説明
documentType DocumentType 現在選択されているドキュメント・タイプまたはドキュメント・プロファイル。

DownloadItemEvent

DownloadItemEventクラスは、バッチ・アイテムがサーバーからダウンロードされるときに発生するイベントで使用されます。

プロパティ タイプ 説明
captureItem CaptureItem バッチが開かれた後、サーバーから現在ダウンロードされているアイテムを示します。

FieldEvent

FieldEventクラスは、ユーザーがフィールドを開始したり、フィールドを終了したり、フィールドに入力するときに発生するイベントで使用されます。

プロパティ タイプ 説明
cancel Boolean Trueに設定すると、イベントは取り消されます。
field DataField このイベントの作用対象のフィールド。
keyEvent KeyEvent このイベントの生成に使用されるキーボード・イベント。
traversalDirection Integer フィールド・フォーカスの移動方向を示します。

TRAVERSAL定数:
TRAVERSAL_UNDETERMINED = 0
TRAVERSAL_FORWARD = 1
TRAVERSAL_BACKWARD = 2
TRAVERSAL_FORWARD_COMPONENT = 3
TRAVERSAL_BACKWARD_COMPONENT = 4

ImageCaptureEvent

ImageCaptureEventクラスは、ユーザーがイメージをキャプチャしているときに発生するイベントで使用されます。

プロパティ タイプ 説明
cancel boolean Trueに設定すると、キャプチャ操作は取り消されます。
imageCount Integer キャプチャされたイメージの数を示します。
imageFileName String ローカルに保存されたイメージのファイル名を示します。
xdpi Integer イメージの場合に、水平方向のインチ当たりドット数を示します。
ydpi Integer イメージの場合に、垂直方向のインチ当たりドット数を示します。
brightness Integer イメージのキャプチャに使用される明度値。
contrast Integer イメージのキャプチャに使用されるコントラスト値。
logicalBreak boolean Trueに設定すると、ドキュメントの開始を示します。
sourceFiles List<File> インポート・ソースを使用するときに、インポートされるファイルのリストが格納されます。
sourceFileName String インポート・ソースを使用するときに、インポートされるソース・ファイルの名前が格納されます。
image BufferedImage イメージ・ファイルの場合に、BufferedImageオブジェクトが格納されます。
source ImageCaptureEngine このイベントを作成したImageCaptureEngine。
imageFormat ImageCaptureEngine.ImageFormat イメージの保存形式として使用可能な形式(tiffG4、tiffJpegGray、tiffJpegColor、jpegGrayおよびjpegColor)を示します。
printerString String [ ] キャプチャ中にページに出力されるインプリンタまたはエンドーサの文字列。

InitializeFieldsEvent

InitializeFieldsEventクラスは、クライアントでfieldeditコントロールが初期化される前に発生するイベントで使用されます。このクラスを使用して、リスト内のDataFieldを変更または削除できます。

プロパティ タイプ 説明
dataFields List <DataField> ユーザーに表示されるDataFieldのリスト。

PageCreatedEvent

PageCreatedEventクラスは、ページが作成されるときに使用されます。

プロパティ タイプ 説明
page CaptureDocumentPage 作成されたページ。

PageDeleteEvent

PageDeleteEventクラスは、ページが削除されるときに使用されます。

プロパティ タイプ 説明
pages List<CaptureDocumentPage> 削除されるページのリスト。このリストを変更して、削除しないページを除外できます。
canceled boolean Trueに設定すると、いずれのページも削除されません。

RegionSelectedEvent

RegionSelectedEventクラスは、ユーザーがビューアでイメージの領域を選択するときに発生するイベントで使用されます。

プロパティ タイプ 説明
mouseEvent MouseEvent イメージ内で領域を選択するために使用されるMouseEvent。
selectionRectangle Rectangle イメージ内で選択される四角形。
image BufferedImage イメージの選択部分が含まれるBufferedImage。

ReleaseBatchEvent

ReleaseBatchEventクラスは、バッチがリリースまたはロック解除される直前に発生するイベントで使用されます。

プロパティ タイプ 説明
batches List<CaptureBatch> リリースされるバッチのリスト。
processorID String バッチのリリース先のプロセッサの一意識別子。
jobID String プロセッサ・ジョブの一意識別子。
canceled boolean このフラグをTrueに設定すると、リリースは取り消されます。
releaseProcessName String バッチのリリースに使用されるプロセスの名前。

UploadItemEvent

UploadItemEventクラスは、バッチ・アイテムがサーバーにアップロードされるときに発生するイベントで使用されます。

プロパティ タイプ 説明
captureItem CaptureItem バッチがリリースされた後、サーバーに現在アップロードされているアイテムを示します。

Captureクライアントのコア・クラス

この項では、Captureクライアントの次のコア・クラスについて説明します:

AttachmentType

AttachmentTypeクラスには、添付タイプのすべてのプロパティが含まれます。

プロパティ タイプ 説明
ID String 添付タイプの内部識別子。
name String 添付タイプの名前。
description String 添付タイプの説明。
required Boolean 添付タイプが必須かどうかを示します。

AttachmentTypes

AttachmentTypesクラスは、添付タイプのマップです。タイプはLinkedHashMap<String, AttachmentType>で、マップ・キーは添付タイプIDです。このクラスのインスタンスから添付タイプを取り出すには、LinkedHashMapのメソッドを使用します。

LinkedHashMapクラスおよびそのメソッドの詳細は、Java APIのドキュメントを参照してください。

BarcodeInfo

BarcodeInfoクラスには、スキャナによって検出されたバー・コードに関連付けられているすべてのプロパティが含まれます。

プロパティ タイプ 説明
type Integer バー・コードのタイプ。

有効なバー・コード・タイプは次のとおりです: </br>
TWBT_3OF9 - 0
TWBT_2OF5INTERLEAVED - 1
TWBT_2OF5NONINTERLEAVED - 2
TWBT_CODE93 - 3
TWBT_CODE128 - 4
TWBT_UCC128 - 5
TWBT_CODABAR - 6
TWBT_UPCA - 7
TWBT_UPCE - 8
TWBT_EAN8 - 9
TWBT_EAN13 - 10
TWBT_POSTNET - 11
TWBT_PDF417 - 12
TWBT_2OF5INDUSTRIAL - 13
TWBT_2OF5MATRIX - 14
TWBT_2OF5DATALOGIC - 15
TWBT_2OF5IATA - 16
TWBT_3OF9FULLASCII - 17
TWBT_CODABARWITHSTARTSTOP - 18
TWBT_MAXICODE - 19
text String バー・コードのテキスト値。
x Integer ページ上のバー・コードの水平方向位置(ピクセル)。スキャナによってこの情報が提供されない場合、この値がnullになっている可能性があります。
y Integer ページ上のバー・コードの垂直方向位置(ピクセル)。スキャナによってこの情報が提供されない場合、この値がnullになっている可能性があります。
confidence Integer バー・コード情報の精度の信頼度。値の範囲は0 (信頼度なし)から100 (非常に高い信頼度)までです。スキャナによってこの情報が提供されない場合、値がnullまたは(-)1になっている可能性があります。
rotation Integer バー・コードの方向。

有効な方向は次のとおりです:
TWBCOR_ROT0 (通常の読取り方向) - 0
TWBCOR_ROT90 (時計回りに90度回転) - 1
TWBCOR_ROT180 (時計回りに180度回転) - 2
TWBCOR_ROT270 (時計回りに270度回転) - 3
TWBCOR_ROTX (方向が不明) - 4
スキャナによってこの情報が提供されない場合、この値がnullになっている可能性があります。

CaptureAttachment

CaptureAttachmentクラスには、添付のすべてのプロパティが含まれます。

プロパティ タイプ 説明
attachmentType AttachmentType 添付のタイプ。
id String 添付の内部識別子。
pages CaptureDocumentPages 添付に含まれるページ。
parentDocument CaptureDocument この添付を所有する親ドキュメント。
title String 添付のタイトル。

次の表では、persist()メソッドの構文について説明します:

構文 説明
persist() throws BatchLockException, CaptureException 添付および関連ドキュメント・ページをサーバーに保存します。

CaptureAttachments

CaptureAttachmentsクラスは添付のコレクションであり、タイプはVector<CaptureAttachment>です。このクラスのインスタンスから添付を取り出すには、Vectorのメソッドを使用します。

Vectorクラスおよびそのメソッドの詳細は、Java APIのドキュメントを参照してください。

CaptureBatch

CaptureBatchクラスには、バッチのすべてのプロパティおよび操作が含まれます。

プロパティ タイプ 説明
batchId String バッチの内部識別子。
batchName String バッチの名前。
batchPath String このバッチの情報が格納されるローカル・パス。
createdBy String バッチを作成したユーザー。
createdDate Date バッチが作成された日付。
currentPriority Integer バッチに割り当てられた優先度。
currentStatus CaptureBatchStatus バッチに割り当てられたステータス。
documents CaptureDocuments バッチに含まれるドキュメント。
items CaptureItems バッチに関連付けられたアイテム。
jobID String プロセッサ・ジョブのID。このプロパティは、バッチがリリースされる直前に移入されます。
lastModifiedDate Date バッチが最後に変更された日付。
note String バッチに割り当てられたノート。
processorID String バッチのリリース先のプロセッサのID。このプロパティは、バッチがリリースされる直前に移入されます。
workspace CaptureWorkspace バッチの作成に使用されるワークスペース。

次の表では、persist()メソッドの構文について説明します:

構文 説明
persist() throws BatchLockException, CaptureException バッチ・レコードをサーバーに保存します。

CaptureBatchStatus

CaptureBatchStatusクラスには、バッチ・ステータスのプロパティが含まれます。

プロパティ タイプ 説明
value String ステータスの説明。
id String ステータスの内部識別子。

CaptureDataType

CaptureDataTypeは、メタデータ・フィールド定義のデータ型を定義する列挙です。有効なCaptureデータ型は次のとおりです:

CaptureDocument

CaptureDocumentクラスには、ドキュメントのすべてのプロパティが含まれます。

プロパティ タイプ 説明
documentType DocumentType ドキュメントに割り当てられたドキュメント・プロファイル。
fields CaptureFields ドキュメントに割り当てられたメタデータ。
id String ドキュメントの内部識別子。
pages CaptureDocumentPages ドキュメントに含まれるページ。
parentBatch CaptureBatch このドキュメントが含まれるバッチ。
title String ドキュメントのタイトル。
attachments CaptureAttachments このドキュメントに関連付けられた添付。

次の表では、persist()メソッドの構文について説明します:

構文 説明
persist() throws BatchLockException, CaptureException ドキュメント、関連ドキュメント・ページおよびメタデータをサーバーに保存します。

CaptureDocumentPage

CaptureDocumentPageクラスには、ドキュメント・ページのプロパティが含まれます。

プロパティ タイプ 説明
imageFilenameKey String このページのローカル・ファイル名。
item CaptureItem ページに関連付けられたアイテム。
pageID String ページの内部識別子。
pageNumber Integer ドキュメント内のページ数。
parentDocument CaptureDocument このページが含まれるドキュメント。

CaptureDocumentPages

CaptureDocumentPagesクラスはドキュメント・ページのコレクションであり、タイプはVector<CaptureDocumentPage>です。このクラスのインスタンスからドキュメント・ページを取り出すには、Vectorのメソッドを使用します。

Vectorクラスおよびそのメソッドの詳細は、Java APIのドキュメントを参照してください。

CaptureDocuments

CaptureDocumentsクラスはドキュメントのコレクションであり、タイプはVector<CaptureDocument>です。このクラスのインスタンスからドキュメントを取り出すには、Vectorのメソッドを使用します。

Vectorクラスおよびそのメソッドの詳細は、Java APIのドキュメントを参照してください。

CaptureErrorManager

CaptureErrorManagerクラスは、どのようなエラー・メッセージをログに記録するかを管理します。

プロパティ タイプ 説明
logLevel Level メッセージのログ記録に使用される最低レベル。

次の表では、logMessage()メソッドの構文について説明します:

構文 説明
logMessage(Level level, String message)

logMessage(Level level, String message, Throwable errorException)		 指定されたログ・レベルでメッセージをログに記録します。

または

指定されたログ・レベルでメッセージおよびエラーをログに記録します。

次の表では、logMessage()メソッドのパラメータについて説明します:

パラメータ タイプ 説明
level Level このログ・エントリの重大度レベル。
message String ログに記録するメッセージ。
errorException Throwable エラーをログに記録する場合、エラーの原因である例外。

CaptureField

CaptureFieldクラスには、ドキュメント・メタデータ・フィールドのプロパティが含まれます。

プロパティ タイプ 説明
displayValue String このフィールドに表示する値。
fieldName String フィールドの名前。
length Integer フィールドの最大長。
required boolean Trueの場合、このフィールドは値を持つ必要があります。
value String このフィールドの値。

次の表では、setDate()メソッドの構文について説明します:

構文 説明
setDate(Date date) メタデータ・フィールドの値を日付に設定します。

次の表では、setDate()メソッドのパラメータについて説明します:

パラメータ タイプ 説明
date Date 設定される日付値。

CaptureFields

CaptureFieldsクラスは、メタデータ・フィールド定義のマップです。タイプはLinkedHashMap<String, CaptureField>で、マップ・キーはフィールド名です。このクラスのインスタンスからフィールドを取り出すには、LinkedHashMapのメソッドを使用します。

LinkedHashMapクラスおよびそのメソッドの詳細は、Java APIのドキュメントを参照してください。

CaptureItem

CaptureItemクラスには、ドキュメント・ページに関連付けられたアイテム(単一イメージまたはイメージ以外のファイル)のプロパティが含まれます。

プロパティ タイプ 説明
filename String このアイテムのファイルの名前。
parentBatch CaptureBatch このアイテムが含まれるバッチ。
sourceFilename String このアイテムがインポートされた場合、インポート元のファイルの名前が含まれます。
sourceFormat String イメージ以外のドキュメントには、ドキュメントの形式(通常はファイル拡張子)が含まれます。
patchCode Integer このアイテムのパッチ・コード。
barcodes List<String> このアイテムのバー・コード。
micrValue String このアイテムに対するスキャナのMICRテキスト。
endorsement String このアイテムに対するスキャナの承認テキスト。

次の表では、persist()メソッドの構文について説明します:

構文 説明
persist() throws BatchLockException, CaptureException アイテムをサーバーに保存します。

CaptureItems

CaptureItemsクラスは、キャプチャのアイテムのマップです。タイプはTreeMap<String, CaptureItem>で、マップ・キーはアイテムのファイル名です。このクラスのインスタンスからアイテムを取り出すには、TreeMapのメソッドを使用します。

TreeMapクラスおよびそのメソッドの詳細は、Java APIのドキュメントを参照してください。

CaptureOperation

これは、バッチで実行されるキャプチャ操作を定義する列挙です。有効なキャプチャ操作の値は次のとおりです:

CaptureStateManager

CaptureStateManagerクラスには、クライアントの現在の状態に関連するプロパティが含まれます。このクラスのインスタンスは、キャプチャ・プロパティを介してすべてのスクリプト・イベントで使用できます。

プロパティ タイプ 説明
activeAttachment CaptureAttachment アクティブなドキュメント添付。
activeAttachmentPage CaptureDocumentPage アクティブなドキュメント添付ページ。
activeAttachmentType AttachmentType アクティブなドキュメント添付タイプ。
activeBatch CaptureBatch アクティブなバッチ。
activeDocument CaptureDocument アクティブなドキュメント。
activeDocumentPage CaptureDocumentPage アクティブなドキュメント・ページ。
activeDocumentType DocumentType アクティブなドキュメント・プロファイル。
activeProfile ClientProfile アクティブなクライアント・プロファイル。
applicationUserPath String クライアントがそのアプリケーション・データに使用するパス。
batchesPath String クライアントがバッチ・データのキャッシュに使用するパス。
captureSystemId String クライアントが接続されているキャプチャ・システムの内部識別子。
computerName String クライアントが実行されているコンピュータの名前。
currentUser String 現在クライアントにログインしているユーザー。
errorManager CaptureErrorManager 情報のログ記録に使用されるエラー・マネージャ・オブジェクト。

CaptureWorkspace

CaptureWorkspaceクラスには、ワークスペースのすべてのプロパティおよび操作が含まれます。

プロパティ タイプ 説明
id String ワークスペースに関連付けられた内部識別子。
fieldDefinitions FieldDefinitions このワークスペースに対して定義されているメタデータ。
name String ワークスペースの名前
statuses List<CaptureBatchStatus> このワークスペースで使用可能なバッチ・ステータスのリスト。

次の表では、getDBLookupProfile()メソッドの構文について説明します:

構文 説明
public DBLookupProfile getDBLookupProfile(String profileId) throws CaptureException 指定されたデータベース参照プロファイルIDのデータベース参照プロファイルを取得します。

次の表では、getDBLookupProfile()メソッドのパラメータについて説明します:

パラメータ タイプ 説明
profileId String データベース参照プロファイルの識別子。

ClientProfile

ClientProfileクラスには、Captureワークスペース・コンソールで定義された、クライアント・プロファイルのプロパティが含まれます。

プロパティ タイプ 説明
alwaysDisplayHitList boolean Trueの場合は、データベース参照の実行後に、返された結果の数にかかわらず結果が表示されます。
applyBrightness boolean Trueの場合は、選択されたキャプチャ・ソースに明度とコントラストの設定が適用されます。
batchFilterDaysOldFrom Integer バッチに許容される最小経過日数を指定するバッチ・フィルタ設定。
batchFilterDaysOldTo Integer バッチに許容される最大経過日数を指定するバッチ・フィルタ設定。
batchFilterPrimarySortField String バッチ・ツリーのプライマリ・ソートに使用されるバッチ・プロパティ。
batchFilterPrimarySortOrder SortOrder バッチ・ツリーのプライマリ・ソート順。
batchFilterSecondarySortField String バッチ・ツリーのセカンダリ・ソートに使用されるバッチ・プロパティ。
batchFilterSecondarySortOrder SortOrder バッチ・ツリーのセカンダリ・ソート順。
batchFilterState Integer バッチ・フィルタに含めるバッチ状態。
batchPrefix String このプロファイルを使用して作成されるバッチに使用するバッチ接頭辞。
batchVisibility BatchVisibility バッチ・ツリー内のバッチがどのような場合にユーザーに表示されるかを指定するバッチ・フィルタ設定。
blankByteThreshold long イメージのファイル・サイズのバイト数がblankByteThreshold未満の場合、そのページは空白ページとみなされます。
brightness Integer 選択されたキャプチャ・ソースに適用する明度。
captureType CaptureType プロファイルがキャプチャのみか、キャプチャと索引か、索引のみかを指定します。
contrast Integer 選択されたキャプチャ・ソースに適用するコントラスト。
dBLookupMaxRecords Integer データベース参照から返すレコードの最大数。
dBLookupProfileId String このプロファイルで使用されるデータベース参照プロファイルの一意識別子。
defaultColor ColorType キャプチャ中に使用されるデフォルトの色タイプ。
defaultDpi Integer キャプチャ中に使用するデフォルトDPI。
defaultPriority Integer このプロファイルから作成されたバッチには、この優先度が割り当てられます。
defaultStatusId String このプロファイルから作成されたバッチには、このステータスが割り当てられます。
description String プロファイルの説明。
documentCreationType DocumentCreationType キャプチャ時に作成されるドキュメント当たりのページ数を指定します。
documentTypes DocumentTypes このプロファイルによってバッチに割り当てることができるドキュメント・プロファイルが格納されているオブジェクト。
id String このプロファイルに関連付けられた識別子。
maxPages Integer イメージ・ファイル以外のプレビュー・ページ制限。
name String プロファイルの名前。
nonImageAction NonImageAction イメージ以外のファイルに対して実行されるアクション。
nonImageDpi int タイプがCONVERTのnonImageActionプロパティを持つクライアント・プロファイルの場合、このプロパティにはイメージ以外のファイル用のイメージDPIが含まれます。
nonImageFormat String タイプがCONVERTのnonImageActionプロパティを持つクライアント・プロファイルの場合、このプロパティにはイメージ以外のファイル用のイメージ形式が含まれます。この値は、TIFF_BWかJPEGのどちらかになります。
nonImageJpegQuality int タイプがCONVERTのnonImageActionプロパティおよびJPEGのnonImageFormat値を持つクライアント・プロファイルの場合、このプロパティにはイメージ以外のファイル用のJPEGイメージ品質が含まれます。
picklistRelationshipProfile String このプロファイルで使用される依存選択リスト。
prefixes List<String> バッチ・フィルタで使用されるバッチ接頭辞。
preventDefaultColorOverride boolean Trueの場合、色をオーバーライドできません。
preventDefaultDpiOverride boolean Trueの場合、dpiをオーバーライドできません。
priorities List<Integer> バッチ・フィルタで使用されるバッチ優先度。
sepByteThreshold Integer イメージのファイル・サイズのバイト数がsepByteThreshold未満の場合、そのページはセパレータ・シートとみなされます。
statuses List<String> バッチ・フィルタで使用されるバッチ・ステータス。
supportedDocumentTypes List<String> このプロファイルによってバッチに割り当てることができるドキュメント・プロファイルを表す、ドキュメント・プロファイル識別子のリスト。
workspaceId String このプロファイルが関連付けられているワークスペースの一意識別子。
workspaceName String このプロファイルが関連付けられているワークスペースの名前。
releaseProcesses ClientReleaseProcesses 使用可能なクライアント・リリース・プロセスのリスト。

次の表では、ClientProfileクラスの列挙および値を示します:

列挙 値
AutoPopulateType NONE、SCANDATE、INDEXDATE、DEFAULTVALUE、BATCHNAME、USERID、COMPUTERNAME、CLIENTPROFILENAME、BATCHSTATUS、BATCHPRIORITY
BatchVisibility USER_AND_COMPUTER、USER、ALL
DocumentCreationType ONE_PAGE、TWO_PAGES、VARIABLE_PAGES、PROMPT_USER
CaptureType CAPTURE_ONLY、CAPTURE_AND_INDEX、INDEX_ONLY
NonImageAction DISALLOW、ALLOW、CONVERT
SortOrder ASCENDING、DESCENDING
ColorType NotSpecified、BlackAndWhite、Gray、Color

ClientReleaseProcess

ClientReleaseProcessクラスには、クライアント・リリース・プロセスのすべてのプロパティが含まれます。

プロパティ タイプ 説明
name String リリース・プロセスの名前。
description String リリース・プロセスの説明。
processorID String リリース・プロセスのプロセッサID。
jobID String リリース・プロセスのプロセッサ・ジョブID。
defaultRelease boolean これがデフォルト・リリース・プロセスかどうかを示します。

ClientReleaseProcesses

ClientReleaseProcessesクラスは、クライアント・リリース・プロセスのリストです。タイプはArrayList<ClientReleaseProcess>です。このクラスのインスタンスからクライアント・リリース・プロセスを取り出すには、ArrayListのメソッドを使用します。

ArrayListクラスおよびそのメソッドの詳細は、Java APIのドキュメントを参照してください。

ClientUI

ClientUIクラスを使用すると、ユーザーはユーザー・インタフェース関連のアクションを呼び出すことができます。このクラスには、クライアント・スクリプトを介してアクセスできます。

プロパティ タイプ 説明
batchEditForm BatchEditForm 現在のバッチ編集フォームのインスタンス。

このクラスには、次のメソッドが含まれます:

releaseBatch()

次の表では、releaseBatch()メソッドの構文について説明します:

構文 説明
public void releaseBatch(List<CaptureBatch> batches, String processorID, String jobID) バッチのリストを追加処理できるようにロック解除またはリリースします。

次の表では、releaseBatch()メソッドのパラメータについて説明します:

パラメータ タイプ 説明
batches List<CaptureBatch> リリースされるバッチのリスト。
processorID String バッチのリリース先のプロセッサの一意識別子。
jobID String プロセッサ・ジョブの一意識別子。

setActiveMetadataFieldByName()

次の表では、setActiveMetadataFieldByName()メソッドの構文について説明します:

構文 説明
public void setActiveMetadataFieldByName(String fieldName) メタデータ・ペイン内のフォーカスを、フィールド名で指定されたメタデータ・フィールドに移動します。

次の表では、setActiveMetadataFieldByName()メソッドのパラメータについて説明します:

パラメータ タイプ 説明
fieldName String フォーカスの移動先のメタデータ・フィールドの名前。

setActiveMetadataFieldByID()

次の表では、setActiveMetadataFieldByID()メソッドの構文について説明します:

構文 説明
public void setActiveMetadataFieldByID(String fieldID) メタデータ・ペイン内のフォーカスを、フィールドIDで指定されたメタデータ・フィールド名に移動します。

次の表では、setActiveMetadataFieldByID()メソッドのパラメータについて説明します:

パラメータ タイプ 説明
fieldID String フォーカスの移動先のメタデータ・フィールドの一意識別子。

execDBSearch()

次の表では、execDBSearch()メソッドの構文について説明します:

構文 説明
public void execDBSearch(String metadataName, String metadataValue, Boolean alwaysDisplayHitList) 指定されたメタデータ・フィールドの名前と値のデータベース参照を実行します。このメソッドは次に、メタデータ・ペイン内のメタデータ・フィールドを結果で更新します。

次の表では、execDBSearch()メソッドのパラメータについて説明します:

パラメータ タイプ 説明
metadataName String 参照されるメタデータ・フィールドの名前。
metadataValue String 参照の実行に使用される値。
alwaysDisplayHitList Boolean Trueに設定すると、結果の数にかかわらず参照結果が表示されます。

execDBSearch()

次の表では、execDBSearch()メソッドの構文について説明します:

構文 説明
public void execDBSearch(String metadataName, String metadataValue, Boolean alwaysDisplayHitList, Boolean exactSearch, Integer maximumRecords) 指定されたメタデータ・フィールドの名前と値のデータベース参照を実行します。このメソッドは次に、メタデータ・ペイン内のメタデータ・フィールドを結果で更新します。

次の表では、execDBSearch()メソッドのパラメータについて説明します:

パラメータ タイプ 説明
metadataName String 参照されるメタデータ・フィールドの名前。
metadataValue String 参照の実行に使用される値。
alwaysDisplayHitList Boolean Trueに設定すると、結果の数にかかわらず参照結果が表示されます。
exactSearch Boolean Trueに設定すると、結果は検索される値と完全に一致する必要があります。Falseに設定すると、部分一致も返されます。
maximumRecords Integer 検索で返されるレコードの最大数を示します。

selectDocument()

次の表では、selectDocument()メソッドの構文について説明します:

構文 説明
public void selectDocument(CaptureDocument document) バッチ・ツリー内の指定されたドキュメントを選択します。

次の表では、selectDocument()メソッドのパラメータについて説明します:

パラメータ タイプ 説明
document CaptureDocument 選択するドキュメント。

refreshDocumentMetadata()

次の表では、refreshDocumentMetadata()メソッドの構文について説明します:

構文 説明
public void refreshDocumentMetadata() 現在のドキュメントからメタデータをリロードし、メタデータ・ペインに表示します。

DBLookupProfile

DBLookupProfileクラスは、データベース参照用のプロファイルを表します。このクラスには、次のメソッドが含まれます:

execDBLookup()

次の表では、execDBLookup()メソッドの構文について説明します:

構文 説明
ソートなしのデータベース参照

DBLookupResult execDBLookup(String searchID, String fieldID, String value, boolean exactMatch, Integer maxRows) throws CaptureException

ソートありのデータベース参照

DBLookupResult execDBLookup(String searchID, String fieldID, String value, Boolean exactMatch, String primarySortField, Integer primarySortOrder, String secondarySortField, Integer secondarySortOrder, Integer maxRows) throws CaptureException		 ソートあり、またはソートなしで、データベース参照を実行します。

ソート定数:
SORT_ASC = 0
SORT_DESC = 1

次の表では、execDBLookup()メソッドのパラメータについて説明します:

パラメータ タイプ 説明
searchID String データベース参照プロファイルに対して定義されているデータベース検索の一意識別子。
fieldID String 検索されるメタデータ・フィールドの一意識別子。
value String 検索される値。
exactMatch Boolean Trueの場合、値は完全一致である必要があります。
primarySortField String プライマリ・ソートに使用されるフィールド識別子。
primarySortOrder Integer プライマリ・ソートのソート順。
secondarySortField String セカンダリ・ソートに使用されるフィールド識別子。
secondarySortOrder Integer セカンダリ・ソートのソート順。
maxRows Integer 返される行の最大数。

DBLookupResult

DBLookupResultクラスは、データベース参照の結果を表します。

プロパティ タイプ 説明
searchFieldInfoList List<DbSearchFieldInfo> データベース参照で返された結果の説明である、検索フィールド情報のリスト。
searchResultRows List<DbSearchResultRow> データベース参照で返される検索結果行のリスト。

DbSearchResultRow

DbSearchResultRowクラスは、データベース参照から返される1行の結果を表します。

プロパティ タイプ 説明
results List<String> 1つの検索結果に関連付けられている文字列値のリスト。このリスト内の値の順序は、戻りフィールドが定義されている順序と同じです。

DbSearchFieldInfo

DbSearchFieldInfoクラスは、データベース参照の結果の説明であるフィールド情報を表します。

プロパティ タイプ 説明
captureIndexDefID String メタデータ・フィールド識別子。
dbColumnName String データベース列の名前。
dbColumnType Integer データベース列のタイプ。
captureFieldType Integer メタデータ・フィールドのデータ型。

DocumentType

DocumentTypeクラスは、ドキュメント・プロファイルを表します。ドキュメント・プロファイルでは、このタイプから作成されたドキュメントでどのメタデータ・フィールドを使用できるかを示します。

プロパティ タイプ 説明
fieldDefinitions FieldDefinitions ドキュメント・プロファイルに適用可能なメタデータ。
id String ドキュメント・プロファイルに関連付けられた内部識別子。
name String ドキュメント・プロファイルの名前。
description String ドキュメント・プロファイルの説明。
attachmentTypes AttachmentTypes ドキュメント・プロファイルで使用可能な添付タイプ。

DocumentTypes

DocumentTypesクラスは、ドキュメント・プロファイルのマップです。タイプはTreeMap<String, DocumentType>で、マップ・キーはドキュメント・プロファイルIDです。TreeMapのメソッドを使用すると、このクラスのインスタンスからドキュメント・プロファイルを取り出すことができます。

TreeMapクラスおよびそのメソッドの詳細は、Java APIのドキュメントを参照してください。

FieldDefinition

FieldDefinitionクラスは、メタデータ・フィールドの定義を表します。

プロパティ タイプ 説明
autoPopulateType ClientProfile.AutoPopulateType フィールドに値を自動的に移入する方法を指定します。
dataType CaptureDataType このフィールドのデータ型。
autoPopulateDefault String このフィールドのデフォルト値。
displayable boolean このフィールドをクライアントで表示するかどうかを示します。
length Integer このフィールドの最大長。
id String このフィールドの内部識別子。
name String このフィールドの名前。
inputMask String 入力マスク。
locked boolean フィールドをロックする場合は、Trueに設定します。
maxValue Float このフィールドの最大値。
minValue Float このフィールドの最小値。
pickListCaseInsensitive boolean Trueの場合、選択リストの大文字と小文字は区別されません。
pickListID String このフィールドに関連付けられている選択リストの一意識別子。
pickListParentFieldID String 選択リスト親フィールドの一意識別子。
pickListSourceID String このフィールドの依存選択リストのソース識別子。
profileDisplayFormat String フィールドの表示時に使用される形式。
required boolean このフィールドが値を持つ必要があるかどうかを示します。
validationExpression String このフィールドに入力された値を検証するために使用される正規表現。

FieldDefinitions

FieldDefinitionsクラスは、メタデータ・フィールド定義のマップです。タイプはLinkedHashMap<String, FieldDefinition>で、マップ・キーはメタデータ・フィールド定義IDです。LinkedHashMapのメソッドを使用すると、このクラスのインスタンスからメタデータ・フィールド定義を取り出すことができます。

LinkedHashMapクラスおよびそのメソッドの詳細は、Java APIのドキュメントを参照してください。

ImageCaptureEngine

ImageCaptureEngineクラスには、イメージ・キャプチャに関連付けられたすべてのプロパティおよび操作が含まれます。

プロパティ タイプ 説明
activeSource ImageCaptureSource イメージのキャプチャ元のイメージ・キャプチャ・エンジンのアクティブなソース。
activeDriver ImageCaptureDriver イメージのキャプチャ元のイメージ・キャプチャ・エンジンのアクティブなドライバ。

MicrInfo

MicrInfoクラスには、スキャナによって検出された磁気データに関連付けられているすべてのプロパティが含まれます。

プロパティ タイプ 説明
string String MICRデータから読み取られるテキスト情報。

Source

Sourceクラスは、TWAINスキャナとのやりとりに使用される低レベル・クラスです。

このクラスには、次のメソッドが含まれます:

getCurrentPrinter()

次の表では、getCurrentPrinter()メソッドの構文について説明します:

構文 説明
public int getCurrentPrinter() throws InvalidStateException, OperationException; 現在のインプリンタまたはエンドーサを返します。有効な値については、setPrinter(int printer)メソッドを参照してください。

getPrinterIndex()

次の表では、getPrinterIndex()メソッドの構文について説明します:

構文 説明
public int getPrinterIndex() throws OperationException, InvalidStateException; 現在のインプリンタまたはエンドーサのカウンタ値を返します。

getPrinterMode()

次の表では、getPrinterMode()メソッドの構文について説明します:

構文 説明
public int getPrinterMode() throws OperationException, InvalidStateException; 現在のインプリンタまたはエンドーサのモードを返します。戻り値の意味については、setPrinterMode (int printerMode)メソッドを参照してください。

getPrinterString()

次の表では、getPrinterString()メソッドの構文について説明します:

構文 説明
public String[] getPrinterString() throws OperationException, InvalidStateException; 現在のインプリンタまたはエンドーサの文字列または形式を返します。

getPrinterSuffix()

次の表では、getPrinterSuffix()メソッドの構文について説明します:

構文 説明
public String getPrinterSuffix() throws OperationException, InvalidStateException; 現在のインプリンタまたはエンドーサの接尾辞文字列を返します。

getSupportedPrinters()

次の表では、getSupportedPrinters()メソッドの構文について説明します:

構文 説明
public int[] getSupportedPrinters() throws InvalidStateException, OperationException; サポートされているインプリンタまたはエンドーサの配列を返します。戻り値の意味については、setPrinter(int printer)メソッドを参照してください。

isPrinterEnabled()

次の表では、isPrinterEnabled()メソッドの構文について説明します:

構文 説明
public boolean isPrinterEnabled() throws OperationException, InvalidStateException; 現在のインプリンタまたはエンドーサが有効になっているかどうかを返します。

isBarcodeDetectionEnabled()

次の表では、isBarcodeDetectionEnabled()メソッドの構文について説明します:

構文 説明
public boolean isBarcodeDetectionEnabled() throws OperationException, InvalidStateException; スキャナのバー・コード検出が有効になっているかどうかを返します。

getBarcodeMaxRetries()

次の表では、getBarcodeMaxRetries()メソッドの構文について説明します:

構文 説明
public int getBarcodeMaxRetries() throws OperationException, InvalidStateException; バー・コードが見つからない場合に検索を再試行する回数を返します。

getBarcodeMaxSearchPriorities()

次の表では、getBarcodeMaxSearchPriorities()メソッドの構文について説明します:

構文 説明
public int getBarcodeMaxSearchPriorities() throws OperationException, InvalidStateException; サポートされているバー・コード検索優先度の最大数を返します。

getBarcodeSearchMode()

次の表では、getBarcodeSearchMode()メソッドの構文について説明します:

構文 説明
public int getBarcodeSearchMode() throws OperationException, InvalidStateException; バー・コード検索に使用される方向または方向優先度を返します。
可能な戻り値は次のとおりです:
TWBD_HORZ - 0
TWBD_VERT - 1
TWBD_HORZVERT - 2
TWBD_VERTHORZ - 3

getBarcodeTimeout()

次の表では、getBarcodeTimeout()メソッドの構文について説明します:

構文 説明
public int getBarcodeTimeout() throws OperationException, InvalidStateException; ページ上のバー・コードの検索に費やす最大時間を返します。

getBarcodeSearchPriorities()

次の表では、getBarcodeSearchPriorities()メソッドの構文について説明します:

構文 説明
public int[] getBarcodeSearchPriorities() throws OperationException, InvalidStateException; 検索順序を決める、バー・コード・タイプの優先度付き配列を返します。

有効なバー・コード・タイプ: TWBT_3OF9、TWBT_2OF5INTERLEAVED、TWBT_2OF5NONINTERLEAVED、TWBT_CODE93、TWBT_CODE128、TWBT_UCC128、TWBT_CODABAR、TWBT_UPCA、TWBT_UPCE、TWBT_EAN8、TWBT_EAN13、TWBT_POSTNET、TWBT_PDF417、TWBT_2OF5INDUSTRIAL、TWBT_2OF5MATRIX、TWBT_2OF5DATALOGIC、TWBT_2OF5IATA、TWBT_3OF9FULLASCII、TWBT_CODABARWITHSTARTSTOP、TWBT_MAXICODE。

有効なバー・コード・タイプの定義については、「BarcodeInfo」を参照してください。

getSupportedBarcodeTypes()

次の表では、getSupportedBarcodeTypes()メソッドの構文について説明します:

構文 説明  
public int[] getSupportedBarcodeTypes() throws OperationException, InvalidStateException; スキャナでサポートされているバー・コード・タイプの配列を返します。

有効なバー・コード・タイプ: TWBT_3OF9、TWBT_2OF5INTERLEAVED、TWBT_2OF5NONINTERLEAVED、TWBT_CODE93、TWBT_CODE128、TWBT_UCC128、TWBT_CODABAR、TWBT_UPCA、TWBT_UPCE、TWBT_EAN8、TWBT_EAN13、TWBT_POSTNET、TWBT_PDF417、TWBT_2OF5INDUSTRIAL、TWBT_2OF5MATRIX、TWBT_2OF5DATALOGIC、TWBT_2OF5IATA、TWBT_3OF9FULLASCII、TWBT_CODABARWITHSTARTSTOP、TWBT_MAXICODE。

有効なバー・コード・タイプの定義については、「BarcodeInfo」を参照してください。		 .

getBarcodesDetected()

次の表では、getBarcodesDetected()メソッドの構文について説明します:

構文 説明
public BarcodeInfo[] getBarcodesDetected(); スキャナによって現在のページ上に見つかったバー・コードを記述するBarcodeInfoオブジェクトの配列を返します。

isPatchCodeDetectionEnabled()

次の表では、isPatchCodeDetectionEnabled()メソッドの構文について説明します:

構文 説明
public boolean isPatchCodeDetectionEnabled() throws OperationException, InvalidStateException; スキャナのパッチ・コード検出が有効になっているかどうかを返します。

getPatchCodeMaxRetries()

次の表では、getPatchCodeMaxRetries()メソッドの構文について説明します:

構文 説明
public int getPatchCodeMaxRetries() throws OperationException, InvalidStateException; パッチ・コードが見つからない場合に検索を再試行する回数を返します。

getPatchCodeMaxSearchPriorities()

次の表では、getPatchCodeMaxSearchPriorities()メソッドの構文について説明します:

構文 説明
public int getPatchCodeMaxSearchPriorities() throws OperationException, InvalidStateException; サポートされているパッチ・コード検索優先度の最大数を返します。

getPatchCodeSearchMode()

次の表では、getPatchCodeSearchMode()メソッドの構文について説明します:

構文 説明
public int getPatchCodeSearchMode() throws OperationException, InvalidStateException; パッチ・コード検索に使用される方向または方向優先度を返します。

可能な戻り値: TWBD_HORZ、TWBD_VERT、TWBD_HORZVERT、TWBD_VERTHORZ。

可能な戻り値の定義については、「getBarcodeSearchMode()」を参照してください。

getPatchCodeTimeout()

次の表では、getPatchCodeTimeout()メソッドの構文について説明します:

構文 説明
public int getPatchCodeTimeout() throws OperationException, InvalidStateException; ページ上のパッチ・コードの検索に費やす最大時間を返します。

getPatchCodeSearchPriorities()

次の表では、getPatchCodeSearchPriorities()メソッドの構文について説明します:

構文 説明
public int[] getPatchCodeSearchPriorities() throws OperationException, InvalidStateException; 検索順序を決める、パッチ・コード・タイプの優先度付き配列を返します。

有効なパッチ・コード・タイプ:
TWPCH_PATCH1 - 0
TWPCH_PATCH2 - 1
TWPCH_PATCH3 - 2
TWPCH_PATCH4 - 3
TWPCH_PATCH6 - 4
TWPCH_PATCHT - 5

getSupportedPatchCodeTypes()

次の表では、getSupportedPatchCodeTypes()メソッドの構文について説明します:

構文 説明
public int[] getSupportedPatchCodeTypes() throws OperationException, InvalidStateException; スキャナでサポートされているパッチ・コード・タイプの配列を返します。

有効なパッチ・コード・タイプ: TWPCH_PATCH1、TWPCH_PATCH2、TWPCH_PATCH3、TWPCH_PATCH4、TWPCH_PATCH6、TWPCH_PATCHT

有効なパッチ・コード・タイプの定義については、「getPatchCodeSearchPriorities()」を参照してください。

getPatchCodesDetected()

次の表では、getPatchCodesDetected()メソッドの構文について説明します:

構文 説明
public int[] getPatchCodesDetected(); スキャナによって現在のページ上に見つかった最初のパッチ・コード・タイプを含む配列を返します。いずれのパッチ・コードも検出されなかった場合、戻り値はnullまたは空の配列になります。

有効なパッチ・コード・タイプ: TWPCH_PATCH1、TWPCH_PATCH2、TWPCH_PATCH3、TWPCH_PATCH4、TWPCH_PATCH6、TWPCH_PATCHT

有効なパッチ・コード・タイプの定義については、「getPatchCodeSearchPriorities()」を参照してください。

isMicrEnabled()

次の表では、isMicrEnabled()メソッドの構文について説明します:

構文 説明
public boolean isMicrEnabled() throws OperationException, InvalidStateException; スキャナのMICR検出が有効になっているかどうかを返します。

getMicrDetected()

次の表では、getMicrDetected()メソッドの構文について説明します:

構文 説明
public MicrInfo getMicrDetected(); スキャナによって現在のページ上に見つかった磁気データを記述するMicrInfoオブジェクトを返します。

setPrinter(int printer)

次の表では、setPrinter(int printer)メソッドの構文について説明します:

構文 説明
public void setPrinter(int printer) throws InvalidStateException, OperationException; 現在のインプリンタまたはエンドーサを設定します。有効な値は次のとおりです:

0 - 上のプリインプリンタ
1 - 上のポストインプリンタ
2 - 下のプリインプリンタ
3 - 下のポストインプリンタ
4 - 上のプリエンドーサ
5 - 上のポストエンドーサ
6 - 下のプリエンドーサ
7 - 下のポストエンドーサ

setPrinterIndex(int printerIndex)

次の表では、setPrinterIndex(int printerIndex)メソッドの構文について説明します:

構文 説明
public void setPrinterIndex(int printerIndex) throws InvalidStateException, OperationException 現在のインプリンタまたはエンドーサのカウンタ値を設定します。

setPrinterMode(int printerMode)

次の表では、setPrinterMode(int printerMode)メソッドの構文について説明します:

構文 説明
public void setPrinterMode(int printerMode) throws InvalidStateException, OperationException; 現在のインプリンタまたはエンドーサのモードを設定します。有効な値は次のとおりです:

0 - 単一文字列
1 - 複数行文字列
2 - 複合文字列

setPrinterString(String printerString)

次の表では、setPrinterString(String printerString)メソッドの構文について説明します:

構文 説明
public void setPrinterString(String printerString) throws InvalidStateException, OperationException; 現在のインプリンタまたはエンドーサに出力される単一行の文字列または形式を返します。

setPrinterString(String[ ] printerString)

次の表では、setPrinterString(String[ ] printerString)メソッドの構文について説明します:

構文 説明
public void setPrinterString(String[] printerString) throws InvalidStateException, OperationException; 現在のインプリンタまたはエンドーサに出力される1行以上の形式(対応している場合)を返します。

setPrinterSuffix(String printerSuffix)

次の表では、setPrinterSuffix(String printerSuffix)メソッドの構文について説明します:

構文 説明
public void setPrinterSuffix(String printerSuffix) throws InvalidStateException, OperationException; 現在のインプリンタまたはエンドーサの接尾辞を設定します。(複合文字列モードのみ)。

setBarcodeDetectionEnabled(boolean enabled)

次の表では、setBarcodeDetectionEnabled(boolean enabled)メソッドの構文について説明します:

構文 説明
public void setBarcodeDetectionEnabled(boolean enabled) throws OperationException, InvalidStateException; スキャナのバー・コード検出を有効または無効にします。

setBarcodeMaxRetries(int maxRetries)

次の表では、setBarcodeMaxRetries(int maxRetries)メソッドの構文について説明します:

構文 説明
public void setBarcodeMaxRetries(int maxRetries) throws InvalidStateException, OperationException; バー・コードが見つからない場合に検索を再試行する回数を制限します。

setBarcodeMaxSearchPriorities(int maxSearchPriorities)

次の表では、setBarcodeMaxSearchPriorities(int maxSearchPriorities)メソッドの構文について説明します:

構文 説明
public void setBarcodeMaxSearchPriorities(int maxSearchPriorities) throws InvalidStateException, OperationException; サポートされているバー・コード検索優先度の最大数を指定します。

setBarcodeSearchMode(int searchMode)

次の表では、setBarcodeSearchMode(int searchMode)メソッドの構文について説明します:

構文 説明
public void setBarcodeSearchMode(int searchMode) throws InvalidStateException, OperationException; バー・コード検索を特定の方向に制限したり、ある方向の優先度を別の方向より高く設定します。

有効な値: TWBD_HORZ、TWBD_VERT、TWBD_HORZVERT、TWBD_VERTHORZ

有効な値の定義については、「getBarcodeSearchMode()」を参照してください。

setBarcodeTimeout(int timeout)

次の表では、setBarcodeTimeout(int timeout)メソッドの構文について説明します:

構文 説明
public void setBarcodeTimeout(int timeout) throws InvalidStateException, OperationException; ページ上のバー・コードの検索に費やされる合計時間を制限します。

setBarcodeSearchPriorities(int[] value)

次の表では、setBarcodeSearchPriorities(int[] value)メソッドの構文について説明します:

構文 説明
public void setBarcodeSearchPriorities(int[] value) throws OperationException, InvalidStateException; 検索順序を決める、バー・コード・タイプの優先度付き配列を設定します。
有効なバー・コード・タイプ: TWBT_3OF9、TWBT_2OF5INTERLEAVED、TWBT_2OF5NONINTERLEAVED、TWBT_CODE93、TWBT_CODE128、TWBT_UCC128、TWBT_CODABAR、TWBT_UPCA、TWBT_UPCE、TWBT_EAN8、TWBT_EAN13、TWBT_POSTNET、TWBT_PDF417、TWBT_2OF5INDUSTRIAL、TWBT_2OF5MATRIX、TWBT_2OF5DATALOGIC、TWBT_2OF5IATA、TWBT_3OF9FULLASCII、TWBT_CODABARWITHSTARTSTOP、TWBT_MAXICODE
有効なバー・コード・タイプの定義については、「BarcodeInfo」を参照してください。

setPatchCodeDetectionEnabled(boolean enabled)

次の表では、setPatchCodeDetectionEnabled(boolean enabled)メソッドの構文について説明します:

構文 説明
public void setPatchCodeDetectionEnabled(boolean enabled) throws OperationException, InvalidStateException; スキャナのパッチ・コード検出を有効または無効にします。

setPatchCodeMaxRetries(int maxRetries)

次の表では、setPatchCodeMaxRetries(int maxRetries)メソッドの構文について説明します:

構文 説明
public void setPatchCodeMaxRetries(int maxRetries) throws InvalidStateException, OperationException; パッチ・コードが見つからない場合に検索を再試行する回数を制限します。

setPatchCodeMaxSearchPriorities(int maxSearchPriorities)

次の表では、setPatchCodeMaxSearchPriorities(int maxSearchPriorities)メソッドの構文について説明します:

構文 説明
public void setPatchCodeMaxSearchPriorities(int maxSearchPriorities) throws InvalidStateException, OperationException; サポートされているパッチ・コード検索優先度の最大数を指定します。

setPatchCodeSearchMode(int searchMode)

次の表では、setPatchCodeSearchMode(int searchMode)メソッドの構文について説明します:

構文 説明
public void setPatchCodeSearchMode(int searchMode) throws InvalidStateException, OperationException; パッチ・コード検索を特定の方向に制限したり、ある方向の優先度を別の方向より高く設定します。
有効な値: TWBD_HORZ、TWBD_VERT、TWBD_HORZVERT、TWBD_VERTHORZ
有効な値の定義については、「getBarcodeSearchMode()」を参照してください。

setPatchCodeTimeout(int timeout)

次の表では、setPatchCodeTimeout(int timeout)メソッドの構文について説明します:

構文 説明
public void setPatchCodeTimeout(int timeout) throws InvalidStateException, OperationException; ページ上のパッチ・コードの検索に費やされる合計時間を制限します。

setPatchCodeSearchPriorities(int[] value)

次の表では、setPatchCodeSearchPriorities(int[] value)メソッドの構文について説明します:

構文 説明
public void setPatchCodeSearchPriorities(int[] value) throws OperationException, InvalidStateException; 検索順序を決める、パッチ・コード・タイプの優先度付き配列を設定します。
有効なパッチ・コード・タイプ: TWPCH_PATCH1、TWPCH_PATCH2、TWPCH_PATCH3、TWPCH_PATCH4、TWPCH_PATCH6、TWPCH_PATCHT
有効なパッチ・コード・タイプの定義については、「getPatchCodeSearchPriorities()」を参照してください。

setMicrEnabled(boolean enabled)

次の表では、setMicrEnabled(boolean enabled)メソッドの構文について説明します:

構文 説明
public void setMicrEnabled(boolean enabled) throws OperationException, InvalidStateException; スキャナのMICR検出を有効または無効にします。

TWAINSource

TWAINSourceクラスはImageCaptureSourceのインスタンスであり、TWAINスキャンで使用されるソースを表します。

プロパティ タイプ 説明
deviceSource Source TWAINスキャナとのやりとりに使用される低レベル・オブジェクト。

CaptureクライアントのFieldEditクラス

FieldEditクラスは、メタデータ値を入力するためのユーザー・インタフェース・コンポーネントです。この項では、Captureクライアントの次のFieldEditクラスについて説明します:

DataField

DataFieldクラスは、FieldEditコンポーネントの単一フィールドのデータを表し、様々なフィールド・タイプのベース・クラスとなります。

プロパティ タイプ 説明
caption String フィールド・キャプション。
fieldName String フィールド名。
displayFormat Format フィールドの表示形式。
inputMask String 入力マスク。
fieldLock boolean Trueの場合、フィールドがロックされます。
maxLength Long フィールドの最大長。
required boolean Trueの場合、このフィールドには入力する必要があります。
uncommittedText String フィールド内の現在のテキスト。

DateField

DataFieldクラスはDataFieldを拡張したものであり、日付フィールドを表します。

プロパティ タイプ 説明
value Date Dateオブジェクトで表した値。

FloatField

FloatFieldクラスはDataFieldを拡張したものであり、浮動小数フィールドを表します。

プロパティ タイプ 説明
value Float Floatオブジェクトで表した値。

IntegerField

IntegerFieldクラスはDataFieldを拡張したものであり、整数フィールドを表します。

プロパティ タイプ 説明
value Integer Integerオブジェクトで表した値。

PicklistEntry

PicklistEntryクラスは、選択リスト・タイプ・フィールドで、表示値とコミット値を決定するために使用されます。このクラスには、次のメソッドが含まれます:

getCommitValue()

次の表では、getCommitValue()メソッドの構文について説明します:

構文 説明
public String getCommitValue() 選択リスト・エントリのコミット値を返します。

getDisplayValue()

次の表では、getDisplayValue()メソッドの構文について説明します:

構文 説明
public String getDisplayValue() 選択リスト・エントリの表示値を返します。

PicklistField

PicklistFieldクラスはDataFieldを拡張したものであり、選択リスト・フィールドを表します。

プロパティ タイプ 説明
pickListCaseSensitive boolean Trueの場合、このリストの内容の大文字と小文字が区別されます。
pickListEntries List<PicklistEntry> 選択リストのエントリのリスト。
value PicklistEntry 選択リストの現在の値。

TextField

このTextFieldクラスはDataFieldを拡張したものであり、英数字フィールドを表します。

プロパティ タイプ 説明
value String フィールドの英数字の値。

クライアント・スクリプトのサンプル

この項では、次のクライアント・スクリプト・サンプルについて説明します:

クライアント・スクリプトのサンプル1

このサンプル・スクリプトは、クライアントの動作を次のようにカスタマイズします。

このスクリプトでは、検証やデバッグ用に、スクリプト・イベントごとにJavaコンソールに1行を出力する(printIn)処理も行います。


function ScriptStart() {
    java.lang.System.out.println("ScriptStart");
}

function PreBatchScan(event) { // BatchScanEvent
    java.lang.System.out.println("PreBatchScan");
}
 
function BatchScanBegin(event) { // BatchScanEvent
    java.lang.System.out.println("BatchScanBegin");
}
 
function BatchScanComplete(event) { // BatchScanEvent
    java.lang.System.out.println("BatchScanComplete");
    java.lang.System.out.println(event.getBatch().getBatchName() + " finished Scanning.");
}
 
function BatchSelected(event) { // BatchSelectedEvent
    java.lang.System.out.println("BatchSelected: " + event.getBatch().getBatchName());
}
 
function PreBatchDelete(event) { // BatchDeleteEvent
    java.lang.System.out.println("PreBatchDelete");
}
 
function CaptureImage(event) { // ImageCaptureEvent
    java.lang.System.out.println("CaptureImage");
}
 
function DocumentCreated(event) { // CaptureDocument
    java.lang.System.out.println("DocumentCreated");
}
 
function DocumentSelected(event) { // DocumentSelectedEvent
    java.lang.System.out.println("DocumentSelected: " + event.getDocument().getTitle());
}
 
function FieldGotFocus(event) { // FieldEvent
    java.lang.System.out.println("FieldGotFocus");
}
 
function FieldLostFocus(event) { // FieldEvent
    var dataField;
    java.lang.System.out.println("FieldLostFocus");
    dataField = event.getField();
    if (dataField.getUncommittedText().equalsIgnoreCase("test")) {
        event.setCancel(true);
        java.lang.System.out.println("invalid value. script will not allow leaving focus.");
    }
}
 
function FieldProcessKey(event) { // FieldEvent
    var keyEvent;
    // java.lang.System.out.println("FieldProcessKey");
    keyEvent = event.getKeyEvent();
    if (keyEvent.getID() == java.awt.event.KeyEvent.KEY_TYPED) {
        //java.lang.System.out.println(keyEvent.getKeyChar());
        if (new java.lang.Character(keyEvent.getKeyChar()).equals(new java.lang.Character('*'))) {
            java.lang.System.out.println("Asterisk not allowed in any field.");
            keyEvent.consume();
        }
    }
}
 
function PostCaptureImage(event) { // ImageCaptureEvent
    java.lang.System.out.println("PostCaptureImage");
}
 
function PreCaptureImage(event) { // ImageCaptureEvent
    java.lang.System.out.println("PreCaptureImage");
}
 
 
function PreUploadItem(event) { // UploadItemEvent
    java.lang.System.out.println("PreUploadItem: " + event.getCaptureItem().getFilename());
}
 
function PostUploadItem(event) { // UploadItemEvent
    java.lang.System.out.println("PostUploadItem: " + event.getCaptureItem().getFilename());
}
    
function DBSearchComplete(searchEvent) { // DBSearchEvent
    java.lang.System.out.println("DBSearchComplete.");
}
 
function DBSearchResults(searchEvent) { // DBSearchEvent
    var results;
    var resultRow;
    var searchParameters;
 
    java.lang.System.out.println("DBSearchResult");
 
    results = searchEvent.getRowResults();
    java.lang.System.out.println("Found " + results.size() + " results.");
}
 
function DBSearchStart(searchEvent) {  // DBSearchEvent
    java.lang.System.out.println("DBSearchStart");
    java.lang.System.out.println("Metadata value being sought: " + searchEvent.getMetadataValue());
}
 
function DocumentRemoved(event) { // DocumentRemovedEvent
    java.lang.System.out.println("DocumentRemoved");
}
 
function PostDownloadItem(event) { // DownloadItemEvent
    java.lang.System.out.println("PostDownloadItem: " + event.getCaptureItem().getFilename());
}
 
function PreDownloadItem(event) { // DownloadItemEvent
    java.lang.System.out.println("PreDownloadItem: " + event.getCaptureItem().getFilename());
}
 
function RegionSelected(event) { // RegionSelectedEvent
    java.lang.System.out.println("RegionSelected");
    var rect = event.getSelectionRectangle();
    java.lang.System.out.println("Rectangle (X,Y): (" + rect.getX() + "," + rect.getY() + 
        "); (W,H): (" + rect.getWidth() + "," + rect.getHeight() + ")");
}
 
function PreReleaseBatch(event) { // ReleaseBatchEvent
    // Skips the postProcess setting specified in the Capture profile and only unlocks the batch.
    event.setProcessorID(null);
    event.setJobID(null);
}

クライアント・スクリプトのサンプル2

このサンプル・スクリプトは、クライアントの動作を次のようにカスタマイズします。

function BatchScanBegin(event) { // BatchScanEvent
    // Check if there are files being imported.
    var sourceFilesList = event.getSourceFiles();
    if (sourceFilesList != null) {
        // Create a list to hold the filtered results.
        var filteredList = new java.util.ArrayList();
        
        // Loop through each of the files.
        var iterator = sourceFilesList.iterator();
        while (iterator.hasNext()) {
            // If the file name ends with ".TIF", add it to the list.
            var file = iterator.next();
            var filename = file.getName().toUpperCase();
            if (filename.endsWith(".TIF")) {
                filteredList.add(file);
            }
        }
        
        // Replace the original list with the filtered list.
        event.setSourceFiles(filteredList);
    }
}
 
function DBSearchResults(searchEvent) { // DBSearchEvent
    var results;
    var resultRow;
    var searchParameters;
 
    // Return only the first search result.
    results = searchEvent.getRowResults();
    if (results.size() > 0) {
        resultRow = results.get(0);
        results.clear();
        results.add(resultRow);
        // Do not display the list of results to the user.
        searchEvent.setDisplayHitlist(false);
    }
}

クライアント・スクリプトのサンプル3

このサンプル・スクリプトは、クライアントの動作を次のようにカスタマイズします。

function PreReleaseBatch(event) {
    // Metadata fields to copy to remaining documents
    var fieldsToCopy = new Array("Account Name", "Account Number");
    
    // Loop through each batch being released
    var batches = event.getBatches();
    for (var batchIdx = 0; batchIdx < batches.size(); batchIdx++) {
        var batch = batches.get(batchIdx);
        var documents = batch.getDocuments();
        if (documents.size() == 0)
            continue;
        // Get the first document from which we'll be copying
        var firstDocument = documents.get(0);
        var captureFields = [];
        // Create an array of the first document's fields
        var fieldDefs = batch.getWorkspace().getFieldDefinitions();
        for (var fieldIdx = 0; fieldIdx < fieldsToCopy.length; fieldIdx++) {
            var fieldID = fieldDefs.findByName(fieldsToCopy[fieldIdx]).getId();
            captureFields[fieldIdx] = firstDocument.getFields().get(fieldID);
        }
        // Loop through the remaining documents in the batch
        for (var documentIdx = 1; documentIdx < documents.size(); documentIdx++) {
            var destDocument = documents.get(documentIdx);
            var fields = destDocument.getFields();
            // Copy the source document's field values to the destination document
            for (var fieldIdx = 0; fieldIdx < captureFields.length; fieldIdx++) {
                var sourceField = captureFields[fieldIdx];
                // If the field in the source document was never set, skip it.
                if (sourceField == null)
                    continue;
                // Look up the field in the document
                var destField = fields.get(sourceField.getFieldName());
                // If it doesn't exist yet, create it
                if (destField == null)
                    destField = fields.add(sourceField.getFieldName());
                // If the value hasn't been set yet, set it
                if ((destField.getValue() == null) || (destField.getValue().isEmpty())) {
                    destField.setValue(sourceField.getValue());
                    destField.setDisplayValue(sourceField.getDisplayValue());
                }
            }
            // Save the document.
            destDocument.persist();
        }
    }
}