IBatch

動作

バッチを示します。

注:ローカルのルールチェックの場合、このオブジェクトの方法とプロパティの一部をウェブ検証ステーションで使用することはできません。サポート外の方法とプロパティには、アスタリスク(*)が付けられています。

メソッド

重要!以下の手法にはバッチ構造を変更する権限が必要となります。これらの手法は、バッチ処理設定が出来ます。

定義 説明
CleanRecognitionResults( document :IDocument) * 文書の認識結果を削除します。
CreateDocumentFromPage( targetPosition : int, page :IPage):IDocument *

文書からページを選び取り、そのページから新しい文書を作成します。targetPositionパラメータで、バッチの新しい文書のインデックスを指定します。インデックスは0~Nの数値で、Nはバッチ内の合計文書数です。

CreateDocumentFromPage 方法が呼び出される時:

  • 0targetPosition – 1のインデックスの文書は、その元の位置に残ります。
  • targetPosionNのインデックスの文書は、一つ先の位置に移動します。
  • 新しい文書は、空のtargetPositionに配置されます。

注:文書がページの削除後に空になると、文書は削除されます。

CreatePageFromImage( page :IPictureObject, [optional] target :IDocument, [optional] position : int, [optional] sourceInfo : string ) :IPage *

以下からページを作成します:IPictureObject作成したページを返します。

  • ターゲット文書が指定されている場合は、その文書にページが追加されます。1ページの文書を作成する場合、ターゲット文書としてnullを指定します。
  • 位置が指定されている場合は、文書の特定の位置にページが追加されます(ターゲット文書が指定されている場合)。または、バッチの特定の位置に1ページの文書が追加されます(ターゲット文書としてnullが指定されている場合)。最初の位置は「0」値に相当し、文書またはバッチの最後は「-1」に相当します。
  • 「sourceInfo」パラメータが指定されている場合、ページソース情報にそれが書き込まれます。または、ページソースに関する情報が以下から取得されます。IPictureObject
DeleteDocument( document :IDocument) * 文書を削除します。
DeletePage( page :IPage) * ページを削除します。
MoveDocument( source :IDocument, targetPosition : int ) * 文書をバッチの特定の位置に移動します。
MovePage( source :IDocument, target :IDocument, sourcePageIndex : int, int targetPageIndex : int ) * 文書「source」から文書「target」までのインデックス「sourcePageIndex」の付いたページを位置「targetPageIndex」に移動します。

プロパティ

名前 タイプ アクセス 説明
AsBatchItem * IBatchItem 読み取り専用 バッチをIBatchItemオブジェクトに変換します。
Attachments IUserAttachments 読み取り専用 ユーザーの添付
BatchTypeName string 読み取り専用 バッチタイプの名前
Comment string 読み取り/書き込み コメント
CreatedBy IPrincipal 読み取り専用

新たに作成したバッチの作成者

CreationDate DateTime 読み取り専用 バッチを作成した時間
Documents IDocuments 読み取り専用 以下から成るバッチを文書化します。
ID int 読み取り専用 バッチ識別子バッチ内にパラメータは1つしか存在しません。
Name string 読み取り/書き込み バッチの名前
Priority TProcessingPriority 読み取り/書き込み バッチの優先順位
Project IProject 読み取り専用 バッチを含むプロジェクト
Properties IProperties 読み取り専用 バッチのパラメータ名
SLAExpirationDate DateTime 読み取り/書き込み バッチの処理期限。
SlaStartDate DateTime 読み取り専用 バッチの処理を開始した時間
SlaWarningPeriod * Int 読み取り/書き込み タスクのデッドラインが近づいていることを知らせる警告が表示される時間の開始時間デッドラインまでの時間を分で指定
StageInfo IStageInfo 読み取り専用 またIStageInfoオブジェクトを返します。TaskIdおよびPrincipalIdフィールドは使用しません。

10.11.2020 12:08:06


Please leave your feedback about this article