4.1.18  updateDocProp

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

(1) 機能

一般文書の最新バージョンのプロパティを更新します。

操作対象の一般文書の実体(コンテント)ファイルが登録されていない場合,setFilePathメソッド,setTextPathメソッド,setRenditionTypeメソッドをコールすると,コンテントファイルの追加ができます。

コンテントファイルが登録されている場合,setFilePathメソッド,setTextPathメソッド,setRenditionTypeメソッドをコールすると,コンテントファイルの差し替えができます。

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

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

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

(2) 形式

void updateDocProp(
 boolean docNumber,
 boolean outputLog
)

(3) 引数

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

(4) 戻り値

なし

(5) 例外

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