4.1.26  checkinDoc

<この項の構成>
(1) 機能
(2) 形式
(3) 引数
(4) 戻り値
(5) 例外

(1) 機能

文書をチェックインします。

文書種別マスタが設定されていない文書の場合,このメソッドをコールする前にsetDocMasterメソッドをコールすると,文書種別マスタを設定できます。

操作対象文書が文書番号を採番済みの場合,採番に使用しているプロパティの変更はできません。

事前に関連ファイルリストを設定している場合は,関連ファイルの文書の実体(コンテント)を更新することができます。

(2) 形式

String checkinDoc(
 boolean docNumber,
 boolean outputLog
)

(3) 引数

boolean docNumber
文書採番の実施フラグを指定します。
採番済みの文書に対して指定した場合は,無視されます。
  • true:文書番号を採番します。
  • false:文書番号を採番しません。
boolean outputLog
監査証跡ログの出力フラグを指定します。
  • true:監査証跡ログを出力します。
  • false:監査証跡ログを出力しません。

(4) 戻り値

チェックイン後の文書のバージョンオブジェクトのOIID

(5) 例外

DecmApiInvalidInitialException
  • setOiidメソッドを発行していない場合
  • setFilePathメソッドを発行していない場合
  • setFilePathメソッドを発行しているが,null,または「""」(空文字)を指定している場合
  • setFilePathメソッドで指定したファイルと,setSubFileListメソッドで指定したファイルのファイル名が重複している場合
DecmApiIOException
setFilePathメソッド,setTextPathメソッド,またはsetSubFileListメソッドで指定したファイルの読み込み中にエラーが発生した場合
DecmApiNotCheckoutException
文書管理サーバでチェックアウト状態不正エラー(未チェックアウト)が発生した場合(DbjNotCheckOutException)
DecmApiDocNotFoundException
文書がすでに削除された場合,または存在しない場合
DecmApiCapacityException
フォルダの容量制限を超えた場合
DecmApiMasterNotFoundException
指定した文書種別マスタが存在していない場合
DecmApiDocNumNotCorrectException
引数docNumberにtrueを指定した場合で,採番可能な有効な文書種別マスタを指定していないとき
DecmApiAccessException
指定した文書に対してアクセス権限がない場合(DbjAccessControlException)
DecmApiInvalidPropValueException
指定した文書のプロパティ値が不正な場合
DecmApiInvalidFileException
登録するファイルが不正な場合,または0バイトのファイルを登録した場合
DecmApiNotSupport
  • 採番済みの文書に対して,採番に使用しているプロパティを更新しようとした場合
  • 文書種別マスタを設定済みの文書に対して,文書種別マスタを更新しようとした場合
  • 指定した操作をサポートしていない場合
DecmApiInvalidDocMasterException
指定した文書種別マスタが不正な場合
DecmApiDBException
文書管理サーバでエラーが発生した場合(DbjExceptionなど)