uCosminexus DocumentBroker Version 3 Standard GUI Development Kit

文法書

3020-3-U75

目　　次

前書き

はじめに

1.　 DocumentBroker Standard GUI Development Kitの概要

1.1　 DocumentBroker Standard GUI Development Kitとは

1.2　 DocumentBroker Standard GUI Development Kitで実現する機能

1.2.1　共通処理機能

1.2.2　文書操作機能

1.2.3　フォルダ操作機能

1.2.4　検索操作機能

1.2.5　文書種別マスタの操作機能

1.3　 DocumentBroker Standard GUI Development Kitのシステム構成

1.3.1　 DocumentBroker Standard GUI Development Kitのシステム構成例

1.4　 DocumentBroker Standard GUI Development Kitの前提プログラム

1.4.1　 DocumentBroker Standard GUI Development Kitの前提OS

1.4.2　 DocumentBroker Standard GUI Development Kitの同一装置内の前提ソフトウェア

1.4.3　 DocumentBroker Standard GUI Development Kitのシステム内の前提ソフトウェア

1.5　 DocumentBroker Standard GUI Development Kitのパッケージ一覧

1.6　インターフェースの処理の流れ

1.7　コーディング時の注意事項

1.7.1　マルチスレッド環境での注意事項

1.7.2　使用できる文字コード種別

1.8　 DocumentBroker Standard GUI Development Kitで使用するユーザ種別

1.9　トランザクションの開始と終了

2.　 DocumentBroker Standard GUI Development Kit提供のクラス一覧

2.1　 DocumentBroker Standard GUI Development Kitパッケージが提供するクラス

2.2　共通操作パッケージのクラス

2.2.1　共通操作パッケージのメソッド一覧

2.3　共通操作パッケージの例外クラス

2.3.1　共通操作パッケージの例外クラス

2.4　文書操作パッケージ提供クラス

2.4.1　文書操作パッケージのクラス

2.4.2　文書操作パッケージのメソッド一覧

2.5　フォルダ操作パッケージ提供クラス

2.5.1　フォルダ操作パッケージのクラス一覧

2.5.2　フォルダ操作パッケージのメソッド一覧

2.6　検索操作パッケージ提供クラス

2.6.1　検索操作パッケージのクラス一覧

2.6.2　検索操作パッケージのメソッド一覧

2.7　文書種別マスタ操作パッケージ提供クラス

2.7.1　文書種別マスタ操作パッケージのクラス一覧

2.7.2　文書種別マスタ操作パッケージのメソッド一覧

2.8　パッケージ提供クラス，およびメソッドの説明形式

2.8.1　メソッドで説明する項目

2.9　メソッドの関係

2.9.1　文書空間オブジェクトの操作時に影響するsetterメソッド

2.9.2　文書空間オブジェクト操作時に必要なアクセス権限

2.9.3　文書の状態によるメソッドの実行可否

3.　共通パッケージ提供クラスの詳細

3.1　 DecmFactoryクラス

3.1.1　 DecmFactory

3.1.2　 createDecmACLPerm

3.1.3　 createDecmDoc

3.1.4　 createDecmSubFile

3.1.5　 createDecmDocProp

3.1.6　 createDecmDocPerm

3.1.7　 createDecmFolderTree

3.1.8　 createDecmFolder

3.1.9　 createDecmFolderProp

3.1.10　 createDecmFolderPerm

3.1.11　 createDecmSelect

3.1.12　 createDecmCondition

3.1.13　 createDecmCondGroup

3.1.14　 createDecmDocMasterList

3.1.15　 createDecmDocMaster

3.1.16　 createDecmDocMasterProp

3.1.17　 createDecmDocPropMaster

3.1.18　 createDecmDocPropMasterProp

3.1.19　 initUserProp（文字列型）

3.1.20　 initUserProp（文字列型以外）

3.1.21　 isCapacityUse

3.2　 DecmObjectクラス

3.3　 DecmCommonPropクラス

3.3.1　 getOiid

3.3.2　 getStrProp

3.3.3　 setStrProp

3.3.4　 getIntProp

3.3.5　 setIntProp

3.3.6　 getLongProp

3.3.7　 setLongProp

3.4　 DecmCommonPermクラス

3.4.1　 getOwnerId

3.4.2　 setOwnerId

3.4.3　 getOwnerName

3.4.4　 setOwnerName

3.4.5　 getEveryonePerm

3.4.6　 setEveryonePerm

3.4.7　 getACLList

3.4.8　 setACLList

3.5　 DecmACLPermクラス

3.5.1　 getSubject

3.5.2　 setSubject

3.5.3　 getSubjectType

3.5.4　 setSubjectType

3.5.5　 getPermission

3.5.6　 setPermission

3.6　 DecmDBControlクラス

4.　文書操作パッケージ提供クラスの詳細

4.1　 DecmDocクラス

4.1.1　 getOiid

4.1.2　 setOiid

4.1.3　 setFolderOiid

4.1.4　 setDocProp

4.1.5　 setDocPerm

4.1.6　 setFilePath

4.1.7　 setTextPath

4.1.8　 setDocMaster

4.1.9　 setRenditionType

4.1.10　 setSubFileList

4.1.11　 isSubTraceMode

4.1.12　 setSubTraceMode

4.1.13　 createDoc

4.1.14　 deleteDoc

4.1.15　 trashDoc

4.1.16　 trashBackDoc

4.1.17　 fetchDocProp

4.1.18　 updateDocProp

4.1.19　 fetchDocPerm

4.1.20　 updateDocPerm

4.1.21　 downloadContent

4.1.22　 fetchDocHistory

4.1.23　 deleteDocHistory

4.1.24　 checkoutDoc

4.1.25　 cancelCheckoutDoc

4.1.26　 checkinDoc

4.1.27　 moveDoc

4.1.28　 fetchSubFile

4.1.29　 lockRead

4.1.30　 lockWrite

4.2　 DecmDocPropクラス

4.3　 DecmDocPermクラス

4.4　 DecmSubFileクラス

4.4.1　 setFilePath

4.4.2　 setRenditionType

4.4.3　 fetchFileProp

4.4.4　 downloadContent

5.　フォルダ操作パッケージ提供クラスの詳細

5.1　 DecmFolderTreeクラス

5.1.1　 setParentOiid

5.1.2　 getFolderList

5.2　 DecmFolderクラス

5.2.1　 getOiid

5.2.2　 setOiid

5.2.3　 setParentOiid

5.2.4　 setFolderProp

5.2.5　 setFolderPerm

5.2.6　 setCapacityMax

5.2.7　 resetCapacityMax

5.2.8　 createNodeFolder

5.2.9　 createDocFolder

5.2.10　 createPubFolder

5.2.11　 deleteFolder

5.2.12　 fetchFolderProp

5.2.13　 updateNodeFolderProp

5.2.14　 updateDocFolderProp

5.2.15　 updatePubFolderProp

5.2.16　 fetchFolderPerm

5.2.17　 updateFolderPerm

5.2.18　 changeCapacityMode

5.2.19　 lockRead

5.2.20　 lockWrite

5.3　 DecmFolderPropクラス

5.4　 DecmFolderPermクラス

6.　検索操作パッケージ提供クラスの詳細

6.1　 DecmSelectクラス

6.1.1　 setFolderOiid

6.1.2　 setFetchCount

6.1.3　 setSortKey

6.1.4　 setSortMode

6.1.5　 setTrashMode

6.1.6　 setFolderMode

6.1.7　 isSubFileSearchMode

6.1.8　 setSubFileSearchMode

6.1.9　 addCondition

6.1.10　 setSelectList

6.1.11　 setCondGroup

6.1.12　 setKeyword

6.1.13　 setSearchExpanse

6.1.14　 setSearchDictionary

6.1.15　 searchDoc

6.1.16　 resetCondition

6.2　 DecmConditionクラス

6.2.1　 createStrCond

6.2.2　 createIntCond

6.3　 DecmCondGroupクラス

6.3.1　 addCond

6.3.2　 addCondGroup

7.　文書種別マスタ操作パッケージ提供クラスの詳細

7.1　 DecmDocMasterListクラス

7.1.1　 getDocMasterList

7.2　 DecmDocMasterクラス

7.2.1　 getOiid

7.2.2　 setOiid

7.2.3　 fetchDocMasterProp

7.2.4　 getNewDocMaster

7.2.5　 getSearchDocMaster

7.2.6　 getListDocMaster

7.3　 DecmDocMasterPropクラス

7.4　 DecmDocPropMasterクラス

7.4.1　 setParentOiid

7.4.2　 getDocPropMasterList

7.5　 DecmDocPropMasterPropクラス

8.　 DocumentBrokerで提供されるクラスライブラリ

8.1　DocumentBrokerで提供されるクラスライブラリ

8.1.1　使用するクラス，およびインターフェースの一覧

8.1.2　使用するメソッド一覧

8.2　 DbjFactory0200クラス

8.2.1　 getFactory

8.3　 DbjFactoryインターフェース

8.3.1　 createSession

8.4　 DbjSessionインターフェース

8.4.1　 login

8.4.2　 logout

8.4.3　 begin

8.4.4　 rollback

8.4.5　 commit

8.5　 DbjDocSpaceインターフェース

9.　コーディング例

9.1　作成するコーディング例

9.1.1　前提条件

9.2　共通操作パッケージのコーディング例

9.2.1　 DecmFactoryインスタンスの作成

9.3　文書操作パッケージのコーディング例

9.3.1　文書の作成・取得・削除

9.3.2　文書のプロパティの更新・取得

9.3.3　文書のアクセス権限の更新・取得

9.3.4　文書の履歴の取得・削除・更新

9.3.5　文書をごみ箱へ移動したあと元に戻す

9.3.6　文書の移動

9.4　フォルダ操作パッケージのコーディング例

9.4.1　フォルダの作成・削除

9.4.2　フォルダのプロパティの作成・更新

9.4.3　フォルダのアクセス権限の更新・取得

9.5　検索操作パッケージのコーディング例

9.5.1　文書の検索

9.5.2　組み合わせ検索条件を指定した文書の検索

9.5.3　全文検索を利用した文書の検索

9.6　文書種別マスタ操作パッケージのコーディング例

9.6.1　文書種別マスタ一覧の取得

9.6.2　特定の文書種別マスタのOIIDの取得

9.6.3　属性値マスタ一覧の取得

10.　 DocumentBroker Standard GUI Development Kitの環境構築

10.1　DocumentBroker Standard GUI Development Kitのインストール，および環境構築手順

10.1.1　DocumentBroker Standard GUI Development Kitのインストール

10.1.2　 Java実行環境の設定

10.1.3　 uCosminexusで使用する場合の設定

付録

付録A　 DocumentBroker Standard GUI Development Kitで使用するプロパティ一覧

付録A.1　 DocumentBroker Standard GUI Development Kitで使用するプロパティ

付録B　用語解説

索引

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2009, Hitachi Systems & Services, Ltd.

前書き

■ 対象製品

R-1595C-43　 uCosminexus DocumentBroker Version 3 Standard GUI Development Kit　 03-60（適用OS：Windows Server 2003，Windows Server 2003 R2，Windows Server 2003 R2 (x64)，Windows Server 2008 x86，Windows XP Professional）

■ 輸出時の注意

本製品を輸出される場合には，外国為替および外国貿易法ならびに米国の輸出管理関連法規などの規制をご確認の上，必要な手続きをお取りください。
なお，ご不明な場合は，弊社担当営業にお問い合わせください。

■ 商標類

Adobeは，Adobe Systems Incorporated（アドビシステムズ社）の商標です｡
CORBAは，Object Management Groupが提唱する分散処理環境アーキテクチャの名称です。
Microsoftは，米国およびその他の国における米国Microsoft Corp.の登録商標です。

■ 発行

2009年4月 (第1版) 3020-3-U75

■ 著作権

All Rights Reserved. Copyright (C) 2009, Hitachi Systems & Services, Ltd.

はじめに

このマニュアルは，次に示すプログラムプロダクトで提供するJava クラスライブラリの詳細，インターフェースの詳細，メソッドの文法，およびメッセージの詳細についてリファレンス形式で説明したものです。

R-1595C-43　uCosminexus DocumentBroker Version 3 Standard GUI Development Kit

対象読者

このマニュアルは，uCosminexus DocumentBroker Version 3 Standard GUI Development Kitが提供するJava クラスライブラリを使用して，ユーザアプリケーションプログラムを開発し，システムを構築，運用および管理する方を対象にしています。なお，次の内容を理解されていることを前提としています。

Windowsに関する知識

JavaTM言語に関する知識

XMLに関する知識

SQL言語に関する知識

マニュアルの構成

このマニュアルは，次に示す章と付録から構成されています。

第1章　DocumentBroker Standard GUI Development Kitの概要

uCosminexus DocumentBroker Standard GUI Development Kitで実現できる機能の概要，および前提プログラムについて説明しています。

第2章　DocumentBroker Standard GUI Development Kit提供のクラス一覧

uCosminexus DocumentBroker Standard GUI Development Kitで提供するクラスの一覧について説明しています。

第3章　共通操作パッケージ提供クラスの詳細

共通操作パッケージ（jp.co.hitachi_system.sContents.API.Common）提供のクラス，およびメソッドについて説明しています。

第4章　文書操作パッケージ提供クラスの詳細

文書操作パッケージ（jp.co.hitachi_system.sContents.API.Document）提供のクラス，およびメソッドについて説明しています。

第5章　フォルダ操作パッケージ提供クラスの詳細

フォルダ操作パッケージ（jp.co.hitachi_system.sContents.API.Folder）提供のクラス，およびメソッドについて説明しています。

第6章　検索操作パッケージ提供クラスの詳細

検索操作パッケージ（jp.co.hitachi_system.sContents.API.Select）提供のクラス，およびメソッドについて説明しています。

第7章　文書種別マスタパッケージ提供クラスの詳細

文書種別マスタパッケージ（jp.co.hitachi_system.sContents.API.DocMaster）提供のクラス，およびメソッドについて説明しています。

第8章　DocumentBrokerで提供されるクラスライブラリの詳細

Javaクラスライブラリのクラス，およびメソッドについて説明しています。

第9章　コーディング例

クラスライブラリを使用したコーディング例について説明しています。

第10章　DocumentBroker Standard GUI Development Kitの環境構築

uCosminexus DocumentBroker Standard GUI Development Kitのインストール，および環境構築手順について説明しています。

付録A　DocumentBroker Standard GUI Development Kitで使用するプロパティ一覧

uCosminexus DocumentBroker Standard GUI Development Kitで扱うことができるプロパティについて説明しています。

付録B　用語解説

uCosminexus DocumentBroker Standard GUI Development Kitの用語について説明しています。

関連マニュアル

このマニュアルは次のマニュアルと関連がありますので，必要に応じてお読みください。

uCosminexus DocumentBroker Standard GUIのマニュアル

uCosminexus DocumentBroker Version 3 Standard GUI　システム導入・運用ガイド（3020-3-U73）

uCosminexus DocumentBroker Standard GUIの環境設定，および運用方法について知りたい場合に参照してください。

uCosminexus DocumentBroker Version 3 Standard GUI　操作ガイド（3020-3-U74）

uCosminexus DocumentBroker Standard GUIのGUIの操作方法などについて知りたい場合に参照してください。

関連するプログラムのマニュアル

uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　解説（3000-3-F16）

Java クラスライブラリの機能および環境設定のしかたについて知りたい場合に参照してください。

uCosminexus DocumentBroker Version 3　システム導入・運用ガイド　（3020-3-U71）

uCosminexus DocumentBrokerを使用する環境を定義，管理および運用する場合に参照してください。

uCosminexus DocumentBroker Version 3　メッセージ（3000-3-F12）

uCosminexus DocumentBrokerが出力するメッセージについて知りたい場合に参照してください。

Cosminexus　システム構築ガイド（3020-3-M06）

Cosminexusを使用して構築するアプリケーションサーバの構築方法について知りたい場合に参照してください。

読書手順

このマニュアルは，利用目的に合わせて章を選択してお読みいただけます。次に示す表を参考にして，お読みになる章を選択してください。

このマニュアルを読む目的 | 記述個所
DocumentBroker Standard GUI Development Kit概要，および前提条件について知りたい | 1章
どのようなJavaクラスライブラリのクラス，インターフェースおよびメソッドがあるかを知りたい，また，クラス，インターフェースおよびメソッドの説明形式について知りたい | 2章
共通パッケージクラスのインターフェースおよびメソッドについて知りたい | 3章
文書操作クラスのインターフェースおよびメソッドについて知りたい | 4章
フォルダ操作クラスのインターフェースおよびメソッドについて知りたい | 5章
検索操作クラスのインターフェースおよびメソッドについて知りたい | 6章
文書種別マスタ操作クラスについて知りたい | 7章
DocumentBroker Standard GUI Development Kitで使用するDocumentBrokerのクラス，およびメソッドについて知りたい | 8章
コーディング例について知りたい | 9章
DocumentBroker Standard GUI Development Kitのインストール，および環境構築について知りたい | 10章
DocumentBroker Standard GUI Development Kitで使用するプロパティについて知りたい | 付録A
DocumentBroker Standard GUI Development Kitの用語について知りたい | 付録B

このマニュアルでの表記

このマニュアルでは，製品名称を次に示すように表記しています。

正式名称 | 略称
HiRDB/Single Server Version 6 | HiRDB
HiRDB/Single Server Version 7
HiRDB/Single Server Version 8
HiRDB/Parallel Server Version 6
HiRDB/Parallel Server Version 7
HiRDB/Parallel Server Version 8
Java(TM) | Java
Microsoft(R) Windows Server(R) 2003, Enterprise Edition 日本語版 | Windows Server 2003 Enterprise Edition | Windows Server 2003
Microsoft(R) Windows Server(R) 2003, Standard Edition 日本語版 | Windows Server 2003 Standard Edition
Microsoft(R) Windows Server(R) 2003 R2, Enterprise Edition 日本語版 | Windows Server 2003 R2, Enterprise Edition | Windows Server 2003 R2
Microsoft(R) Windows Server(R) 2003 R2, Standard Edition日本語版 | Windows Server 2003 R2, Standard Edition
Microsoft(R) Windows Server(R) 2003 R2, Enterprise x64 Edition 日本語版 | Windows Server 2003 R2, Enterprise Edition (x64) | Windows Server 2003 R2 (x64)
Microsoft(R) Windows Server(R) 2003 R2, Standard x64 Edition 日本語版 | Windows Server 2003 R2, Standard x64 Edition (x64)
Microsoft(R) Windows Server(R) 2008 Enterprise 32-bit 日本語版 | Windows Server 2008 Enterprise Edition x86 | Windows Server 2008，またはWindows Server 2008 x86
Microsoft(R) Windows Server(R) 2008 Standard 32-bit 日本語版 | Windows Server 2008 Standard Edition x86
Microsoft(R) Windows(R) XP Professional Operating System | Windows XP Professional | Windows XP
uCosminexus Application Server Enterprise Version 7 | uCosminexus Application ServerまたはCosminexus
uCosminexus Application Server Enterprise Version 8
uCosminexus Application Server Standard Version 7
uCosminexus Application Server Standard Version 8
uCosminexus Developer Professional Version 7
uCosminexus Developer Professional Version 8
uCosminexus Developer Standard Version 7
uCosminexus Developer Standard Version 8
uCosminexus DocumentBroker Development Kit Version 3 | DocumentBroker Development Kit | DocumentBroker
uCosminexus DocumentBroker Runtime Version 3 | DocumentBroker Runtime
uCosminexus DocumentBroker Server Version 3 | DocumentBroker Server，DocumentBrokerサーバまたは，文書管理サーバ
uCosminexus DocumentBroker Text Search Index Loader Version 2 | DocumentBroker Text Search Index Loader
uCosminexus DocumentBroker Version 3 Standard GUI | DocumentBroker Standard GUI
uCosminexus DocumentBroker Version 3 Standard GUI Development Kit | DocumentBroker Standard GUI Development Kit
uCosminexus DocumentBroker Version 3 オブジェクト操作ツール | オブジェクト操作ツール
DocumentBroker Rendering Option Version 3 | DocumentBroker Rendering Option
DocumentBroker イメージ登録 for DocuCentre(R) | DocumentBroker イメージ登録 for DocuCentre

このほか，このマニュアルでは，次に示す表記方法を使用しています。

JavaTMをJavaと表記します。

uCosminexus DocumentBroker Development Kit，およびuCosminexus DocumentBroker Runtimeが提供するJava言語対応のクラスライブラリをJava クラスライブラリと表記します。

Windows Server 2003，Windows Server 2003 R2，Windows Server 2003 R2 (x64)，Windows Server 2008 x86，およびWindows XPを合わせてWindowsと表記することがあります。

DocumentBrokerのマニュアルで使用する略語

DocumentBrokerのマニュアルで使用する英略語を次に示します。

英略語 | 英字での表記
ACL | Access Control List
API | Application Programming Interface
CORBA | Common Object Request Broker Architecture
DB | Database
GUI | Graphical User Interface
GUID | Globally Unique Identifier
ID | Identifier
J2EE | Java 2 Enterprise Edition
OIID | Object Instance Identifier
OS | Operating System
PC | Personal Computer
PDF | Portable Document Format
SQL | Structured Query Language
UCS-2 | Universal multi-octet Character Set 2
UCS-4 | Universal multi-octet Character Set 4
UTF-8 | 8-bit UCS Transformation Format
XML | Extensible Markup Language

このマニュアルで使用する記号

このマニュアルで使用する記号を次に示します。

記号
意味

　｜
横に並べられた複数の項目に対する項目間の区切りを示し，「または」の意味を表します。

（例）　A｜B

AまたはBを指定することを示します。

　＿
括弧で囲まれた複数項目のうち1項目に対し使用され，括弧内のすべてを省略した場合にシステムが取る標準値を示します。

（例）　〔A｜B〕

何も指定しない場合はAが仮定されます。

｛　｝
この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの一つを選択します。

（例）　｛A｜B｜C｝

A，BまたはCのどれかを指定することを示します。

〔　〕
この記号で囲まれている項目は省略してもよいことを意味します。複数の項目が横に並べて記述されている場合には，すべてを省略するか，記号｛ ｝と同じくどれか一つを選択します。

（例１）　〔A〕

「何も指定しない」か「Aを指定する」ことを示します。

（例２）　〔B｜C〕

「何も指定しない」か「BまたはCを指定する」ことを示します。

<　>
この記号で囲まれている項目は，該当する要素を指定することを示します。

（例）　<プロパティ>

プロパティを記述します。

：：＝
この記号の左にあるものを右にあるもので定義することを示します。

（例）　A：：＝B

「AとはBである」と定義することを示します。

　…
記述が省略されていることを示します。

（例）　ABC…

ABCの後ろに記述があり，その記述が省略されていることを示します。

．．．
この記号の直前の項目を繰り返し，複数個指定できることを示します。

（例）　A．．．

Aを複数個指定できることを示します。

このマニュアルで使用する構文要素記号

このマニュアルで使用する構文要素の種類を次に示します。

構文要素記号 | 意味
英字 | A～Z　a～z
英小文字 | a～z
英大文字 | A～Z
数字 | 0～9
英数字 | A～Z　a～z　0～9
16進数字 | 0～9　A～F　a～f
記号 | !　"　#　$　%　&　'　(　)　+　,　_　―　・　.　/　:　;　<　=　>　@　[　]　^　－　｛　｝　￣　空白　¥

注　すべて半角文字を使用してください。

常用漢字以外の漢字の使用について

このマニュアルでは，常用漢字を使用することを基本としていますが，次に示す用語については，常用漢字以外の漢字を使用しています。

個所（かしょ）

KB（キロバイト）などの単位表記について

1KB（キロバイト），1MB（メガバイト），1GB（ギガバイト），1TB（テラバイト）はそれぞれ1,024バイト，1,024²バイト，1,024³バイト，1,024⁴バイトです。

1.　 DocumentBroker Standard GUI Development Kitの概要

この章では，DocumentBroker Standard GUI Development Kitで実現できる機能の概要について説明します。

＜この章の構成＞

1.1　 DocumentBroker Standard GUI Development Kitとは

1.2　 DocumentBroker Standard GUI Development Kitで実現する機能

1.3　 DocumentBroker Standard GUI Development Kitのシステム構成

1.4　 DocumentBroker Standard GUI Development Kitの前提プログラム

1.5　 DocumentBroker Standard GUI Development Kitのパッケージ一覧

1.6　インターフェースの処理の流れ

1.7　コーディング時の注意事項

1.8　 DocumentBroker Standard GUI Development Kitで使用するユーザ種別

1.9　トランザクションの開始と終了

1.1　 DocumentBroker Standard GUI Development Kitとは

DocumentBroker Standard GUI Development Kitでは，DocumentBroker Standard GUIで提供している文書モデルに対してアクセスを行うために必要な，Javaクラスライブラリとメソッドを提供しています。

1.2　 DocumentBroker Standard GUI Development Kitで実現する機能

DocumentBroker Standard GUI Development Kitで提供しているJavaクラスライブラリで，実現できる機能について説明します。

＜この節の構成＞

1.2.1　共通処理機能

1.2.2　文書操作機能

1.2.3　フォルダ操作機能

1.2.4　検索操作機能

1.2.5　文書種別マスタの操作機能

1.2.1　共通処理機能

DocumentBroker Standard GUIの文書モデルに対して，アクセスを行うための共通処理を提供します。

1.2.2　文書操作機能

DocumentBroker Standard GUI Development Kitの文書モデルで使用する文書に対する操作機能を提供します。

文書の作成

文書の削除

ごみ箱への移動

ごみ箱から元に戻す処理

文書のプロパティ取得

文書のプロパティ更新

文書のアクセス権限取得

文書のアクセス権限更新

文書の実体（コンテント）のダウンロード

文書の履歴取得

文書の履歴削除

チェックアウト処理

キャンセルチェックアウト処理

チェックイン処理

文書の移動

関連ファイル一覧の取得

1.2.3　フォルダ操作機能

DocumentBroker Standard GUIの文書モデルで使用するフォルダに対する操作機能を提供します。

フォルダの作成

フォルダの削除

フォルダ一覧の取得

フォルダのプロパティ取得

フォルダのプロパティ更新

フォルダのアクセス権限取得

フォルダのアクセス権限更新

1.2.4　検索操作機能

DocumentBroker Standard GUI Development Kitの文書モデルで使用する文書に対する検索機能を提供します。

フォルダ下の文書一覧の取得

全文検索結果一覧の取得

プロパティ検索結果一覧の取得

ごみ箱の文書一覧の取得

1.2.5　文書種別マスタの操作機能

DocumentBroker Standard GUI Development Kitの文書モデルで使用する文書に対する，文書種別マスタの操作機能を提供します。

文書種別マスタ一覧の取得

文書種別マスタ定義項目の取得

属性値マスタデータの取得

1.3　 DocumentBroker Standard GUI Development Kitのシステム構成

この節では，DocumentBroker Standard GUI Development Kitを使用する場合のシステム構成について説明します。

＜この節の構成＞

1.3.1　 DocumentBroker Standard GUI Development Kitのシステム構成例

1.3.1　 DocumentBroker Standard GUI Development Kitのシステム構成例

DocumentBroker Standard GUI Development Kitの推奨するシステムの構成例を次の図に示します。

図1-1　DocumentBroker Standard GUI Development Kitのシステム構成例（推奨）

1.4　 DocumentBroker Standard GUI Development Kitの前提プログラム

ここでは，DocumentBroker Standard GUI Development Kitの前提プログラムについて説明します。

＜この節の構成＞

1.4.1　 DocumentBroker Standard GUI Development Kitの前提OS

1.4.2　 DocumentBroker Standard GUI Development Kitの同一装置内の前提ソフトウェア

1.4.3　 DocumentBroker Standard GUI Development Kitのシステム内の前提ソフトウェア

1.4.1　 DocumentBroker Standard GUI Development Kitの前提OS

次のどれかが必要です。

Microsoft(R) Windows Server(R) 2003, Enterprise Edition 日本語版（Service Pack2以降）

Microsoft(R) Windows Server(R) 2003, Standard Edition 日本語版（Service Pack2以降）

Microsoft(R) Windows Server(R) 2003 R2, Enterprise Edition 日本語版（Service Pack2以降）

Microsoft(R) Windows Server(R) 2003 R2, Standard Edition 日本語版（Service Pack2以降）

Microsoft(R) Windows Server(R) 2003 R2, Enterprise x64 Edition 日本語版（Service Pack2以降）

Microsoft(R) Windows Server(R) 2003 R2, Standard x64 Edition 日本語版（Service Pack2以降）

Microsoft(R) Windows Server(R) 2008 Enterprise 32-bit 日本語版

Microsoft(R) Windows Server(R) 2008 Standard 32-bit 日本語版

Microsoft(R) Windows(R) XP Professional Operating System（Service Pack2以降）

1.4.2　 DocumentBroker Standard GUI Development Kitの同一装置内の前提ソフトウェア

＜この項の構成＞

(1)　DocumentBroker Standard GUI Development Kitを使用してユーザアプリケーションを開発する場合

(2)　 DocumentBroker Standard GUI Development Kitを使用してユーザアプリケーションを実行する場合

(1)　DocumentBroker Standard GUI Development Kitを使用してユーザアプリケーションを開発する場合

次のどちらかのプログラムが必要です。

uCosminexus DocumentBroker Development Kit Version 3 03-60

uCosminexus DocumentBroker Runtime Version 3 03-60

次のどれかのプログラムが必要です。

uCosminexus Application Server Standard 07-00以降

uCosminexus Application Server Enterprise 07-00以降

uCosminexus Developer Standard 07-00 以降

uCosminexus Developer Professional 07-00 以降

uCosminexus Application Server Standard 08-00以降

uCosminexus Application Server Enterprise 08-00以降

uCosminexus Developer Standard 08-00以降

uCosminexus Developer Professional 08-00以降

(2)　 DocumentBroker Standard GUI Development Kitを使用してユーザアプリケーションを実行する場合

次のどちらかのプログラムが必要です。

uCosminexus DocumentBroker Development Kit Version 3 03-60

uCosminexus DocumentBroker Runtime Version 3 03-60

次のどれかのプログラムが必要です。

uCosminexus Application Server Standard 07-00以降

uCosminexus Application Server Enterprise 07-00以降

uCosminexus Application Server Standard 08-00以降

uCosminexus Application Server Enterprise 08-00以降

1.4.3　 DocumentBroker Standard GUI Development Kitのシステム内の前提ソフトウェア

次のプログラムが必要です。

DocumentBroker Version 3 Standard GUI 03-60以降

注意

DocumentBroker Standard GUI Development Kitでは，DocumentBroker Standard GUIに対するDocumentBroker Serverの環境を前提とします。

ただし，DocumentBroker Standard GUIの配置ディスクリプタ（web.xml）の定義，各種プロパティファイルによる定義内容，ログインユーザの種別等については参照しません。

DocumentBroker Standard GUIでの定義情報との同期は，DocumentBroker Standard GUI Development Kitを使用するユーザアプリケーション側で行う必要があります。

詳細については，マニュアル「uCosminexus DocumentBroker Version 3 Standard GUI　システム導入・運用ガイド」を参照してください。

1.5　 DocumentBroker Standard GUI Development Kitのパッケージ一覧

DocumentBroker Standard GUI Development Kitのパッケージ一覧を次の表に示します。

表1-1　DocumentBroker Standard GUI Development Kitのパッケージ一覧

パッケージ名 | パッケージ概要
jp.co.hitachi_system.sContents.API.Common | 共通操作パッケージ
jp.co.hitachi_system.sContents.API.Document | 文書操作パッケージ
jp.co.hitachi_system.sContents.API.Folder | フォルダ操作パッケージ
jp.co.hitachi_system.sContents.API.Select | 検索操作パッケージ
jp.co.hitachi_system.sContents.API.DocMaster | 文書種別マスタ操作パッケージ

1.6　インターフェースの処理の流れ

DocumentBroker Standard GUI Development Kitは，DocumentBroker Development KitまたはDocumentBroker Runtimeで提供されるJava クラスライブラリの使用が前提です。

DocumentBroker Standard GUI Development Kitにおけるファクトリクラス（DecmFactory）に，DbjDocSpaceインタフェースを渡す必要があります。

クラスの詳細については，「2.　DocumentBroker Standard GUI Development Kit提供のクラス一覧」を参照してください。

インターフェースの処理の流れを次の図に示します。

図1-2　インターフェースの処理の流れ

※注

DocumentBroker Standard GUI Development Kitのメソッド発行で，エラー例外が発生した場合は，DbjSessionインタフェースのrollbackメソッドを必ず発行してください。

DocumentBroker Standard GUI Development Kitのメソッド発行で，エラー例外が発生した場合は，DbjSessionインタフェースのcommitメソッドは発行しないでください。正しく動作しないおそれがあります。

1.7　コーディング時の注意事項

この節では，コーディング時の注意事項について説明します。

＜この節の構成＞

1.7.1　マルチスレッド環境での注意事項

1.7.2　使用できる文字コード種別

1.7.1　マルチスレッド環境での注意事項

DocumentBroker Standard GUI Development Kitで提供するクラスのインスタンスに対して，複数スレッドから同時にアクセスはしないで下さい。

1.7.2　使用できる文字コード種別

Java クラスライブラリを使用したプログラミング時に使用できる文字コード種別を次に示します。

Shift-JIS

UTF-8（使用できる文字コード種別の範囲はUCS-2，またはUCS-4です）

使用する文字コード種別は，接続先となるDocumentBroker Standard GUI Development Kitのデータベースで使用する文字コード種別と合わせてください。

1.8　 DocumentBroker Standard GUI Development Kitで使用するユーザ種別

DocumentBroker Standard GUI Development Kitでは，DocumentBroker Standard GUIのユーザの種別は使用されません。DocumentBroker Standard GUI Development Kitで使用するユーザの種別は，セキュリティ管理者とそれ以外の2種類だけです。

DocumentBroker Standard GUIのユーザの種別の詳細については，マニュアル「uCosminexus DocumentBroker Version 3 Standard GUI　システム導入・運用ガイド」を参照してください。

1.9　トランザクションの開始と終了

DocumentBroker Standard GUI Development Kitのトランザクションは，ユーザアプリケーションプログラムで明示的に開始と終了を宣言してください。明示的に宣言していない場合は，データベースのデータの整合性が確保できないときがあります。

詳細については，マニュアル「uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　解説」を参照してください。

2.　 DocumentBroker Standard GUI Development Kit提供のクラス一覧

この章では，DocumentBroker Standard GUI Development Kitで提供するクラスの一覧を示します。

＜この章の構成＞

2.1　 DocumentBroker Standard GUI Development Kitパッケージが提供するクラス

2.2　共通操作パッケージのクラス

2.3　共通操作パッケージの例外クラス

2.4　文書操作パッケージ提供クラス

2.5　フォルダ操作パッケージ提供クラス

2.6　検索操作パッケージ提供クラス

2.7　文書種別マスタ操作パッケージ提供クラス

2.8　パッケージ提供クラス，およびメソッドの説明形式

2.9　メソッドの関係

2.1　 DocumentBroker Standard GUI Development Kitパッケージが提供するクラス

DocumentBroker Standard GUI Development Kitで提供するクラスの関連図，例外クラスの関連図を次の図に示します。

図2-1　DocumentBroker Standard GUI Development Kitで提供するクラスの関連図

図2-2　DocumentBroker Standard GUI Development Kitで提供している例外クラスの関連図

2.2　共通操作パッケージのクラス

共通操作パッケージのクラス一覧を次の表に示します。

表2-1　共通操作パッケージのクラス一覧

クラス | 説明
DecmFactoryクラス | インスタンスを生成するためのFactoryクラス
DecmObjectクラス | クラスの基底クラス
DecmCommonPropクラス | プロパティの基底クラス
DecmCommonPermクラス | アクセス権限情報の基底クラス
DecmACLPermクラス | アクセス権限の基底クラス
DecmDBControlクラス | データベース操作の基底クラス

＜この節の構成＞

2.2.1　共通操作パッケージのメソッド一覧

2.2.1　共通操作パッケージのメソッド一覧

共通操作パッケージのクラスのメソッド一覧を示します。

＜この項の構成＞

(1)　 DecmFactoryクラスのメソッド一覧

(2)　 DecmObjectクラス

(3)　 DecmCommonPropクラスのメソッド一覧

(4)　 DecmCommonPermクラスのメソッド一覧

(5)　 DecmACLPermクラスのメソッド一覧

(6)　 DecmDBControlクラス

(1)　 DecmFactoryクラスのメソッド一覧

DecmFactoryクラスのメソッド一覧を次の表に示します。スーパークラスはjava.lang.Objectクラスです。

表2-2　 DecmFactoryクラスのメソッド一覧

メソッド
機能

DecmFactory
コンストラクタです。
すべてのクラスのインスタンスを生成します。ただし，例外クラスのインスタンスは生成できません。

createDecmACLPerm
アクセス権限表現用クラスのインスタンスを生成します。

createDecmDoc
文書操作クラスのインスタンスを生成します。

createDecmSubFile
関連ファイル操作クラスのインスタンスを生成します。

createDecmDocProp
文書プロパティクラスのインスタンスを生成します。

createDecmDocPerm
文書アクセス権限クラスのインスタンスを生成します。

createDecmFolderTree
フォルダツリー階層情報取得クラスのインスタンスを生成します。

createDecmFolder
フォルダ操作クラスのインスタンスを生成します。

createDecmFolderProp
フォルダプロパティクラスのインスタンスを生成します。

createDecmFolderPerm
フォルダアクセス権限クラスのインスタンスを生成します。

createDecmSelect
文書検索クラスのインスタンスを生成します。

createDecmCondition
検索条件クラスのインスタンスを生成します。

createDecmCondGroup
組み合わせ検索条件クラスのインスタンスを生成します。

createDecmDocMasterList
文書種別マスタ一覧クラスのインスタンスを生成します。

createDecmDocMaster
文書種別マスタ操作用クラスのインスタンスを生成します。

createDecmDocMasterProp
文書種別マスタプロパティクラスのインスタンスを生成します。

createDecmDocPropMaster
属性値マスタ取得クラスのインスタンスを生成します。

createDecmDocPropMasterProp
属性値マスタプロパティクラスのインスタンスを生成します。

initUserProp（文字列型）
ユーザプロパティ，および文書種別マスタに使用するプロパティで，文字列型のプロパティをシステムに登録します。

initUserProp（文字列型以外）
ユーザプロパティ，および文書種別マスタに使用するプロパティで，文字列型以外のプロパティをシステムに登録します。

isCapacityUse
フォルダ下ファイル容量制限機能の使用有無を取得します。

表2-3　DecmFactoryクラスのフィールド一覧

定義 | 形式 | 意味
DB_HIRDB | int型 | データベースの種類：HIRDB
PROP_TYPE_STRING | int型 | ユーザプロパティのタイプ：文字列型※
PROP_TYPE_INTEGER | int型 | ユーザプロパティのタイプ：整数型※
PROP_TYPE_DATE | int型 | ユーザプロパティのタイプ：日付型※
PROP_TYPE_MASTER | int型 | ユーザプロパティのタイプ：マスタ型※

注※

ユーザプロパティの詳細については，「付録A.1　DocumentBroker Standard GUI Development Kitで使用するプロパティ」を参照してください。

(2)　 DecmObjectクラス

DocumentBroker Standard GUI Development Kitで提供するすべてのクラスの基底クラスです。ただし，例外クラスはDecmObjectクラスから派生しません。スーパークラスはjava.lang.Objectクラスです。

(3)　 DecmCommonPropクラスのメソッド一覧

DecmCommonPropクラスのメソッド一覧を次の表に示します。スーパークラスはDecmObjectクラスです。

表2-4　 DecmCommonPropクラスのメソッド一覧

メソッド | 機能
getOiid | 対象となるオブジェクトのOIID値を取得します。
getStrProp | 文字列型，またはマスタ型のプロパティに対するプロパティ値を取得します。
setStrProp | 文字列型，またはマスタ型のプロパティに対するプロパティ値を設定します。
getIntProp | 整数型，または日付型のプロパティに対するプロパティ値を取得します。
setIntProp | 整数型，または日付型のプロパティに対するプロパティ値を設定します。
getLongProp | 整数型（Long型）のプロパティに対するプロパティ値を取得します。
setLongProp | 整数型（Long型）のプロパティに対するプロパティ値を設定します。

注

プロパティ値の詳細については「付録A.1　DocumentBroker Standard GUI Development Kitで使用するプロパティ」を参照してください。

(4)　 DecmCommonPermクラスのメソッド一覧

DecmCommonPermクラスのメソッド一覧を次の表に示します。スーパークラスはDecmObjectクラスです。

表2-5　 DecmCommonPermクラスのメソッド一覧

メソッド | 機能
getOwnerId | オブジェクトの所有者のユーザIDを取得します。
setOwnerId | オブジェクトの所有者のユーザIDを設定します。
getOwnerName | オブジェクトの所有者名称を取得します。
setOwnerName | オブジェクトの所有者名称を設定します。
getEveryonePerm | すべてのユーザに対するアクセス権限を取得します。
setEveryonePerm | すべてのユーザに対するアクセス権限を設定します。
getACLList | アクセス権限のリストを取得します。
setACLList | アクセス権限のリストを設定します。

(5)　 DecmACLPermクラスのメソッド一覧

DecmACLPermクラスのメソッド一覧を次の表に示します。スーパークラスはDecmObjectクラスです。

表2-6　 DecmACLPermクラスのメソッド一覧

メソッド | 機能
getSubject | アクセス権限対象のID（ユーザID，組織ID，グループID）を取得します。
setSubject | アクセス権限対象のID（ユーザID，組織ID，グループID）を設定します。
getSubjectType | アクセス権限対象の種別（ユーザ，組織，グループ）を取得します。
setSubjectType | アクセス権限対象の種別（ユーザ，組織，グループ）を設定します。
getPermission | アクセス権限を取得します。
setPermission | アクセス権限を設定します。

表2-7　DecmACLPermクラスのフィールド一覧

定数 | 形式 | 意味
PERM_NONE | int型 | アクセス権限の種別：なし
PERM_READ | int型 | アクセス権限の種別：参照
PERM_LINK | int型 | アクセス権限の種別：リンク
PERM_UPDATE | int型 | アクセス権限の種別：更新
PERM_FULL | int型 | アクセス権限の種別：全て
PERM_TYPE_USER | int型 | アクセス権限対象の種別：ユーザ
PERM_TYPE_GROUP | int型 | アクセス権限対象の種別：組織またはグループ

(6)　 DecmDBControlクラス

スーパークラスはDecmObjectクラスです。

2.3　共通操作パッケージの例外クラス

共通操作パッケージの例外クラスを一覧形式で説明します。

＜この節の構成＞

2.3.1　共通操作パッケージの例外クラス

2.3.1　共通操作パッケージの例外クラス

共通操作パッケージの例外クラス一覧を次の表に示します。

表2-8　共通操作パッケージの例外クラス

クラス
説明

DecmApiExceptionクラス
例外クラスの基底クラスです。
発行される例外はこのクラスを基底とします。

DecmApiInvalidParamExceptionクラス
引数不正の例外です。
メソッドに指定した引数が不正であることを示します。

DecmApiInvalidInitialExceptionクラス
初期化処理呼び出し不正の例外です。
初期化処理メソッドの呼び出しが，不正であることを示します。

DecmApiIOExceptionクラス
入出力エラーの例外です。
ファイルI/Oエラーの発生を示します。

DecmApiDBExceptionクラス
データベースエラーの例外です。
データベースシステムで異常が発生したことを示します。

DecmApiAccessExceptionクラス
アクセス権限エラーの例外です。
対象となるオブジェクト（文書，フォルダなど）に対して，アクセス権限がないことを示します。

DecmApiAlreadyCheckoutExceptionクラス
チェックアウト済みの例外です。
文書に対してチェックアウトを行った際，すでにチェックアウト済みであることを示します。

DecmApiNotCheckoutExceptionクラス
チェックアウト状態不正エラーの例外です。
文書のチェックイン処理で，対象となる文書の状態が不正（未チェックアウト）であることを示します。

DecmApiLastVersionExceptionクラス
履歴の削除処理エラーの例外です。
文書の履歴で最後の1バージョンを削除しようとした場合のエラーを示します。

DecmApiDocNotFoundExceptionクラス
指定した文書が存在しないことを示す例外です。
指定した文書が削除されているか，存在しないことを示します。

DecmApiPropMasterNotFoundExceptionクラス
指定した属性値マスタが存在しないことを示す例外です。
指定した属性値マスタが削除されているか，存在しないことを示します。

DecmApiMasterNotFoundExceptionクラス
指定した文書種別マスタが存在しないことを示す例外です。
指定した文書種別マスタが削除されているか，存在しないことを示します。

DecmApiFolderNotFoundExceptionクラス
指定したフォルダが存在しないことを示す例外です。
指定したフォルダが削除されているか，存在しないことを示します。

DecmApiACLOutOfRangeExceptionクラス
設定したアクセス権限の数が最大値を超えたことを示す例外です。
アクセス権限の設定処理で，権限の設定数が最大数を超えたことを示します。

DecmApiReferenceExceptionクラス
対象の文書ファイルがデータベース中に存在しないことを示す例外です。
対象となる文書のファイルがデータベース中に存在しないため，操作ができないことを示します。

DecmApiCapacityExceptionクラス
フォルダ下に登録できる文書が容量制限を越えたことを示す例外です。

DecmApiInvalidFolderクラス
フォルダ種別が不正であることを示す例外です。

DecmApiFolderNotCorrectExceptionクラス
上位フォルダの種別，またはアクセス権限方式の指定が，不正であることを示す例外です。

DecmApiDocNumNotCorrectExceptionクラス
採番用に指定した文書種別マスタが，不正であることを示す例外です。

DecmApiFileNotFoundExceptionクラス
指定したレンディションにファイルが存在しないことを示す例外です。

DecmApiNotSupportクラス
指定した操作がサポートされていないことを示す例外です。

DecmApiInvalidPropValueExceptionクラス
採番に使用する値が不正であることを示す例外です。

DecmApiInvalidDocMasterExceptionクラス
指定した文書種別マスタが不正であることを示す例外です。
チェックインおよび文書の更新で，前の版（バージョン）と異なる文書種別マスタを指定した場合に，この例外が発行されます。

DecmApiInvalidFileExceptionクラス
登録するファイルが不正であることを示す例外です。

2.4　文書操作パッケージ提供クラス

このパッケージは，DocumentBroker Standard GUI Development Kit文書操作パッケージです。

文書操作パッケージのクラス，およびメソッドを一覧形式で説明します。

＜この節の構成＞

2.4.1　文書操作パッケージのクラス

2.4.2　文書操作パッケージのメソッド一覧

2.4.1　文書操作パッケージのクラス

文書操作パッケージのクラス一覧を次の表に示します。

表2-9　文書操作パッケージのクラス一覧

クラス | 説明
DecmDocクラス | 文書操作クラス
DecmDocPropクラス | 文書プロパティクラス
DecmDocPermクラス | 文書アクセス権限クラス
DecmSubFileクラス | 関連ファイル操作クラス

2.4.2　文書操作パッケージのメソッド一覧

文書操作パッケージのクラスのメソッド一覧を示します。

＜この項の構成＞

(1)　 DecmDocクラス

(2)　 DecmDocPropクラス

(3)　 DecmDocPermクラス

(4)　 DecmSubFileクラス

(1)　 DecmDocクラス

DecmDocクラスのメソッド一覧を次の表に示します。スーパークラスはDecmDBControlクラスです。

表2-10　 DecmDocクラスのメソッド一覧

メソッド | 機能
getOiid | 操作対象文書のバージョニングオブジェクトのOIIDを取得します。
setOiid | 操作対象文書のバージョニングオブジェクトのOIIDを設定します。
setFolderOiid | 文書の上位フォルダのOIIDを設定します。
setDocProp | 文書のプロパティを設定します。
setDocPerm | 文書のアクセス権限を設定します。
setFilePath | 文書の実体（コンテント）ファイルのローカルディスク上でのパスを設定します。
setTextPath | 全文検索用のテキストファイルのローカルディスク上でのパスを設定します。
setDocMaster | 文書種別マスタのOIIDを設定します。
setRenditionType | 登録する文書ファイルの参照用のファイル（PDF）を設定します。
setSubFileList | 関連ファイルリストを設定します。
isSubTraceMode | 関連ファイルの監査証跡ログの出力有無を取得します。
setSubTraceMode | 主ファイルと関連ファイルについて操作するメソッドで，関連ファイルの監査証跡ログを出力するかどうかを設定します。
createDoc | 一般文書を作成します。
deleteDoc | 文書をデータベースから完全に削除します。
trashDoc | 文書をごみ箱へ移動します。
trashBackDoc | 文書をごみ箱から戻します。
fetchDocProp | 文書の最新バージョンのプロパティを取得します。
updateDocProp | 文書の最新バージョンのプロパティを更新します。
fetchDocPerm | 文書のアクセス権限情報を取得します。
updateDocPerm | 文書のアクセス権限情報を更新します。
downloadContent | 文書の実体（コンテント）をダウンロードします。
fetchDocHistory | 文書の履歴を取得します。
deleteDocHistory | 文書の履歴を削除します。
checkoutDoc | 文書をチェックアウトします。
cancelCheckoutDoc | 文書のチェックアウトをキャンセルします。
checkinDoc | 文書をチェックインします。
moveDoc | 文書を移動します。
fetchSubFile | 主ファイルと関連付けられた関連ファイルリストを取得します。
lockRead | 文書に対する参照ロックを予約します。
lockWrite | 文書に対する更新ロックを予約します。

(2)　 DecmDocPropクラス

スーパークラスはDecmCommonPropクラスです。

(3)　 DecmDocPermクラス

スーパークラスはDecmCommonPermクラスです。

(4)　 DecmSubFileクラス

DecmSubFileクラスのメソッド一覧を次の表に示します。スーパークラスはDecmDBControlクラスです。

表2-11　 DecmSubFileクラスのメソッド一覧

メソッド | 機能
setFilePath | 文書の実体（コンテント）ファイルのローカルディスク上でのパスを設定します。
setRenditionType | 登録する文書ファイルに対して，参照用のファイル（PDF）を設定します。
fetchFileProp | 文書のプロパティを取得します。
downloadContent | 文書の実体（コンテント）をダウンロードします。

2.5　フォルダ操作パッケージ提供クラス

このパッケージは，DocumentBroker Standard GUI Development Kitフォルダ操作パッケージです。

フォルダ操作パッケージのクラス，およびメソッドを一覧形式で説明します。

＜この節の構成＞

2.5.1　フォルダ操作パッケージのクラス一覧

2.5.2　フォルダ操作パッケージのメソッド一覧

2.5.1　フォルダ操作パッケージのクラス一覧

フォルダ操作パッケージのクラス一覧を次の表に示します。

表2-12　フォルダ操作パッケージのクラス一覧

クラス | 説明
DecmFolderTreeクラス | フォルダツリー階層情報取得クラス
DecmFolderクラス | フォルダ操作クラス
DecmFolderPropクラス | フォルダプロパティクラス
DecmFolderPermクラス | フォルダアクセス権限クラス

2.5.2　フォルダ操作パッケージのメソッド一覧

フォルダ操作パッケージのクラスのメソッド一覧を示します。

＜この項の構成＞

(1)　 DecmFolderTreeクラス

(2)　 DecmFolderクラス

(3)　 DecmFolderPropクラス

(4)　 DecmFolderPermクラス

(1)　 DecmFolderTreeクラス

DecmFolderTreeクラスのメソッド一覧を次の表に示します。スーパークラスはDecmDBControlクラスです。

表2-13　 DecmFolderTreeクラスのメソッド一覧

メソッド | 機能
setParentOiid | 上位フォルダのOIIDを設定します。
getFolderList | 下位フォルダの一覧を取得します。

(2)　 DecmFolderクラス

DecmFolderクラスのメソッド一覧を次の表に示します。スーパークラスはDecmDBControlクラスです。

表2-14　 DecmFolderクラスのメソッド一覧

メソッド | 機能
getOiid | 操作対象フォルダのOIIDを取得します。
setOiid | 操作対象フォルダのOIIDを設定します。
setParentOiid | フォルダ作成時の上位フォルダのOIIDを設定します。
setFolderProp | フォルダのプロパティを設定します。
setFolderPerm | フォルダのアクセス権限を設定します。
setCapacityMax | フォルダの最大容量を設定します。
resetCapacityMax | フォルダの最大容量をリセットします。
createNodeFolder | ノードフォルダを作成します。
createDocFolder | 文書フォルダを作成します。
createPubFolder | 公開フォルダを作成します。
deleteFolder | フォルダを削除します。
fetchFolderProp | フォルダの最新バージョンのプロパティを取得します。
updateNodeFolderProp | ノードフォルダのプロパティを更新します。
updateDocFolderProp | 文書フォルダのプロパティを更新します。
updatePubFolderProp | 公開フォルダのプロパティを更新します。
fetchFolderPerm | フォルダのアクセス権限を取得します。
updateFolderPerm | フォルダのアクセス権限を更新します。
changeCapacityMode | フォルダ容量制限機能を変更します。
lockRead | フォルダに対する参照ロックを予約します。
lockWrite | フォルダに対する更新ロックを予約します。

表2-15　DecmFolderクラスのフィールド一覧

定数 | 形式 | 意味
ACL_TYPE_PRIVATE | int型 | 文書フォルダのアクセス権限方式：固有
ACL_TYPE_PUBLIC | int型 | 文書フォルダのアクセス権限方式：共有
PUBFOL_ACL_TYPE_PUBLIC | int型 | 公開フォルダのアクセス権限方式：全員に公開
PUBFOL_ACL_TYPE_PRIVATE | int型 | 公開フォルダのアクセス権限方式：公開範囲限定
DOC_CREATE_NG | int型 | フォルダ下の文書の作成：不可
DOC_CREATE_OK | int型 | フォルダ下の文書の作成：可
UNIT_MB | int型 | フォルダ容量制限単位：メガバイト
UNIT_GB | int型 | フォルダ容量制限単位：ギガバイト
UNIT_TB | int型 | フォルダ容量制限単位：テラバイト
CAP_NOUSE | int型 | フォルダ容量制限使用フラグ：使用しない
CAP_USE | int型 | フォルダ容量制限使用フラグ：使用する

(3)　 DecmFolderPropクラス

スーパークラスはDecmCommonPropクラスです。

(4)　 DecmFolderPermクラス

スーパークラスはDecmCommonPermクラスです。

2.6　検索操作パッケージ提供クラス

このパッケージは，DocumentBroker Standard GUI Development Kit検索操作パッケージです。

検索操作パッケージのクラス，およびメソッドを一覧形式で説明します。

＜この節の構成＞

2.6.1　検索操作パッケージのクラス一覧

2.6.2　検索操作パッケージのメソッド一覧

2.6.1　検索操作パッケージのクラス一覧

フォルダ操作パッケージのクラス一覧を次の表に示します。

表2-16　検索操作パッケージのクラス一覧

クラス | 説明
DecmSelectクラス | 文書検索クラス
DecmConditionクラス | 通常の検索条件の表現用クラス
DecmCondGroupクラス | 組み合わせ検索条件の表現用クラス

2.6.2　検索操作パッケージのメソッド一覧

検索操作パッケージのクラスのメソッド一覧を示します。

＜この項の構成＞

(1)　 DecmSelectクラス

(2)　 DecmConditionクラス

(3)　 DecmCondGroupクラス

(1)　 DecmSelectクラス

DecmSelectクラスのメソッド一覧を次の表に示します。スーパークラスはDecmDBControlクラスです。

表2-17　 DecmSelectクラスのメソッド一覧

メソッド | 機能
setFolderOiid | 検索対象となるフォルダのOIIDを設定します。
setFetchCount | 検索実行時に取得するレコード件数を設定します。
setSortKey | 検索実行時のソート用カラム名を設定します。
setSortMode | 検索実行時のソート方式（昇順，または降順）を設定します。
setTrashMode | 検索対象とする文書の種別を設定します。
setFolderMode | フォルダ検索時に，下位フォルダを検索対象とするかどうかを設定します。
isSubFileSearchMode | 関連ファイルの検索対象の指定有無を取得します。
setSubFileSearchMode | 関連ファイルを検索対象とするかどうかを設定します。
addCondition | 検索条件を追加します。
setSelectList | 検索取得列を設定します。
setCondGroup | 組み合わせ検索条件を設定します。
setKeyword | 全文検索のキーワードを設定します。
setSearchExpanse | 異表記展開指定の組み合わせを設定します。
setSearchDictionary | 全文検索実行時の同義語辞書名称を設定します。
searchDoc | 文書検索を実行します。
resetCondition | 指定した検索条件をリセットします。

表2-18　DecmSelectクラスのフィールド一覧

定数 | 形式 | 意味
SORT_MODE_UP | int型 | ソートの設定：昇順
SORT_MODE_DOWN | int型 | ソートの設定：降順
TRASH_MODE_NORMAL | int型 | 検索対象とする文書：通常文書
TRASH_MODE_DELETED | int型 | 検索対象とする文書：ごみ箱の文書
TRASH_MODE_ALL | int型 | 検索対象とする文書：全ての文書

(2)　 DecmConditionクラス

DecmConditionクラスのメソッド一覧を次の表に示します。スーパークラスはDecmDBControlクラスです。

表2-19　 DecmConditionクラスのメソッド一覧

メソッド | 機能
createStrCond | 文字列型の検索条件を生成します。
createIntCond | 整数型の検索条件を生成します。

表2-20　DecmConditionクラスのフィールド一覧

定数 | 形式 | 意味
OP_EQ | int型 | 検索条件のオペレータ：=
OP_NEQ | int型 | 検索条件のオペレータ：<>
OP_LT | int型 | 検索条件のオペレータ：<
OP_LTEQ | int型 | 検索条件のオペレータ：<=
OP_GT | int型 | 検索条件のオペレータ：>
OP_GTEQ | int型 | 検索条件のオペレータ：>=
OP_PART | int型 | 検索条件のオペレータ：部分一致
OP_STWITH | int型 | 検索条件のオペレータ：前方一致
OP_ENDWITH | int型 | 検索条件のオペレータ：後方一致

(3)　 DecmCondGroupクラス

DecmCondGroupクラスのメソッド一覧を次の表に示します。スーパークラスはDecmDBControlクラスです。

表2-21　 DecmCondGroupクラスのメソッド一覧

メソッド | 機能
addCond | 検索条件を追加します。
addCondGroup | 組み合わせ検索条件を追加します。

表2-22　DecmCondGroupクラスのフィールド一覧

定数 | 形式 | 意味
OP_AND | int型 | 検索条件追加のオペレータ：AND
OP_OR | int型 | 検索条件追加のオペレータ：OR

2.7　文書種別マスタ操作パッケージ提供クラス

このパッケージは，DocumentBroker Standard GUI Development Kit文書種別マスタ操作パッケージです。

文書種別マスタ操作パッケージのクラス，およびメソッドを一覧形式で示します。

＜この節の構成＞

2.7.1　文書種別マスタ操作パッケージのクラス一覧

2.7.2　文書種別マスタ操作パッケージのメソッド一覧

2.7.1　文書種別マスタ操作パッケージのクラス一覧

文書種別マスタ操作パッケージのクラス一覧を次の表に示します。

表2-23　文書種別マスタ操作パッケージのクラス一覧

クラス | 説明
DecmDocMasterListクラス | 文書種別マスタ一覧クラス
DecmDocMasterクラス | 文書種別マスタ操作クラス
DecmDocMasterPropクラス | 文書種別マスタプロパティクラス
DecmDocPropMasterクラス | 属性値マスタ取得クラス
DecmDocPropMasterPropクラス | 属性値マスタプロパティクラス

2.7.2　文書種別マスタ操作パッケージのメソッド一覧

文書種別マスタ操作パッケージのクラスのメソッド一覧を示します。

＜この項の構成＞

(1)　 DecmDocMasterListクラス

(2)　 DecmDocMasterクラス

(3)　 DecmDocMasterPropクラス

(4)　 DecmDocPropMasterクラス

(5)　 DecmDocPropMasterPropクラス

(1)　 DecmDocMasterListクラス

DecmDocMasterListクラスのメソッド一覧を次の表に示します。スーパークラスはDecmDBControlクラスです。

表2-24　 DecmDocMasterListクラスのメソッド一覧

メソッド | 機能
getDocMasterList | すべての文書種別マスタ一覧を取得します。

(2)　 DecmDocMasterクラス

DecmDocMasterクラスのメソッド一覧を次の表に示します。スーパークラスはDecmDBControlクラスです。

表2-25　 DecmDocMasterクラスのメソッド一覧

メソッド | 機能
getOiid | 操作対象文書種別マスタのOIIDを取得します。
setOiid | 操作対象文書種別マスタのOIIDを設定します。
fetchDocMasterProp | 文書種別マスタのプロパティを取得します。
getNewDocMaster | 文書作成時に指定するプロパティ項目一覧を取得します。
getSearchDocMaster | 検索に使用するプロパティ項目一覧を取得します。
getListDocMaster | 一覧表示に使用するプロパティ項目一覧を取得します。

(3)　 DecmDocMasterPropクラス

スーパークラスはDecmCommonPropクラスです。

(4)　 DecmDocPropMasterクラス

DecmDocPropMasterクラスのメソッド一覧を次の表に示します。スーパークラスはDecmDBControlクラスです。

表2-26　 DecmDocPropMasterクラスのメソッド一覧

メソッド | 機能
setParentOiid | 上位属性値マスタのOIIDを設定します。
getDocPropMasterList | 下位属性値マスタ一覧を取得します。

(5)　 DecmDocPropMasterPropクラス

スーパークラスはDecmCommonPropクラスです。

2.8　パッケージ提供クラス，およびメソッドの説明形式

パッケージ提供クラス，およびメソッドの説明形式について示します。各クラスの説明では，そのクラスに定義されるメソッドについてだけ説明しています。上位のクラスで定義されているメソッドについては，定義元のクラスを参照してください。

＜この節の構成＞

2.8.1　メソッドで説明する項目

2.8.1　メソッドで説明する項目

クラスの説明に続けて，そのクラスのメソッドを説明しています。上位のクラスから継承されるメソッドの詳細については，継承元のクラスのメソッドの説明を参照してください。

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

メソッドの機能の詳細を説明しています。

(2)　形式

メソッドの形式を説明しています。

(3)　引数

引数について説明しています。引数がないメソッドでは，「なし」と記述します。

(4)　戻り値

メソッドの戻り値を説明しています。戻り値を返却しないメソッドでは，「なし」と記述します。

(5)　例外

発生する例外について説明しています。発生する例外がないメソッドでは，「なし」と記述します。

なお，例外の詳細に以下の項目の記載がある場合は，該当する項目の説明を参照してください。

通常オブジェクトの設定チェック

オブジェクトの設定が次の場合，失敗と判定します。それ以外の場合は成功と判定します。

オブジェクトにnullを設定した場合

通常文字列の設定チェック

文字列の設定が次の場合，失敗と判定します。それ以外の場合は，成功と判定します。

文字列にnullを設定した場合

文字列に「""」（空文字）を設定した場合

133桁OIIDの設定チェック

OIIDの設定が次の場合，失敗と判定します。それ以外の場合は，成功と判定します。

OIIDにnullを設定した場合

OIIDに133桁以外の桁数を設定した場合

通常配列の設定チェック

配列の設定が次の場合，失敗と判定します。それ以外の場合は，成功と判定します。

配列にnullを設定した場合

配列の項目数が0の場合

プロパティの設定規則チェック

プロパティの設定は，設定項目の最大長，省略可否などのチェックにより失敗を判定します。設定規則の詳細については，「付録A　DocumentBroker Standard GUI Development Kitで使用するプロパティ一覧」を参照してください。

2.9　メソッドの関係

この節では，DocumentBroker Standard GUI Development Kitで使用するメソッドの関係について説明します。

＜この節の構成＞

2.9.1　文書空間オブジェクトの操作時に影響するsetterメソッド

2.9.2　文書空間オブジェクト操作時に必要なアクセス権限

2.9.3　文書の状態によるメソッドの実行可否

2.9.1　文書空間オブジェクトの操作時に影響するsetterメソッド

DecmDocクラスのメソッドを実行する場合に影響するsetterメソッドの関係を次の表に示します。

なお，DecmSubFileクラスのメソッドは，setterメソッドではなく，DecmDoc#FetchSubFileメソッドの実行結果に影響されます。

表2-27　DecmDocクラスのメソッド実行時に影響するsetterメソッド（1/2）

| setterメソッド
操作メソッド | setOiid | setFolderOiid | setDocProp | setDocPerm | setFilePath | setTextPath
createDoc | － | ○ | ○ | △ | △ | △
deleteDoc | ○※2 | － | － | － | － | －
trashDoc | ○※2 | － | － | － | － | －
trashBackDoc | ○※2 | － | － | － | － | －
fetchDocProp | ○※2 | － | － | － | － | －
updateDocProp | ○※2 | － | △※3 | － | △※3 | △
fetchDocPerm | ○※2 | － | － | － | － | －
updateDocPerm | ○※2 | － | － | ○ | － | －
downloadContent | ○※2 | － | － | － | － | －
fetchDocHistory | ○※2 | － | － | － | － | －
deleteDocHistory | ○※2 | － | － | － | － | －
checkoutDoc | ○※2 | － | － | － | － | －
cancelCheckoutDoc | ○※2 | － | － | － | － | －
checkinDoc | ○※2 | － | △ | － | ○ | △
moveDoc | ○※2 | － | － | － | － | －
fetchSubFile | ○※2 | － | － | － | － | －

表2-28　DecmDocクラスのメソッド実行時に影響するsetterメソッド（2/2）

| setterメソッド
操作メソッド | setDocMaster | setRenditionType | setSubTraceMode | setSubFileList
DecmSubFile#setFilePath | DecmSubFile#setRenditionType
createDoc | △ | △ | △ | ○※1 | △
deleteDoc | － | － | △ | － | －
trashDoc | － | － | △ | － | －
trashBackDoc | － | － | △ | － | －
fetchDocProp | － | － | － | － | －
updateDocProp | △ | △ | △ | ○※1 | △
fetchDocPerm | － | － | － | － | －
updateDocPerm | － | － | － | － | －
downloadContent | － | － | － | － | －
fetchDocHistory | － | － | － | － | －
deleteDocHistory | － | － | △ | － | －
checkoutDoc | － | － | △ | － | －
cancelCheckoutDoc | － | － | △ | － | －
checkinDoc | △ | △ | △ | ○※1 | △
moveDoc | － | － | △ | － | －
fetchSubFile | － | － | － | － | －

凡例

○：必ず指定します。

△：任意で指定します。

－：指定の対象外です。

注※1

DecmDoc#setSubFileListメソッドは任意です。コールする場合，DecmSubFile#setFilePathメソッドのコールが必ず必要です。

注※2

操作対象のインスタンスがDecmDoc#createDocを発行後の状態の場合は，必要ありません。

注※3

DecmDoc#setDocPropとDecmDoc#setFilePathは，必ずどちらかをコールしている必要があります。

DecmFolderクラスのメソッドを実行する場合に影響するsetterメソッドの関係を次の表に示します。

表2-29　DecmFolderクラスのメソッド実行時に影響するsetterメソッド

| setterメソッド
操作メソッド | setOiid | setParentOiid | seFolderProp | setFolderPerm | setCapacityMax
createNodeFolder | － | △ | ○ | － | △
createDocFolder | － | △ | ○ | △ | △
createPubFolder | － | △ | ○ | △ | －
deleteFolder | ○※1 | － | － | － | －
fetchFolderProp | ○※1 | － | － | － | －
updateNodeFolderProp | ○※1 | － | △※2 | － | △※2
updateDocFolderProp | ○※1 | － | △※2 | － | △※2
updatePubFolderProp | ○※1 | － | ○ | － | －
fetchFolderPerm | ○※1 | － | － | － | －
updateFolderPerm | ○※1 | － | － | ○ | －
changeCapacityMode | ○※1 | － | － | － | －

凡例

○：必ず指定します。

△：任意で指定します。

－：指定の対象外です。

注※1

操作対象インスタンスがDecmFolder#createNodeFolder，DecmFolder#createDocFolder，またはDecmFolder#createPubFolderを発行後の状態の場合は，必要ありません。

注※2

DecmFolder#setFolderPropとDecmFolder#setCapacityMaxは，必ずどちらかをコールしている必要があります。

2.9.2　文書空間オブジェクト操作時に必要なアクセス権限

文書空間オブジェクト操作時に必要なアクセス権限を次の表に示します。

なお，セキュリティ管理者は対象オブジェクトのアクセス権限に関係なく，すべての操作を実行できます。

表2-30　文書空間オブジェクト操作時に必要なアクセス権限

クラス名
メソッド名
実行できるアクセス権限

DecmDoc
createDoc
登録先フォルダに対する「リンク」以上の権限を持つユーザ

deleteDoc
文書に対する「全て」の権限を持つユーザ

trashDoc
文書に対する「更新」以上の権限を持つユーザ

trashBackDoc
文書に対する「更新」以上の権限を持つユーザ

fetchDocProp
文書に対する「参照」以上の権限を持つユーザ

updateDocProp
文書に対する「更新」以上の権限を持つユーザ

fetchDocPerm
文書に対する「参照」以上の権限を持つユーザ

updateDocPerm
文書に対する「所有者」の権限を持つユーザ

downloadContent
文書に対する「参照」以上の権限を持つユーザ

fetchDocHistory
文書に対する「参照」以上の権限を持つユーザ

deleteDocHistory
文書に対する「全て」の権限を持つユーザ

checkoutDoc
文書に対する「更新」以上の権限を持つユーザ

cancelCheckoutDoc
文書に対する「更新」以上の権限を持つユーザ

checkinDoc
文書に対する「更新」以上の権限を持ち，チェックアウトを実行したユーザ

moveDoc
次の条件を満たすユーザが実行できます。

移動元文書に対する「所有者」の権限を持つユーザ

移動元，および移動先フォルダに対する「リンク」以上の権限を持つユーザ

fetchSubFile
文書に対する「参照」以上の権限を持つユーザ

DecmSubFile
fetchFileProp
文書に対する「参照」以上の権限を持つユーザ

downloadContent
文書に対する「参照」以上の権限を持つユーザ

DecmFolder
createNodeFolder
アクセス権限の指定はありません。

createDocFolder
最上位フォルダの場合

アクセス権限の指定はありません。

下位フォルダの場合

上位フォルダが文書フォルダの場合は，「リンク」以上の権限を持つユーザです。

上位フォルダがノードフォルダの場合は，アクセス権限の指定はありません。

createPubFolder
最上位フォルダの場合

アクセス権限の指定はありません。

下位フォルダの場合

上位フォルダが公開フォルダの場合は，公開されているユーザです。

上位フォルダがノードフォルダの場合は，アクセス権限の指定はありません。

deleteFolder
フォルダに対する「全て」の権限を持つユーザ

fetchFolderProp
フォルダに対する「参照」の権限を持つユーザ

updateNodeFolderProp
フォルダに対する「更新」の権限を持つユーザ

updateDocFolderProp
フォルダに対する「更新」の権限を持つユーザ

updatePubFolderProp
フォルダに対する「更新」の権限を持つユーザ

fetchFolderPerm
フォルダに対する「参照」の権限を持つユーザ

updateFolderPerm
フォルダに対する「所有者」の権限を持つユーザ

changeCapacityMode
フォルダに対する「更新」の権限を持つユーザ

2.9.3　文書の状態によるメソッドの実行可否

文書の状態によるメソッドの実行可否について，次の表に示します。

なお，操作を実行するユーザは，操作対象の文書に対して各メソッドが実行できるアクセス権限を持つことが前提となります。

表2-31　文書の状態によるメソッドの実行可否

クラス | メソッド | 一般文書 | 公開文書
通常文書 | チェックアウト中文書※1 | ごみ箱の文書※1 | リファレンスファイル文書化
DecmDoc | createDoc | ○ | × | × | × | ×
deleteDoc | ○ | × | ○ | × | ×
trashDoc | ○ | × | × | ○ | ×
trashBackDoc | ○ | × | ○ | ○ | ×
fetchDocProp | ○ | ○ | ○ | ○ | ○
updateDocProp | ○ | × | × | △※2 | ×
fetchDocPerm | ○ | ○ | ○ | ○ | ○
updateDocPerm | ○ | × | × | ○ | ×
downloadContent | ○ | ○ | ○ | × | ○
fetchDocHistory | ○ | ○ | ○ | ○ | ○
deleteDocHistory | ○ | × | × | × | ×
checkoutDoc | ○ | × | × | × | ×
cancelCheckoutDoc | ○ | ○ | × | × | ×
checkinDoc | ○ | ○ | × | × | ×
moveDoc | ○ | × | × | ○ | ×
fetchSubFile | ○ | ○ | ○ | ○ | ○
DecmSubFile | fetchFileProp | ○ | ○ | ○ | ○ | ○
downloadContent | ○ | ○ | ○ | × | ○

凡例

○：実行できます。

△：条件により実行できます。

×：実行できません。

注※1

チェックアウト中の文書や，ごみ箱に存在する文書に対する操作は，実行したユーザに関係なく操作できます。

例えば，チェックアウトを実行したユーザ以外でも，「更新」以上のアクセス権限を持つユーザは，チェックアウトの取り消しを実行できます。

注※2

プロパティの更新はできますが，実体（コンテント）の更新はできません。

3.　共通パッケージ提供クラスの詳細

この章では，共通パッケージ（jp.co.hitachi_system.sContents.API.Common）提供のクラス，およびメソッドについて説明します。

＜この章の構成＞

3.1　 DecmFactoryクラス

3.2　 DecmObjectクラス

3.3　 DecmCommonPropクラス

3.4　 DecmCommonPermクラス

3.5　 DecmACLPermクラス

3.6　 DecmDBControlクラス

3.1　 DecmFactoryクラス

DecmFactoryクラスは，DocumentBroker Standard GUI Development Kitで提供するクラスのインスタンスを生成するためのFactoryクラスです。

このクラスのインスタンスは，文書空間とのセッションごとに一つ生成してください。サーバとのセッションに複数のオブジェクトを生成した場合，正しく動作しないおそれがあります。

次の項から，DecmFactoryクラスのメソッドについて説明します。

＜この節の構成＞

3.1.1　 DecmFactory

3.1.2　 createDecmACLPerm

3.1.3　 createDecmDoc

3.1.4　 createDecmSubFile

3.1.5　 createDecmDocProp

3.1.6　 createDecmDocPerm

3.1.7　 createDecmFolderTree

3.1.8　 createDecmFolder

3.1.9　 createDecmFolderProp

3.1.10　 createDecmFolderPerm

3.1.11　 createDecmSelect

3.1.12　 createDecmCondition

3.1.13　 createDecmCondGroup

3.1.14　 createDecmDocMasterList

3.1.15　 createDecmDocMaster

3.1.16　 createDecmDocMasterProp

3.1.17　 createDecmDocPropMaster

3.1.18　 createDecmDocPropMasterProp

3.1.19　 initUserProp（文字列型）

3.1.20　 initUserProp（文字列型以外）

3.1.21　 isCapacityUse

3.1.1　 DecmFactory

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

コンストラクタです。

このクラスを利用して，DocumentBroker Standard GUI Development Kitが提供しているすべてのクラスのインスタンスが生成できます。ただし，例外クラスのインスタンスは生成できません。

(2)　形式

DecmFactory(
 DbjDocSpace docSpace,
 String  userId,
 String  userName,
 int dbType
)

(3)　引数

DbjDocSpace docSpace

ログインユーザに対するDbjDocSpaceインターフェースを指定します。

String userId

ログインユーザのユーザIDを指定します。

String userName

ログインユーザのユーザ名称を指定します。

int dbType

使用するデータベース種別を指定します。

指定できる値を次に示します。

DecmFactory.DB_HIRDB

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数docSpaceに対する「通常オブジェクトの設定チェック」に失敗した場合

引数userIdの値に対する「通常文字列の設定チェック」に失敗した場合

引数userNameに対する「通常文字列の設定チェック」に失敗した場合

引数dbTypeに対して，指定できる値以外の値を指定した場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

3.1.2　 createDecmACLPerm

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

アクセス権限表現用クラスのインスタンスを生成します。

このメソッドを利用して，DecmACLPermクラスのインスタンスを生成してください。

(2)　形式

DecmACLPerm createDecmACLPerm()

(3)　引数

なし

(4)　戻り値

アクセス権限表現用クラスのインスタンス

(5)　例外

なし

3.1.3　 createDecmDoc

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書操作クラスのインスタンスを生成します。

このメソッドを利用して，DecmDocクラスのインスタンスを生成してください。

(2)　形式

DecmDoc createDecmDoc()

(3)　引数

なし

(4)　戻り値

文書操作クラスのインスタンス

(5)　例外

なし

3.1.4　 createDecmSubFile

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

関連ファイル操作クラスのインスタンスを生成します。

このメソッドを利用して，DecmSubFileクラスのインスタンスを生成してください。

(2)　形式

DecmSubFile createDecmSubFile()

(3)　引数

なし

(4)　戻り値

関連ファイル操作クラスのインスタンス

(5)　例外

なし

3.1.5　 createDecmDocProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書プロパティクラスのインスタンスを生成します。

このメソッドを利用して，DecmDocPropクラスのインスタンスを生成してください。

(2)　形式

DecmDocProp createDecmDocProp()

(3)　引数

なし

(4)　戻り値

文書プロパティクラスのインスタンス

(5)　例外

なし

3.1.6　 createDecmDocPerm

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書アクセス権限クラスのインスタンスを生成します。

このメソッドを利用して，DecmDocPermクラスのインスタンスを生成してください。

(2)　形式

DecmDocPerm createDecmDocPerm()

(3)　引数

なし

(4)　戻り値

文書アクセス権限クラスのインスタンス

(5)　例外

なし

3.1.7　 createDecmFolderTree

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダツリー階層情報取得クラスのインスタンスを生成します。

このメソッドを利用して，DecmFolderTreeクラスのインスタンスを生成してください。

(2)　形式

DecmFolderTree createDecmFolderTree()

(3)　引数

なし

(4)　戻り値

フォルダツリー階層情報取得クラスのインスタンス

(5)　例外

なし

3.1.8　 createDecmFolder

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダ操作クラスのインスタンスを生成します。

このメソッドを利用して，DecmFolderクラスのインスタンスを生成してください。

(2)　形式

DecmFolder createDecmFolder()

(3)　引数

なし

(4)　戻り値

フォルダ操作クラスのインスタンス

(5)　例外

なし

3.1.9　 createDecmFolderProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダプロパティクラスのインスタンスを生成します。

このメソッドを利用して，DecmFolderPropクラスのインスタンスを生成してください。

(2)　形式

DecmFolderProp createDecmFolderProp()

(3)　引数

なし

(4)　戻り値

フォルダプロパティクラスのインスタンス

(5)　例外

なし

3.1.10　 createDecmFolderPerm

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダアクセス権限クラスのインスタンスを生成します。

このメソッドを利用して，DecmFolderPermクラスのインスタンスを生成してください。

(2)　形式

DecmFolderPerm createDecmFolderPerm()

(3)　引数

なし

(4)　戻り値

フォルダアクセス権限クラスのインスタンス

(5)　例外

なし

3.1.11　 createDecmSelect

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書検索クラスのインスタンスを生成します。

このメソッドを利用して，DecmSelectクラスのインスタンスを生成してください。

(2)　形式

DecmSelect createDecmSelect()

(3)　引数

なし

(4)　戻り値

文書検索クラスのインスタンス

(5)　例外

なし

3.1.12　 createDecmCondition

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索条件クラスのインスタンスを生成します。

このメソッドを利用して，DecmConditionクラスのインスタンスを生成してください。

(2)　形式

DecmCondition createDecmCondition()

(3)　引数

なし

(4)　戻り値

検索条件クラスのインスタンス

(5)　例外

なし

3.1.13　 createDecmCondGroup

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

組み合わせ検索条件クラスのインスタンス生成します。

このメソッドを利用して，DecmCondGroupクラスのインスタンスを生成してください。

(2)　形式

DecmCondGroup createDecmCondGroup()

(3)　引数

なし

(4)　戻り値

組み合わせ検索条件クラスのインスタンス

(5)　例外

なし

3.1.14　 createDecmDocMasterList

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書種別マスタ一覧クラスのインスタンスを生成します。

このメソッドを利用して，DecmDocMasterListクラスのインスタンスを生成してください。

(2)　形式

DecmDocMasterList createDecmDocMasterList()

(3)　引数

なし

(4)　戻り値

文書種別マスタ一覧クラスのインスタンス

(5)　例外

なし

3.1.15　 createDecmDocMaster

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書種別マスタ操作用クラスのインスタンスを生成します。

このメソッドを利用して，DecmDocMasterクラスのインスタンスを生成してください。

(2)　形式

DecmDocMaster createDecmDocMaster()

(3)　引数

なし

(4)　戻り値

文書種別マスタ操作用クラスのインスタンス

(5)　例外

なし

3.1.16　 createDecmDocMasterProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書種別マスタプロパティクラスのインスタンスを生成します。

このメソッドを利用して，DecmDocMasterPropクラスのインスタンスを生成してください。

(2)　形式

DecmDocMasterProp createDecmDocMasterProp()

(3)　引数

なし

(4)　戻り値

文書種別マスタプロパティクラスのインスタンス

(5)　例外

なし

3.1.17　 createDecmDocPropMaster

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

属性値マスタ取得クラスのインスタンスを生成します。

このメソッドを利用して，DecmDocPropMasterクラスのインスタンスを生成してください。

(2)　形式

DecmDocPropMaster createDecmDocPropMaster()

(3)　引数

なし

(4)　戻り値

属性値マスタ取得クラスのインスタンス

(5)　例外

なし

3.1.18　 createDecmDocPropMasterProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

属性値マスタプロパティクラスのインスタンスを生成します。

このメソッドを利用して，DecmDocPropMasterPropクラスのインスタンスを生成してください。

(2)　形式

DecmDocPropMasterProp createDecmDocPropMasterProp()

(3)　引数

なし

(4)　戻り値

属性値マスタプロパティクラスのインスタンス

(5)　例外

なし

3.1.19　 initUserProp（文字列型）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ユーザプロパティ，および文書種別マスタに使用するプロパティで，文字列型のプロパティをシステムに登録します。

このメソッドを複数回コールして，使用する文字列型のプロパティをすべて登録する必要があります。

なお，DecmDoc#setDocProp()メソッドの設定値を有効にする場合は，必ずこのメソッドでプロパティを定義してください。定義していないプロパティの場合，DecmDoc#setDocProp()メソッドで値を設定しても，その値は有効となりません。

(2)　形式

void initUserProp(
 String propName,
 int type,
 int size
)

(3)　引数

String propName

プロパティ名を指定します。

int type

プロパティ名に対する型を指定します。

指定できる値を次に示します。

DecmFactory.PROP_TYPE_STRING（文字列型）

int size

プロパティ長を正の整数で指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数propNameに対する「通常文字列の設定チェック」に失敗した場合

引数typeに対して，指定できる値以外を指定した場合

引数sizeに対して，指定できる値以外を指定した場合

引数propNameに対して，すでに登録済みの値を指定した場合

3.1.20　 initUserProp（文字列型以外）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ユーザプロパティ，および文書種別マスタに使用するプロパティで，文字列型以外のプロパティをシステムに登録します。

このメソッドを複数回コールして，使用する文字列型以外のプロパティをすべて登録する必要があります。

なお，DecmDoc#setDocProp()メソッドの設定値を有効にする場合は，必ずこのメソッドでプロパティを定義してください。定義していないプロパティの場合，DecmDoc#setDocProp()メソッドで値を設定しても，その値は有効となりません。

(2)　形式

void initUserProp(
 String propName,
 int type
)

(3)　引数

String propName

プロパティ名を指定します。

int type

プロパティ名の型を指定します。

指定できる値を次に示します。

DecmFactory.PROP_TYPE_INTEGER（整数型）

DecmFactory.PROP_TYPE_DATE（日付型）

DecmFactory.PROP_TYPE_MASTER（マスタ型）

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数propNamに対する「通常文字列の設定チェック」に失敗した場合

引数typeに対して，指定できる値以外を指定した場合

引数propNameに対して，すでに登録済みの値を指定した場合

3.1.21　 isCapacityUse

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダ下ファイル容量制限機能の使用の有無を取得します。

このメソッドは，接続先のDocumentBrokerサーバのフォルダ下ファイル容量制限機能使用の有無をチェックします。

(2)　形式

boolean isCapacityUse()

(3)　引数

なし

(4)　戻り値

true：容量制限機能を使用できます。

false：容量制限機能を使用できません。

(5)　例外

なし

3.2　 DecmObjectクラス

DecmObjectクラスは，DocumentBroker Standard GUI Development Kitで提供するすべてのクラスの基底クラスです。ただし，例外クラスはDecmObjectクラスから派生しません。

このクラスにDocumentBrokerサーバとの接続情報を格納し，派生クラスはこのクラスに格納している情報をもとに，DocumentBrokerサーバとのアクセスを行います。

なお，DecmObjectクラスにはメソッドはありません。

3.3　 DecmCommonPropクラス

DecmCommonPropクラスは，DocumentBroker Standard GUI Development Kitのプロパティの基底クラスです。プロパティを示すすべてのクラスは，このクラスを継承しています。

次の項から，DecmCommonPropクラスのメソッドについて説明します。

＜この節の構成＞

3.3.1　 getOiid

3.3.2　 getStrProp

3.3.3　 setStrProp

3.3.4　 getIntProp

3.3.5　 setIntProp

3.3.6　 getLongProp

3.3.7　 setLongProp

3.3.1　 getOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

対象となるオブジェクトのOIID値を取得します。

(2)　形式

String getOiid()

(3)　引数

なし

(4)　戻り値

対象となるオブジェクトのOIID文字列

(5)　例外

なし

3.3.2　 getStrProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文字列型，またはマスタ型のプロパティに対するプロパティ値を取得します。

(2)　形式

String getStrProp(
 String fieldName
)

(3)　引数

String fieldName

取得するプロパティ値のプロパティ名を指定します。

定義されていないプロパティ名を指定した場合は，無視されます。

(4)　戻り値

プロパティ値

(5)　例外

DecmApiInvalidParamException

引数fieldNameに対する「通常文字列の設定チェック」に失敗した場合

3.3.3　 setStrProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文字列型，またはマスタ型のプロパティに対するプロパティ値を設定します。

(2)　形式

void setStrProp(
 String fieldName,
 String strValue
)

(3)　引数

String fieldName

設定するプロパティ値のプロパティ名を指定します。

定義されていないプロパティ名を指定した場合は，無視されます。

String strValue

プロパティ名に対する設定値を指定します。

プロパティの更新処理で使用する場合，nullを指定すると，該当するフィールドを更新しません。

マスタ型の値を設定する場合は，設定する属性値コードを最上位からハイフン（-）区切りで指定します。

（凡例）

TOP-SUB01-SUB011-SUB0111

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数fieldNameに対する「通常文字列の設定チェック」に失敗した場合

3.3.4　 getIntProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

整数型，または日付型のプロパティに対するプロパティ値を取得します。

(2)　形式

int getIntProp(
 String fieldName
)

(3)　引数

String fieldName

取得するプロパティ値のプロパティ名を指定します。

定義されていないプロパティ名を指定した場合は，無視されます。

(4)　戻り値

プロパティ値

(5)　例外

DecmApiInvalidParamException

引数fieldNameに対する「通常文字列の設定チェック」に失敗した場合

3.3.5　 setIntProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

整数型，または日付型のプロパティに対するプロパティ値を設定します。

(2)　形式

void setIntProp(
 String fieldName,
 int intValue
)

(3)　引数

String fieldName

設定するプロパティ値の，プロパティ名を指定します。

定義されていないプロパティ名を指定した場合は，無視されます。

int intValue

プロパティ名対する設定値を指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数fieldNameに対する「通常文字列の設定チェック」に失敗した場合

3.3.6　 getLongProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

整数型（Long型）のプロパティに対するプロパティ値を取得します。

(2)　形式

long getLongProp(
 String fieldName
)

(3)　引数

String fieldName

設定するプロパティ値のプロパティ名を指定します。

定義されていないプロパティ名を指定した場合は，無視されます。

(4)　戻り値

プロパティ値

(5)　例外

DecmApiInvalidParamException

引数fieldNameに対する「通常文字列の設定チェック」に失敗した場合

3.3.7　 setLongProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

整数型（Long型）のプロパティに対するプロパティ値を設定します。

(2)　形式

void setLongProp(
 String fieldName,
 long longValue
)

(3)　引数

String fieldName

設定するプロパティ値のプロパティ名を指定します。

定義されていないプロパティ名を指定した場合は，無視されます。

long longValue

プロパティ名に対する設定値を指定します

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数fieldNameに対する「通常文字列の設定チェック」に失敗した場合

3.4　 DecmCommonPermクラス

DecmCommonPermクラスは，DocumentBroker Standard GUI Development Kitのアクセス権限情報の基底クラスです。DocumentBroker Standard GUI Development Kitで提供するすべてのアクセス権限情報を示すクラスは，このクラスを継承しています。

次の項から，DecmCommonPermクラスのメソッドについて説明します。

＜この節の構成＞

3.4.1　 getOwnerId

3.4.2　 setOwnerId

3.4.3　 getOwnerName

3.4.4　 setOwnerName

3.4.5　 getEveryonePerm

3.4.6　 setEveryonePerm

3.4.7　 getACLList

3.4.8　 setACLList

3.4.1　 getOwnerId

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

オブジェクトの所有者のユーザIDを取得します。

(2)　形式

String getOwnerId()

(3)　引数

なし

(4)　戻り値

オブジェクトの所有者のユーザID

(5)　例外

なし

3.4.2　 setOwnerId

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

オブジェクトの所有者のユーザIDを設定します。

(2)　形式

void setOwnerId(
 String ownerId
)

(3)　引数

String ownerId

オブジェクトの所有者のユーザIDを指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数ownerIdに対する「通常文字列の設定チェック」に失敗した場合

3.4.3　 getOwnerName

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

オブジェクトの所有者名称を取得します。

(2)　形式

String getOwnerName()

(3)　引数

なし

(4)　戻り値

オブジェクトの所有者名称

(5)　例外

なし

3.4.4　 setOwnerName

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

オブジェクトの所有者名称を設定します。

(2)　形式

void setOwnerName(
 String ownerName
)

(3)　引数

String ownerName

オブジェクトの所有者名称を指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数ownerNameに対する「通常文字列の設定チェック」に失敗した場合

3.4.5　 getEveryonePerm

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

全ユーザに対するアクセス権限を取得します。

(2)　形式

int getEveryonePerm()

(3)　引数

なし

(4)　戻り値

全ユーザに対するアクセス権限

戻り値を次に示します。

DecmACLPerm.PERM_NONE

DecmACLPerm.PERM_READ

DecmACLPerm.PERM_LINK

DecmACLPerm.PERM_UPDATE

DecmACLPerm.PERM_FULL

(5)　例外

なし

3.4.6　 setEveryonePerm

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

全ユーザに対するアクセス権限を設定します。

全ユーザに対するアクセス権限の設定，または変更ができないオブジェクトに対して操作を行う場合，このメソッドで値を設定しているとDecmApiNotSupport例外がスローされます。

(2)　形式

void setEveryonePerm(
 int everyonePerm
)

(3)　引数

int everyonePerm

全ユーザに対するアクセス権限を指定します。

指定できる値を次に示します。

DecmACLPerm.PERM_NONE

DecmACLPerm.PERM_READ

DecmACLPerm.PERM_LINK

DecmACLPerm.PERM_UPDATE

DecmACLPerm.PERM_FULL

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数everyonePermに対して，指定できる値以外を指定した場合

3.4.7　 getACLList

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

アクセス権限のリストを取得します。

(2)　形式

Vector<DecmACLPerm> getACLList()

(3)　引数

なし

(4)　戻り値

アクセス権限のリスト

(5)　例外

なし

3.4.8　 setACLList

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

アクセス権限のリストを設定します。

アクセス権限リストを設定，または変更できないオブジェクトに対して操作を行う場合，このメソッドで値を設定しているとDecmApiNotSupport例外がスローされます。

(2)　形式

void setACLList(
 Vector<DecmACLPerm> aclList
)

(3)　引数

Vector<DecmACLPerm> aclList

アクセス権限一覧を指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数aclListに対する「通常オブジェクトの設定チェック」に失敗した場合

3.5　 DecmACLPermクラス

DecmACLPermクラスは，DocumentBroker Standard GUI Development Kitのアクセス権限表現用クラスです。

次の項から，DecmACLPermクラスのメソッドについて説明します。

＜この節の構成＞

3.5.1　 getSubject

3.5.2　 setSubject

3.5.3　 getSubjectType

3.5.4　 setSubjectType

3.5.5　 getPermission

3.5.6　 setPermission

3.5.1　 getSubject

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

アクセス権限対象のID（ユーザID，組織ID，グループID）を取得します。

(2)　形式

String getSubject()

(3)　引数

なし

(4)　戻り値

アクセス権限対象のID（ユーザID，組織ID，グループID）

(5)　例外

なし

3.5.2　 setSubject

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

アクセス権限対象のID（ユーザID，組織ID，グループID）を設定します。

(2)　形式

void setSubject(
 String subject
)

(3)　引数

String subject

アクセス権限対象のID（ユーザID，組織ID，グループID）を指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数subjectに対する「通常文字列の設定チェック」に失敗した場合

3.5.3　 getSubjectType

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

アクセス権限対象の種別（ユーザ，組織，グループ）を取得します。

(2)　形式

int getSubjectType()

(3)　引数

なし

(4)　戻り値

アクセス権限対象の種別（ユーザ，組織，グループ）

(5)　例外

なし

3.5.4　 setSubjectType

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

アクセス権限対象の種別（ユーザ，組織，グループ）を設定します。

なお，組織IDとグループIDは同じ値を設定します。

(2)　形式

void setSubjectType(
 int subjectType
)

(3)　引数

int subjectType

アクセス権限対象の種別です。

指定できる値を次に示します。

DecmACLPerm.PERM_TYPE_USER

DecmACLPerm.PERM_TYPE_GROUP

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数subjectTypeに対して，指定できる値以外を指定した場合

3.5.5　 getPermission

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

アクセス権限を取得します。

(2)　形式

int getPermission()

(3)　引数

なし

(4)　戻り値

アクセス権限

戻り値を次に示します。

DecmACLPerm.PERM_NONE

DecmACLPerm.PERM_READ

DecmACLPerm.PERM_LINK

DecmACLPerm.PERM_UPDATE

DecmACLPerm.PERM_FULL

(5)　例外

なし

3.5.6　 setPermission

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

アクセス権限を設定します。

(2)　形式

void setPermission(
 int permission
)

(3)　引数

int permission

ACLのパーミッションを指定します。

指定できる値を次に示します。

DecmACLPerm.PERM_NONE

DecmACLPerm.PERM_READ

DecmACLPerm.PERM_LINK

DecmACLPerm.PERM_UPDATE

DecmACLPerm.PERM_FULL

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数permissionに対して，指定できる値以外を指定した場合

3.6　 DecmDBControlクラス

DecmDBControlクラスは，DocumentBroker Standard GUI Development Kitのデータベース操作の基底クラスです。

DocumentBroker Standard GUI Development Kitで提供するすべてのデータベースを操作するクラスは，このクラスの派生クラスです。

なお，DecmDBControlクラスにはメソッドはありません。

4.　文書操作パッケージ提供クラスの詳細

この章では，文書操作パッケージ（jp.co.hitachi_system.sContents.API.Document）提供のクラス，およびメソッドについて説明します。

＜この章の構成＞

4.1　 DecmDocクラス

4.2　 DecmDocPropクラス

4.3　 DecmDocPermクラス

4.4　 DecmSubFileクラス

4.1　 DecmDocクラス

DecmDocクラスは，文書操作を扱うクラスです。このクラスのインスタンスで，1文書のオブジェクトを表現します。

このクラスは以下の機能を提供します

文書の作成

文書の削除

ごみ箱への移動

ごみ箱から元に戻す処理

文書のプロパティ取得

文書のプロパティ更新

文書のアクセス権限取得

文書のアクセス権限更新

文書実体（コンテント）のダウンロード

文書の履歴取得

文書の履歴削除

チェックアウト処理

キャンセルチェックアウト処理

チェックイン処理

文書の移動

関連ファイル一覧の取得

プロパティ一覧

DecmDocクラスで扱うプロパティの一覧を次の表に示します。各プロパティの詳細は，「付録A.1　DocumentBroker Standard GUI Development Kitで使用するプロパティ」を参照してください。

表4-1　 DecmDocクラスで扱うプロパティ

プロパティ名
データ型
参照可能メソッド
更新可能メソッド

fetchDocProp()
fetchDocHistory()
createDoc()
updateDocProp()
checkinDoc()

dmaProp_OIID
String
○
－

esysProp_Name
String
○
○

dbrProp_OwnerId
String
○
－

dbuUserProp_OwnerName
String
○
－

esysProp_CreateTime
Integer
○
－

esysProp_Creator
String
○
－

esysProp_ModifyTime
Integer
○
－

esysProp_Modifier
String
○
－

dbuUserProp_ModifierName
String
○
－

dbuUserProp_ReservedUserId
String
○
－

dbuUserProp_ReservedUserName
String
○
－

esysProp_Comment
String
○
○

ecmProp_DocTypeOIID
String
○
－

ecmProp_DocTypeOIID_FULL
String
○
－

ecmProp_CHOiid
String
○
－

ecmProp_CHOiid_FULL
String
○
－

ecmProp_DocType
Integer
○
－

ecmProp_FileName
String
○
－

ecmProp_FileSize
Integer
○
－

ecmProp_ParentContainer
String
○
－

ecmProp_ParentContainer_FULL
String
○
－

ecmProp_DeleteFlag
Integer
○
－

ecmProp_DeleteUserId
String
○
－

ecmProp_DeleteTime
Integer
○
－

ecmProp_DocNumber
String
○
－

ecmProp_UserInt1～ecmProp_UserInt5
Integer
○※
○※

ecmProp_UserStr1～ecmProp_UserStr5
String
○※
○※

ecmProp_DocTypePropInt1～ecmProp_DocTypePropInt10
Integer
○※
○※

ecmProp_DocTypePropStr1～ecmProp_DocTypePropStr10
String
○※
○※

ecmProp_DocTypePropLongStr1～ecmProp_DocTypePropLongStr5
String
○※
○※

（凡例）

○：デフォルトで取得，および更新ができます。

－：該当しません。

注※

DecmFactory#initUserPropメソッド，DecmFactory#initUserPropメソッドを使用してプロパティ名を登録しておく必要があります。

次の項から，DecmDocクラスのメソッドについて説明します。

＜この節の構成＞

4.1.1　 getOiid

4.1.2　 setOiid

4.1.3　 setFolderOiid

4.1.4　 setDocProp

4.1.5　 setDocPerm

4.1.6　 setFilePath

4.1.7　 setTextPath

4.1.8　 setDocMaster

4.1.9　 setRenditionType

4.1.10　 setSubFileList

4.1.11　 isSubTraceMode

4.1.12　 setSubTraceMode

4.1.13　 createDoc

4.1.14　 deleteDoc

4.1.15　 trashDoc

4.1.16　 trashBackDoc

4.1.17　 fetchDocProp

4.1.18　 updateDocProp

4.1.19　 fetchDocPerm

4.1.20　 updateDocPerm

4.1.21　 downloadContent

4.1.22　 fetchDocHistory

4.1.23　 deleteDocHistory

4.1.24　 checkoutDoc

4.1.25　 cancelCheckoutDoc

4.1.26　 checkinDoc

4.1.27　 moveDoc

4.1.28　 fetchSubFile

4.1.29　 lockRead

4.1.30　 lockWrite

4.1.1　 getOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

操作対象文書のバージョニングオブジェクトのOIIDを取得します。

(2)　形式

String getOiid()

(3)　引数

なし

(4)　戻り値

操作対象文書のバージョニングオブジェクトのOIID値

(5)　例外

なし

4.1.2　 setOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

操作対象文書のバージョニングオブジェクトのOIIDを設定します。

このメソッドは既存の文書にアクセスする場合に最初にコールしてください。なお，OIIDに対する文書の存在チェックは行いません。

(2)　形式

void setOiid(
 String oiid
)

(3)　引数

String oiid

操作対象文書のバージョニングオブジェクトのOIIDを指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数OIIDに対する「133桁OIIDの設定チェック」に失敗した場合

4.1.3　 setFolderOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書の上位フォルダのOIIDを設定します。

文書作成前に，必ずこのメソッドをコールしてください。なお，OIIDに対するフォルダの存在チェックは行いません。

(2)　形式

void setFolderOiid(
 String folderOiid
)

(3)　引数

String folderOiid

文書を登録するフォルダのOIIDを指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数folderOiidに対する「133桁OIIDの設定チェック」に失敗した場合

4.1.4　 setDocProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書のプロパティを設定します。

文書作成前に，必ずこのメソッドをコールしてください。文書の作成，プロパティの更新，およぴチェックインの実行前にこのメソッドをコールすると，文書のプロパティ値の変更ができます。

文書種別マスタに定義されているプロパティ一覧と，docPropに設定しているプロパティの整合性についてはチェックを行いません。ユーザアプリケーション側で整合性を確保してください。

なお，マスタ型のプロパティに対しては指定値の妥当性チェックを行います。

(2)　形式

void setDocProp(
 DecmDocProp docProp
)

(3)　引数

DecmDocProp docProp

文書のプロパティを指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数docPropに対する「通常オブジェクトの設定チェック」に失敗した場合

引数docPropに対する「プロパティの設定規則チェック」に失敗した場合

4.1.5　 setDocPerm

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書のアクセス権限を設定します。

文書の作成，およびアクセス権限の変更の実行前にこのメソッドをコールすると，文書のアクセス権限の更新ができます。

このメソッドを使って，文書の所有者にメソッド実行ユーザと異なるユーザを設定する場合，セキュリティ管理者で実行してください。一般ユーザで実行した場合，DecmApiAccessException例外が発生する場合があります。

なお，画面GUIの定義である配置ディスクリプタ（web.xml）のapp.ACLObjNum（アクセス権限リストの設定数）の設定値を超えるアクセス権限のリストを指定しても，エラーにはなりません。

配置ディスクリプタの詳細については，マニュアル「uCosminexus DocumentBroker Version 3 Standard GUI　システム導入・運用ガイド」を参照してください。

(2)　形式

void setDocPerm(
 DecmDocPerm docPerm
)

(3)　引数

DecmDocPerm docPerm

文書のアクセス権限を指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数docPermに対する「通常オブジェクトの設定チェック」に失敗した場合

4.1.6　 setFilePath

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書の実体（コンテント）ファイルのローカルディスク上でのパスを設定します。

このメソッドは，文書の作成，プロパティの更新，およびチェックイン実行の前にコールしてください。

(2)　形式

void setFilePath(
 String filePath
)

(3)　引数

String filePath

文書のコンテントファイルのローカルディスク上でのパスを指定します。

null，または「""」（空文字）を指定した場合は，空文書が作成されます。

ただし，チェックイン時には必ず文書ファイルを指定してください。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数filePathに指定したファイル名が255バイト（UTF-8）より大きい場合

4.1.7　 setTextPath

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

全文検索用のテキストファイルの，ローカルディスク上でのパスを設定します。

このメソッドは，文書の作成，プロパティの更新，およびチェックイン実行の前にコールしてください。

(2)　形式

void setTextPath(
 String textPath
)

(3)　引数

String textPath

全文検索用のテキストファイルの，ローカルディスク上でのパスを指定します。

null，または「""」（空文字）を指定した場合は，全文検索用のテキストファイルを登録しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数textPathに指定したファイル名が255バイト（UTF-8）より大きい場合

4.1.8　 setDocMaster

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書種別マスタのOIIDを設定します。

(2)　形式

void setDocMaster(
 String docMasterOiid
)

(3)　引数

String docMasterOiid

使用する文書種別マスタのOIIDを指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数docMasterOiidに対する「133桁OIIDの設定チェック」に失敗した場合

4.1.9　 setRenditionType

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

登録する文書ファイルの参照用のファイル（PDF）を設定します。

このメソッドをコールすると，PDFの格納領域を作成します。

なお，PDFを作成する対象となる文書の拡張子は，uCosminexus DocumentBroker Version 3 Standard GUIの配置ディスクリプタ（web.xml）のapp.RenderingExtListで設定している拡張子とあわせてください。

詳細については，マニュアル「uCosminexus DocumentBroker Version 3 Standard GUI　システム導入・運用ガイド」を参照してください。

(2)　形式

void setRenditionType(
 String renditionType
)

(3)　引数

String renditionType

登録する文書ファイルの参照用のファイル（PDF）を設定する場合は，「application/pdf」を指定してください。

null，または「""」（空文字）を指定した場合は，文書をPDFに変換しません。

(4)　戻り値

なし

(5)　例外

なし

4.1.10　 setSubFileList

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

関連ファイルリストを設定します。

(2)　形式

void setSubFileList(
 Vector<DecmSubFile> subFileList
)

(3)　引数

Vector<DecmSubFile> subFileList

関連ファイルリストを指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数subFileListに対する「通常オブジェクトの設定チェック」に失敗した場合

引数subFileListに指定した要素に対して，ファイルのローカルディスク上でのパス（setFilePathメソッド）を発行してない場合

関連ファイル内で，ファイル名に同じ名称を指定している場合

4.1.11　 isSubTraceMode

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

関連ファイルの監査証跡ログの出力有無を取得します。

(2)　形式

boolean isSubTraceMode()

(3)　引数

なし

(4)　戻り値

関連ファイルの監査証跡ログの出力有無

(5)　例外

なし

4.1.12　 setSubTraceMode

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

主ファイルと関連ファイルについて操作するメソッドで，関連ファイルの監査証跡ログを出力するかどうかを設定します。

このメソッドを発行しない場合のデフォルト値は，false（出力しない）です。

DecmDocクラス内で，引数にoutputLogが必要なメソッドに対してfalseを指定した場合，このメソッドでtrue（出力する）を指定していても，関連ファイルの監査証跡ログは出力されません。

(2)　形式

void setSubTraceMode(
 boolean subTraceMode
)

(3)　引数

boolean subTraceMode

関連ファイルの監査証跡ログの出力するかどうかを指定します。

true：関連ファイルの監査証跡ログを出力します。

false：関連ファイルの監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

なし

4.1.13　 createDoc

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

一般文書を作成します。

事前に関連ファイルリストを設定している場合は，関連ファイル付きの文書を作成します。

主ファイル
文書の実体（コンテント）付き文書，および空文書を作成できます。
アクセス権限情報を指定した場合，アクセス権限情報も更新されます。
指定しない場合は，登録フォルダに設定されているアクセス権限を適用します。

関連ファイル
文書のコンテント付きファイルを作成できます。
ファイルサイズとファイル名以外のプロパティ，アクセス権限などは主ファイルと同じ値が設定されます。

(2)　形式

String createDoc(
 boolean docNumber,
 boolean outputLog
)

(3)　引数

boolean docNumber

文書番号の採番の実施フラグを指定します。

なお，setDocMaster()が未発行の場合，この引数にtrue（採番する）を指定しても指定は無視されます。

true：文書番号を採番します。

false：文書番号を採番しません。

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

作成した一般文書のバージョニングオブジェクトのOIID値

(5)　例外

DecmApiInvalidInitialException

setFolderOiidメソッドを発行していない場合

setDocPropメソッドを発行していない場合

setDocPropメソッドを発行しているが，esysProp_Nameを設定していない場合

setFilePathメソッドで指定したファイルと，setSubFileListメソッドで指定したファイルのファイル名が重複している場合

DecmApiIOException

setFilePathメソッド， setTextPathメソッド，またはsetSubFileListメソッドで指定したファイルの読み込み中に，エラーが発生した場合

DecmApiFolderNotFoundException

上位フォルダが存在しない場合

DecmApiCapacityException

フォルダの容量制限を超えた場合

DecmApiMasterNotFoundException

指定した文書種別マスタが存在しない場合

DecmApiFolderNotCorrectException

上位フォルダに文書フォルダ以外のフォルダを指定した場合

文書が作成できない文書フォルダを指定した場合

上位フォルダの文書種別マスタと，文書の文書種別マスタが矛盾している場合

DecmApiDocNumNotCorrectException

引数docNumberにtrueを指定した場合で，採番できる有効な文書種別マスタを指定していないとき

DecmApiAccessException

文書管理サーバでアクセス権限エラーが発生した場合（DbjAccessControlException）

DecmApiInvalidPropValueException

指定した文書のプロパティ値が不正な場合

DecmApiInvalidFileException

登録するファイルが不正の場合，または0バイトのファイルを登録した場合

DecmApiACLOutOfRangeException

作成できる個数以上のACLを指定している場合

DecmApiNotSupport

アクセス権限情報の指定が不正な場合

指定した操作をサポートしていない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.14　 deleteDoc

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

一般文書をデータベースから完全に削除します。

操作対象の一般文書に関連ファイルが存在している場合，関連ファイルも同時に削除します。

(2)　形式

void deleteDoc(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiDocNotFoundException

指定した一般文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

指定した一般文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiNotSupport

指定した操作をサポートしていない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.15　 trashDoc

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

一般文書をごみ箱に移動します。

操作対象の一般文書に関連ファイルが存在している場合，関連ファイルも同時にごみ箱に移動します。

(2)　形式

void trashDoc(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiDocNotFoundException

指定した一般文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

指定した一般文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiNotSupport

指定した操作をサポートしていない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.16　 trashBackDoc

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ごみ箱から文書を戻します。

対象文書に関連ファイルが存在している場合，関連ファイルも同時にごみ箱から戻します。

(2)　形式

void trashBackDoc(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiDocNotFoundException

指定した文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

指定した文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiNotSupprot

指定した操作をサポートしていない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.17　 fetchDocProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

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

対象文書に関連ファイルが存在しているかどうかにかかわらず，主ファイルのプロパティだけを取得します。

関連ファイルのプロパティを取得する場合は，DecmSubFile#fetchFilePropメソッドをコールしてください。

(2)　形式

DecmDocProp fetchDocProp(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

文書のプロパティ

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiDocNotFoundException

文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

指定した文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

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など）

4.1.19　 fetchDocPerm

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書のアクセス権限情報を取得します。

(2)　形式

DecmDocPerm fetchDocPerm(
 boolean outputLog
)

(3)　引数

boolean outputLog:

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

文書に対するアクセス権限情報

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiDocNotFoundException

文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

指定した文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.20　 updateDocPerm

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書のアクセス権限情報を更新します。

対象文書に関連ファイルが存在している場合，関連ファイルのアクセス権限も同時に更新します。

(2)　形式

void updateDocPerm(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

setDocPermメソッドを発行していない場合

DecmApiDocNotFoundException

文書がすでに削除された場合，または存在しない場合

DecmApiNotSupport

指定した文書に対するアクセス権限情報の更新をサポートしていない場合

DecmApiAccessException

指定した文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiACLOutOfRangeException

作成できる個数以上のACLを指定している場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.21　 downloadContent

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書の実体（コンテント）をダウンロードします。

対象文書に関連ファイルが存在しているかどうかに関係なく，主ファイルのコンテントだけをダウンロードします。

関連ファイルのコンテントをダウンロードする場合は，DecmSubFile#downloadContentメソッドをコールしてください。

(2)　形式

String downloadContent(
 String dvOiid,
 String filePath,
 boolean  bFileMode,
 boolean outputLog
)

(3)　引数

String dvOiid

対象文書のバージョンオブジェクトのOIIDを指定します。

null，または「""」（空文字）を指定した場合は，最新バージョンの文書のコンテントがダウンロードされます。

String filePath

文書のコンテントのダウンロード先のファイルパスを，フルパスで指定します。

boolean bFileMode

文書のコンテントをダウンロードするファイルを指定します。

true：オリジナルファイルのコンテントをダウンロードします。

false：参照用のファイル（PDF）に変換された文書のコンテントをダウンロードします。

文書のコンテントが存在しない場合は，DecmApiFileNotFoundException例外をスローします。

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

文書のコンテントのダウンロード先ファイルのフルパス

(5)　例外

DecmApiInvalidParamException

引数dvOiidがnull，または「""」（空文字）でなく「133桁OIIDの設定チェック」に失敗した場合

引数filePathに対する「通常文字列の設定チェック」に失敗した場合

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiIOException

引数filePathで指定したファイルへの書き込み中にエラーが発生した場合

DecmApiDocNotFoundException

文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

文書管理サーバでアクセス権限エラーが発生した場合（DbjAccessControlException）

DecmApiNotSupport

指定した操作をサポートしていない場合

DecmApiFileNotFoundException

文書のコンテントが存在しない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.22　 fetchDocHistory

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書の履歴を取得します。

取得するのは，文書のプロパティです。

操作対象の文書に関連ファイルが存在しているかどうかにかかわらず，主ファイルの履歴だけを取得します。

取得した主ファイルの履歴は，バージョンの降順でソートします。

古い版（バージョン）の関連ファイルの履歴を取得する場合は，fetchSubFileメソッドの引数に取得したい版（バージョン）の主ファイルのバージョンオブジェクトのOIIDを指定してください。

(2)　形式

Vector<DecmDocProp> fetchDocHistory(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

文書の履歴（プロパティリスト形式）

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiDocNotFoundException

文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

指定した文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.23　 deleteDocHistory

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

一般文書の履歴を削除します。

操作対象の一般文書に関連ファイルが存在している場合，関連ファイルの履歴も同時に削除します。

(2)　形式

void deleteDocHistory(
 String dvOiid,
 boolean outputLog
)

(3)　引数

String dvOiid

操作対象の一般文書のバージョンオブジェクトのOIIDを指定します。

null，または「""」（空文字）を指定した場合，最新バージョンの一般文書の履歴を削除します。

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数dvOiidがnull，または「""」（空文字）でなく「133桁OIIDの設定チェック」に失敗した場合

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiLastVersionException

指定した一般文書の最後の1バージョンを削除しようとした場合（DbjLastVersionException）

DecmApiDocNotFoundException

指定した一般文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

指定した一般文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiNotSupport

指定した操作をサポートしていない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.24　 checkoutDoc

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

一般文書をチェックアウトします。

一般文書の実体（コンテント）を取得する場合は，downloadContentメソッドをコールしてください。

操作対象の一般文書に関連ファイルが存在している場合，関連ファイルも同時にチェックアウトします。

(2)　形式

void checkoutDoc(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiAlreadyCheckoutException

文書管理サーバでチェックアウト状態不正エラー（すでにチェックアウト済み）が発生した場合（DbjAlreadyCheckOutException）

DecmApiDocNotFoundException

指定した一般文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

指定した一般文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiNotSupport

指定した操作をサポートしていない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.25　 cancelCheckoutDoc

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書のチェックアウトをキャンセルします。

対象文書に関連ファイルが存在している場合，関連ファイルも同時にチェックアウトをキャンセルします。

(2)　形式

void cancelCheckoutDoc(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiNotCheckoutException

文書管理サーバでチェックアウト状態不正エラー（未チェックアウト）が発生した場合（DbjNotCheckOutException）

DecmApiDocNotFoundException

文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

指定した文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiNotSupport

指定した操作をサポートしていない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

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など）

4.1.27　 moveDoc

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

一般文書を移動します。

移動元の一般文書に対して「所有者」権限が必要です。

また，移動元のフォルダ，および移動先フォルダに対して，次のどれかのアクセス権限が必要です。

すべて

更新

リンク

移動元の一般文書には，チェックアウト中以外の一般文書を指定できます。

移動先フォルダには，一般文書の作成ができる文書フォルダを指定できます。

操作対象の一般文書に関連ファイルが存在している場合，関連ファイルも同時に移動します。

(2)　形式

void moveDoc(
 String targetFolderOiid,
 boolean outputLog
)

(3)　引数

String targetFolderOiid

一般文書の移動先フォルダのOIIDを指定します。

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログ出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数targetFolderOiidに対する「133桁OIIDの設定チェック」に失敗した場合

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiDocNotFoundException

指定した一般文書がすでに削除された場合，または存在しない場合

DecmApiFolderNotFoundException

一般文書の移動先に指定したフォルダが存在しない場合

DecmApiCapacityException

一般文書の移動先に指定したフォルダの容量制限を超えた場合

DecmApiAccessException

指定した一般文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiNotSupport

公開文書を移動しようとした場合

移動先に指定できないフォルダを指定した場合

指定した操作をサポートしていない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.28　 fetchSubFile

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

主ファイルのバージョンオブジェクトと関連付けられた，関連ファイルのバージョンオブジェクトのリストを取得します。

関連ファイルのプロパティ，および実体（コンテント）を取得する場合は，このメソッドで取得したDecmSubFileクラスのインスタンスを使用してください。

取得した関連ファイルリストは，ファイル名の昇順でソートします。

(2)　形式

Vector<DecmSubFile> fetchSubFile(
 String dvOiid
)

(3)　引数

String dvOiid

対象文書のバージョンオブジェクトのOIIDを指定します。

null，または「""」（空文字）を指定した場合，最新のバージョンの主ファイルに関連付けられた関連ファイルリストを取得します。

(4)　戻り値

主ファイルと関連付けられた関連ファイルリスト

(5)　例外

DecmApiInvalidParamException

引数dvOiidが，null，または「""」（空文字）でなく「133桁OIIDの設定チェック」に失敗した場合

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiDocNotFoundException

文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

指定した文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.1.29　 lockRead

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書に対する参照ロックの予約を行います。

このメソッドのコール後に文書データに対するアクセスを行うと，参照ロックが取得されます。

なお，1トランザクション中にこのメソッドとlockWriteメソッドを複数回コールした場合，最後にコールしたメソッドが有効となります。

(2)　形式

void lockRead()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

4.1.30　 lockWrite

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書に対する更新ロックの予約を行います。

このメソッドのコール後に文書データに対するアクセスを行うと，更新ロックが取得されます。

なお，1トランザクション中にこのメソッドとlockReadメソッドを複数回コールした場合は，最後にコールしたメソッドが有効となります。

(2)　形式

void lockWrite()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

4.2　 DecmDocPropクラス

DecmDocPropクラスは，文書プロパティを扱うクラスです。このクラスのインスタンスで，文書に設定されているプロパティを表現します。

以下の機能で，このクラスのインスタンスを使用します。

文書の作成

文書のプロパティ取得

文書のプロパティ更新

文書のチェックイン処理

スーパークラスは，DecmCommonPropクラスです。

なお，DecmCommonPropクラスにはメソッドはありません。

4.3　 DecmDocPermクラス

DecmDocPermクラスは，文書アクセス権限を扱うクラスです。このクラスのインスタンスで，文書に設定されているアクセス権限情報を表現します。

以下の機能で，このクラスのインスタンスを使用します。

文書のアクセス権限取得

文書のアクセス権限更新

スーパークラスは，DecmCommonPermクラスです。

なお，DecmDocPropクラスにはメソッドはありません。

4.4　 DecmSubFileクラス

DecmSubFileクラスは，関連ファイルの操作を扱うクラスです。このクラスのインスタンスで，一つの文書の関連ファイルのオブジェクトを表現します。

以下の機能で，このクラスのインスタンスを使用します。

関連ファイルのプロパティ取得

関連ファイルの実体（コンテント）のダウンロード

スーパークラスは，DecmDBControlクラスです。

プロパティ一覧

DecmSubFileクラスで扱うプロパティの一覧を次の表に示します。各プロパティの詳細は，「付録A.1　DocumentBroker Standard GUI Development Kitで使用するプロパティ」を参照してください。

表4-2　 DecmDocクラスで扱うプロパティ

プロパティ名 | データ型 | 参照可能メソッド
fetchFileProp()
ecmProp_FileName | String | ○
ecmProp_FileSize | Integer | ○

次の項から，DecmSubFileクラスのメソッドについて説明します。

＜この節の構成＞

4.4.1　 setFilePath

4.4.2　 setRenditionType

4.4.3　 fetchFileProp

4.4.4　 downloadContent

4.4.1　 setFilePath

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書の実体（コンテント）ファイルのローカルディスク上でのパスを設定します。

このメソッドは，主ファイルに対する文書の作成，プロパティの更新，およびチェックインの実行前にコールしてください。

(2)　形式

void setFilePath(
 String filePath
)

(3)　引数

String filePath

文書のコンテントファイルのローカルディスク上でのパスを指定します。

主ファイルとは異なり，関連ファイルに対してnull，または「""」（空文字）の指定はできません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数filePathに指定したファイル名が255バイト（UTF-8）より大きい場合

引数String filePathに，null，または「""」（空文字）を指定している場合

引数filePathに対する「通常文字列の設定チェック」に失敗した場合

4.4.2　 setRenditionType

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

登録する文書ファイルの参照用のファイル（PDF）を設定します。

このメソッドをコールすると， PDFの格納領域を作成します。

なお，PDFを作成する対象となる文書の拡張子は，uCosminexus DocumentBroker Version 3 Standard GUIの配置ディスクリプタ（web.xml）のapp.RenderingExtListで設定している拡張子とあわせてください。

詳細については，マニュアル「uCosminexus DocumentBroker Version 3 Standard GUI　システム導入・運用ガイド」を参照してください。

(2)　形式

void setRenditionType(
 String renditionType
)

(3)　引数

String renditionType

登録する文書ファイルの参照用のファイル（PDF）を設定する場合は，「application/pdf」を指定してください。

null，または「""」（空文字）を指定した場合は，文書をPDFに変換しません。

(4)　戻り値

なし

(5)　例外

なし

4.4.3　 fetchFileProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書のプロパティを取得します。

関連ファイル一覧取得メソッド（DecmDoc#fetchSubFile）の第一引数で指定した主ファイルのバージョンと関連付けられたバージョンが，プロパティ取得の対象となります。

(2)　形式

DecmDocProp fetchFileProp(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

文書のプロパティ

(5)　例外

DecmApiInvalidInitialException

DecmDoc#fetchSubFileで取得したインスタンス以外のインスタンスを使用して，このメソッドをコールした場合

DecmApiDocNotFoundException

文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

指定した文書に対してアクセス権限がない場合（DbjAccessControlException）

DecmApiDBException:

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

4.4.4　 downloadContent

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書の実体（コンテント）をダウンロードします。

関連ファイル一覧取得メソッド（DecmDoc#fetchSubFileメソッド）の第一引数で指定した主ファイルのバージョンと関連付けられたバージョンが，文書のコンテントのダウンロード対象となります。

(2)　形式

String downloadContent(
 String filePath,
 boolean  bFileMode,
 boolean outputLog
)

(3)　引数

String filePath

文書のコンテントのダウンロード時のファイルパスを，フルパスで指定します。

boolean bFileMode

文書のコンテントをダウンロードするファイルを指定します。

true：オリジナルファイルのコンテントをダウンロードします。

false：参照用のファイル（PDF）に変換された文書のコンテントをダウンロードします。

文書のコンテントが存在しない場合，DecmApiFileNotFoundException例外をスローします。

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

文書のコンテントのダウンロード先ファイルのフルパス

(5)　例外

DecmApiInvalidParamException

引数filePathに対する「通常文字列の設定チェック」に失敗した場合

DecmApiInvalidInitialException

DecmDoc#fetchSubFileで取得したインスタンス以外のインスタンスを使用して，このメソッドをコールした場合

DecmApiIOException

引数filePathで指定したファイルへの書き込み中にエラーが発生した場合（java.io.IOException）

DecmApiDocNotFoundException

文書がすでに削除された場合，または存在しない場合

DecmApiAccessException

文書管理サーバでアクセス権限エラーが発生した場合（DbjAccessControlException）

DecmApiNotSupport

指定した操作をサポートしていない場合

DecmApiFileNotFoundException

文書のコンテントが存在しない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.　フォルダ操作パッケージ提供クラスの詳細

この章では，フォルダ操作パッケージ（jp.co.hitachi_system.sContents.API.Folder）提供のクラス，およびメソッドについて説明します。

＜この章の構成＞

5.1　 DecmFolderTreeクラス

5.2　 DecmFolderクラス

5.3　 DecmFolderPropクラス

5.4　 DecmFolderPermクラス

5.1　 DecmFolderTreeクラス

DecmFolderTreeクラスは，フォルダツリー階層情報の取得を扱うクラスです。

上位フォルダのOIIDを指定することで，下位フォルダの一覧を取得します。上位フォルダを指定しない場合は，最上位フォルダの一覧を取得します。

このクラスの提供メソッドをコールすると，フォルダのツリー階層を取得できます。

プロパティ一覧

DecmFolderTreeクラスで扱うプロパティの一覧を次の表に示します。各プロパティの詳細は，「付録A.1　DocumentBroker Standard GUI Development Kitで使用するプロパティ」を参照してください。

表5-1　 DecmFolderTreeクラスで扱うプロパティ

プロパティ名 | データ型 | 参照可能メソッド
getFolderList()
dmaProp_OIID | String | ○
esysProp_Name | String | ○
dbrProp_OwnerId | String | ○
dbuUserProp_OwnerName | String | ○
esysProp_CreateTime | Integer | ○
esysProp_Creator | String | ○
esysProp_ModifyTime | Integer | ○
esysProp_Modifier | String | ○
dbuUserProp_ModifierName | String | ○
esysProp_Comment | String | ○
ecmProp_FolderType | Integer | ○
ecmProp_FolderLevel | Integer | ○
ecmProp_DocCreateFlg | Integer | ○
ecmProp_AclType | Integer | ○
ecmProp_OpenPubACL | String | ○
ecmProp_OpenPubACL_FULL | String | ○
ecmProp_AclSucceed | Integer | ○
ecmProp_DocTypeOIID | String | ○
ecmProp_DocTypeOIID_FULL | String | ○
ecmProp_ExtInt1 | Integer | ○
under | Integer | ○

（凡例）　○：デフォルトで取得，および更新ができます。

次の項から，DecmFolderTreeクラスのメソッドについて説明します。

＜この節の構成＞

5.1.1　 setParentOiid

5.1.2　 getFolderList

5.1.1　 setParentOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

上位フォルダのOIIDを設定します。

このメソッドを発行しない場合のデフォルトは，「""」（空文字）です。

(2)　形式

void setParentOiid(
 String parentOiid
)

(3)　引数

String parentOiid

上位フォルダのOIIDを指定します。

「""」（空文字）を設定した場合，最上位のフォルダを取得します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数parentOiidにnull，または「""」（空文字）を指定した場合

引数parentOiidがnull，または「""」（空文字）でなく「133桁OIIDの設定チェック」に失敗した場合

5.1.2　 getFolderList

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

下位フォルダ一覧を取得します。

取得した下位フォルダ一覧は「フォルダ種別」，「フォルダ名の昇順」の順でソートします。

フォルダ種別のソート順を次に示します。

公開フォルダ

文書フォルダ

ノードフォルダ

(2)　形式

Vector<DecmFolderProp> getFolderList()

(3)　引数

なし

(4)　戻り値

下位フォルダのプロパティ一覧

(5)　例外

DecmApiFolderNotFoundException

検索するフォルダが存在しない場合

DecmApiAccessException

文書管理サーバでアクセス権限エラーが発生した場合（DbjAccessControlException）

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2　 DecmFolderクラス

DecmFolderクラスは，フォルダ操作を扱うクラスです。このクラスのインスタンスで，1フォルダのオブジェクトを表現します。

このクラスのメソッドで実行できる操作を，次に示します。

フォルダの作成

フォルダの削除

フォルダのプロパティ取得

フォルダのプロパティ更新

フォルダのアクセス権限取得

フォルダのアクセス権限更新

プロパティ一覧

DecmFolderクラスで扱うプロパティの一覧を次の表に示します。各プロパティの詳細は，「付録A.1　DocumentBroker Standard GUI Development Kitで使用するプロパティ」を参照してください。

表5-2　 DecmFolderクラスで扱うプロパティ

プロパティ名
データ型
参照可能メソッド
更新可能メソッド

fetchFolderProp()
createNodeFolder()
createDocFolder()
createPubFolder()
updateNodeFolderProp()
updateDocFolderProp()
updatePubFolderProp()

dmaProp_OIID
String
○
－

esysProp_Name
String
○
○

dbrProp_OwnerId
String
○
－

dbuUserProp_OwnerName
String
○
－

esysProp_CreateTime
Integer
○
－

esysProp_Creator
String
○
－

esysProp_ModifyTime
Integer
○
－

esysProp_Modifier
String
○
－

dbuUserProp_ModifierName
String
○
－

esysProp_Comment
String
○
○

ecmProp_FolderType
Integer
○
－

ecmProp_FolderLevel
Integer
○
－

ecmProp_DocCreateFlg
Integer
○
－

ecmProp_AclType
Integer
○
－

ecmProp_OpenPubACL
String
○
－

ecmProp_OpenPubACL_FULL
String
○
－

ecmProp_AclSucceed
Integer
○
－

ecmProp_DocTypeOIID
String
○
－

ecmProp_DocTypeOIID_FULL
String
○
－

ecmProp_ExtInt1
Integer
○
－

ecmProp_MaxCapacity
Integer
○
－

ecmProp_CapacityUnit
Integer
○
－

ecmProp_UseCapacity
Long
○
－

（凡例）

○：デフォルトで取得，または更新ができます。

－：該当しません。

次の項から，DecmFolderクラスのメソッドについて説明します。

＜この節の構成＞

5.2.1　 getOiid

5.2.2　 setOiid

5.2.3　 setParentOiid

5.2.4　 setFolderProp

5.2.5　 setFolderPerm

5.2.6　 setCapacityMax

5.2.7　 resetCapacityMax

5.2.8　 createNodeFolder

5.2.9　 createDocFolder

5.2.10　 createPubFolder

5.2.11　 deleteFolder

5.2.12　 fetchFolderProp

5.2.13　 updateNodeFolderProp

5.2.14　 updateDocFolderProp

5.2.15　 updatePubFolderProp

5.2.16　 fetchFolderPerm

5.2.17　 updateFolderPerm

5.2.18　 changeCapacityMode

5.2.19　 lockRead

5.2.20　 lockWrite

5.2.1　 getOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

操作対象フォルダのOIIDを取得します。

(2)　形式

String getOiid()

(3)　引数

なし

(4)　戻り値

操作対象フォルダのOIID

(5)　例外

なし

5.2.2　 setOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

操作対象フォルダのOIIDを設定します。

このメソッドは既存のフォルダにアクセスする場合に，最初にコールしてください。なお，OIIDに対するフォルダの存在チェックは行いません。

(2)　形式

void setOiid(
 String oiid
)

(3)　引数

String oiid

操作対象フォルダのOIIDを指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数oiidに対する「133桁OIIDの設定チェック」に失敗した場合

5.2.3　 setParentOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダ作成時の上位フォルダのOIIDを設定します。

下位のフォルダを作成する場合，このメソッドを設定してください。

(2)　形式

void setParentOiid(
 String parentOiid
)

(3)　引数

String parentOiid

フォルダ作成時の上位フォルダのOIIDを指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数parentOiidに対する「133桁OIIDの設定チェック」に失敗した場合

5.2.4　 setFolderProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダのプロパティを設定します。

(2)　形式

void setFolderProp(
 DecmFolderProp folderProp
)

(3)　引数

DecmFolderProp folderProp

フォルダのプロパティを指定します

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数folderPropに対する「通常オブジェクトの設定チェック」に失敗した場合

引数folderPropに対する「プロパティに設定規則チェック」に失敗した場合

5.2.5　 setFolderPerm

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダのアクセス権限を設定します。

このメソッドを使って，フォルダの所有者にメソッド実行ユーザと異なるユーザを設定する場合，セキュリティ管理者で実行してください。一般ユーザで実行した場合，DecmApiAccessException例外が発生する場合があります。

操作対象フォルダが公開範囲を限定した公開フォルダの場合，引数folderPermでDecmACLPermクラスのリストに設定しているユーザのアクセス権限の指定は無視し，無条件で「更新（DecmACLPerm．PERM_UPDATE）」権限を与えます。

(2)　形式

void setFolderPerm(
 DecmFolderPerm folderPerm
)

(3)　引数

DecmFolderPerm folderPerm

フォルダのアクセス権限を指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数folderPermに対する「通常オブジェクトの設定チェック」に失敗した場合

5.2.6　 setCapacityMax

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダの最大容量を設定します。

このメソッドで設定した値は，resetCapacityMaxメソッドをコールするまで，または，このクラスのインスタンスが破棄されるまで保持します。

フォルダ容量制限を設定する場合
createNodeFolderメソッド，またはcreateDocFolderメソッドをコールする前に，このメソッドをコールしてください。
なお，下位のフォルダを作成する場合，このメソッドで設定した値は無視されます。

フォルダ容量制限を変更する場合
updateNodeFolderメソッド，またはupdateDocFolderメソッドをコールする前に，このメソッドをコールしてください。
なお，下位のフォルダを更新する場合，および更新対象フォルダが容量制限をしていない場合，このメソッドで設定した値は無視されます。

(2)　形式

void setCapacityMax(
 int cap,
 int unit
)

(3)　引数

int cap

フォルダ最大容量を指定します。指定できる値の範囲は，1～9,999です。

int unit

フォルダ容量の単位を指定します。

指定できる値を次に示します。

DecmFolder.UNIT_MB

DecmFolder.UNIT_GB

DecmFolder.UNIT_TB

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数capが1より小さい場合，または9,999より大きい場合

引数unitに対して，指定できる値以外を指定した場合

5.2.7　 resetCapacityMax

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダの最大容量をリセットします。

(2)　形式

void resetCapacityMax()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

5.2.8　 createNodeFolder

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ノードフォルダを作成します。

(2)　形式

String createNodeFolder(
 boolean outputLog
)

(3)　引数

boolean outputLog:

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

作成したノードフォルダのOIID

(5)　例外

DecmApiInvalidInitialException

setFolderPropメソッドを発行していない場合

setFolderPropメソッドを発行しているが，esysProp_Nameを設定していない場合

DecmApiFolderNotFoundException

上位フォルダが存在しない場合

DecmApiFolderNotCorrectException

上位フォルダにノードフォルダ以外のフォルダを指定した場合

DecmApiNotSupport

作成できるフォルダ階層の数を超えている場合

アクセス権限情報を指定している場合

指定した操作をサポートしていない場合

DecmApiAccessException

指定したノードフォルダに対してアクセス権限がない場合（DbjAccessControlException）

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2.9　 createDocFolder

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書フォルダを作成します。

アクセス権限情報を指定した場合は，アクセス権限が設定されます。指定しない場合は，上位フォルダの権限が継承されます。

(2)　形式

String createDocFolder(
 int aclType,
 int docCreateType,
 String docMasterOiid,
 boolean outputLog
)

(3)　引数

int aclType

フォルダのアクセス権限タイプを指定します。

指定できる値を次に示します。

DecmFolder.ACL_TYPE_PRIVATE

DecmFolder.ACL_TYPE_PUBLIC

int docCreateType

フォルダ下の文書作成の可否を指定します。

指定できる値を次に示します。

DecmFolder.DOC_CREATE_NG

DecmFolder.DOC_CREATE_OK

String docMasterOiid

使用する文書種別マスタのOIIDを指定します。文書種別マスタを使用しない場合は「""」（空文字）を指定してください。

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

作成した文書フォルダのOIID

(5)　例外

DecmApiInvalidParamException

引数aclTypeに対して，指定できる値以外を指定した場合

引数docCreateTypeに対して，指定できる値以外を指定した場合

引数docMasterOiidにnullを指定した場合

DecmApiInvalidInitialException

setFolderPropメソッドを発行していない場合

setFolderPropメソッドを発行しているが，esysProp_Nameを設定していない場合

DecmApiFolderNotFoundException

上位フォルダが存在しない場合

DecmApiFolderNotCorrectException

上位フォルダにノードフォルダ，文書フォルダ以外のフォルダを指定した場合

上位フォルダのアクセス権限タイプと，aclTypeに指定した値が矛盾している場合

DecmApiACLOutOfRangeException

パブリックACLの個数が制限値を超えた場合（DbjPublicACLOutOfRangeException例外を発生した場合）

DecmApiMasterNotFoundException

指定した文書種別マスタが存在しない場合

DecmApiNotSupport

作成できるフォルダ階層の数を超えている場合

アクセス権限情報の指定が不正な場合

指定した操作をサポートしていない場合

DecmApiACLOutOfRangeException

作成できる個数以上のACLを指定している場合

DecmApiAccessException

指定したフォルダに対してアクセス権限がない場合（DbjAccessControlException）

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2.10　 createPubFolder

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

公開フォルダを作成します。

アクセス権限情報を指定した場合，アクセス権限が設定されます。指定しない場合は，上位フォルダの権限が継承されます。

フォルダ最大容量を指定した場合は，無視されます。

(2)　形式

String createPubFolder(
 int aclType,
 boolean outputLog
)

(3)　引数

int aclType

公開フォルダのアクセス権限タイプを指定します。

指定できる値を次に示します。

DecmFolder.PUBFOL_ACL_TYPE_PUBLIC

DecmFolder.PUBFOL_ACL_TYPE_PRIVATE

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

作成した公開フォルダのOIID

(5)　例外

DecmApiInvalidParamException

引数aclTypeに対して，指定できる値以外を指定した場合

DecmApiInvalidInitialException

setFolderPropメソッドを発行していない場合

setFolderPropメソッドを発行しているが，esysProp_Nameを設定していない場合

DecmApiFolderNotFoundException

上位フォルダが存在しない場合

DecmApiFolderNotCorrectException

上位フォルダに公開フォルダ，ノードフォルダ以外のフォルダを指定した場合

DecmApiACLOutOfRangeException

パブリックACLの個数が制限値を超えた場合（DbjPublicACLOutOfRangeException例外を発生した場合）

DecmApiACLOutOfRangeException

作成できる個数以上のACLを指定している場合

DecmApiNotSupport

作成できるフォルダ階層の数を超えている場合

アクセス権限情報の指定が不正な場合

指定した操作をサポートしていない場合

DecmApiAccessException

指定した公開フォルダに対してアクセス権限がない場合（DbjAccessControlException）

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2.11　 deleteFolder

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダを削除します。

(2)　形式

void deleteFolder(
 boolean outputLog
)

(3)　引数

boolean outputLog:

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiFolderNotFoundException

削除を指定したフォルダが存在しない場合

DecmApiAccessException

削除を指定したフォルダに対してアクセス権限がない場合（DbjAccessControlException）

DecmApiNotSupport

削除を指定したフォルダ配下に文書，またはフォルダが存在する場合

削除を指定したフォルダに対する審査・承認案件が存在する場合

削除を指定したフォルダに対する承認ルートが存在する場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2.12　 fetchFolderProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダの最新バージョンのプロパティを取得します。

(2)　形式

DecmFolderProp fetchFolderProp(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログを出力フラグに指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

フォルダのプロパティ

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiFolderNotFoundException

指定したフォルダが存在しない場合

DecmApiAccessException

指定したフォルダに対してアクセス権限がない場合（DbjAccessControlException）

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2.13　 updateNodeFolderProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ノードフォルダのプロパティを更新します。

(2)　形式

void updateNodeFolderProp(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

setFolderPropメソッドと，setCapacityMaxメソッドのどちらも発行していない場合

DecmApiFolderNotFoundException

指定したノードフォルダが存在しない場合

DecmApiCapacityException

フォルダ最大容量を，すでに登録済みのサイズ以下に変更しようとした場合

DecmApiAccessException

指定したノードフォルダに対してアクセス権限がない場合（DbjAccessControlException）

DecmApiInvalidFolder

フォルダ種別が不正な場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2.14　 updateDocFolderProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書フォルダのプロパティを更新します。

(2)　形式

void updateDocFolderProp(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

setFolderPropメソッドと，setCapacityMaxメソッドのどちらも発行していない場合

DecmApiFolderNotFoundException

指定した文書フォルダが存在しない場合

DecmApiCapacityException

フォルダ最大容量を，すでに登録済みのサイズ以下に変更しようとした場合

DecmApiAccessException

指定した文書フォルダに対してアクセス権限がない場合（DbjAccessControlException）

DecmApiInvalidFolder

フォルダ種別が不正な場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2.15　 updatePubFolderProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

公開フォルダのプロパティを更新します。

フォルダ最大容量を指定した場合は，無視されます。

(2)　形式

void updatePubFolderProp(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

setFolderPropメソッドを発行していない場合

DecmApiFolderNotFoundException

指定した公開フォルダが存在しない場合

DecmApiAccessException

文書管理サーバでアクセス権限エラーが発生した場合（DbjAccessControlException）

DecmApiInvalidFolder

フォルダ種別が不正な場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2.16　 fetchFolderPerm

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダのアクセス権限を取得します。

(2)　形式

DecmFolderPerm fetchFolderPerm(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

フォルダに対するアクセス権限

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiFolderNotFoundException

指定したフォルダが存在しない場合

DecmApiAccessException

指定したフォルダに対してアクセス権限がない場合（DbjAccessControlException）

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2.17　 updateFolderPerm

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダのアクセス権限を更新します。

(2)　形式

void updateFolderPerm(
 boolean outputLog
)

(3)　引数

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

setFolderPermメソッドを発行していない場合

DecmApiFolderNotFoundException

指定したフォルダが存在しない場合

DecmApiAccessException

指定したフォルダに対してアクセス権限がない場合（DbjAccessControlException）

DecmApiInvalidFolder

フォルダ種別が不正な場合

DecmApiACLOutOfRangeException

作成できる個数以上のACLを指定している場合

DecmApiNotSupport

指定した操作をサポートしていない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2.18　 changeCapacityMode

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダ容量制限機能を変更します。

なお，操作対象フォルダが下位フォルダの場合や，引数にメソッド発行前と同じ状態を指定したときは，このメソッドをコールしても何もしません。

(2)　形式

void changeCapacityMode(
 int capMode,
 boolean outputLog
)

(3)　引数

int capMode

フォルダ容量制限機能の使用有無を指定します。

指定できる値を次に示します。

DecmFolder.CAP_NOUSE：フォルダ容量制限機能を使用しません。

DecmFolder.CAP_USE：フォルダ容量制限機能を使用します。

boolean outputLog

監査証跡ログの出力フラグを指定します。

true：監査証跡ログを出力します。

false：監査証跡ログを出力しません。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数capModeに対して，指定できる値以外を指定した場合

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiFolderNotFoundException

指定したフォルダが存在しない場合

DecmApiAccessException

指定したフォルダに対してアクセス権限がない場合（DbjAccessControlException）

DecmApiInvalidFolder

フォルダ種別が不正な場合

DecmApiCapacityException

フォルダ容量制限機能を「使用しない」から「使用する」に変更しようとした場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

5.2.19　 lockRead

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダに対する参照ロックの予約を行います。

このメソッドのコール後にフォルダデータに対するアクセスを行うと，参照ロックが取得されます。

なお，1トランザクション中にこのメソッドとlockWriteメソッドを複数回コールした場合，最後にコールしたメソッドが有効となります。

(2)　形式

void lockRead()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

5.2.20　 lockWrite

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダに対する更新ロックの予約を行います。

このメソッドのコール後にフォルダに対するアクセスを行うと，更新ロックが取得されます。

なお，1トランザクション中にこのメソッドとlockReadメソッドを複数回コールした場合は，最後にコールしたメソッドが有効となります。

(2)　形式

void lockWrite()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

5.3　 DecmFolderPropクラス

DecmFolderPropクラスは，フォルダのプロパティを扱うクラスです。このクラスのインスタンスで，フォルダに設定されているプロパティを表現します。

次の操作を行う場合に，このクラスのインスタンスを使用します。

フォルダの作成

フォルダのプロパティ取得

フォルダのプロパティ更新

なお，DecmFolderPropクラスにはメソッドはありません。

5.4　 DecmFolderPermクラス

DecmFolderPermクラスは，フォルダのアクセス権限を扱うクラスです。このクラスのインスタンスで，フォルダに設定されているアクセス権限を表現します。

次の操作を行う場合に，このクラスのインスタンスを使用します。

フォルダのアクセス権限取得

フォルダのアクセス権限更新

なお，DecmFolderPermクラスにはメソッドはありません。

6.　検索操作パッケージ提供クラスの詳細

この章では，検索操作パッケージ（jp.co.hitachi_system.sContents.API.Select）提供のクラス，およびメソッドについて説明します。

＜この章の構成＞

6.1　 DecmSelectクラス

6.2　 DecmConditionクラス

6.3　 DecmCondGroupクラス

6.1　 DecmSelectクラス

DecmSelectクラスは，文書検索を扱うクラスです。

このクラスで，次の機能が実行できます。

フォルダ下の文書一覧の取得

全文検索結果一覧の取得

プロパティ検索結果一覧の取得

ごみ箱の文書一覧の取得

プロパティ一覧

DecmSelectクラスで扱うプロパティの一覧を次の表に示します。各プロパティの詳細は，「付録A.1　DocumentBroker Standard GUI Development Kitで使用するプロパティ」を参照してください。

表6-1　 DecmSelectクラスで扱うプロパティ

プロパティ名
データ型
検索条件（WHERE）へ
の指定可否
参照可能メソッド

searchDoc()

dmaProp_OIID
String
可
○

esysProp_Name
String
可
○

edmProp_OwnerId
String
可
△

dbuUserProp_OwnerName
String
可
△

esysProp_CreateTime
Integer
可
△

esysProp_Creator
String
可
△

esysProp_ModifyTime
Integer
可
△

esysProp_Modifier
String
可
△

dbuUserProp_ModifierName
String
可
△

dbuUserProp_ReservedUserId
String
可
△

dbuUserProp_ReservedUserName
String
可
△

esysProp_Comment
String
可
△

ecmProp_DocTypeOIID
String
可
△

ecmProp_DocTypeOIID_FULL
String
不可
△

ecmProp_CHOiid
String
可
△

ecmProp_CHOiid_FULL
String
不可
△

ecmProp_DocType
Integer
可
△

ecmProp_FileName
String
可
△

ecmProp_FileSize
Integer
可
△

ecmProp_ParentContainer
String
不可
△

ecmProp_ParentContainer_FULL
String
不可
△

ecmProp_DeleteFlag
Integer
不可
△

ecmProp_DeleteUserId
String
可
△

ecmProp_DeleteTime
Integer
可
△

ecmProp_DocNumber
String
可
△

ecmProp_UserInt1～ecmProp_UserInt5
Integer
可
△※

ecmProp_UserStr1～ecmProp_UserStr5
String
可
△※

ecmProp_DocTypePropInt1～ecmProp_DocTypePropInt10
Integer
可
△※

ecmProp_DocTypePropStr1～ecmProp_DocTypePropStr10
String
可
△※

ecmProp_DocTypePropLongStr1～ecmProp_DocTypePropLongStr5
String
可
△※

esysProp_FileType
Integer
不可
○

esysProp_TopDVOIID_FULL
String
不可
△

（凡例）

可：指定できます。

不可：指定できません。

○：デフォルトで取得，および更新ができます。

△：DecmSelect#setSelectListメソッドをコールすると取得できます。

注※

DecmFactory#initUserPropメソッド，DecmFactory#initUserPropメソッドを使用してプロパティ名を登録しておく必要があります。

次の項から，DecmSelectクラスのメソッドについて説明します。

＜この節の構成＞

6.1.1　 setFolderOiid

6.1.2　 setFetchCount

6.1.3　 setSortKey

6.1.4　 setSortMode

6.1.5　 setTrashMode

6.1.6　 setFolderMode

6.1.7　 isSubFileSearchMode

6.1.8　 setSubFileSearchMode

6.1.9　 addCondition

6.1.10　 setSelectList

6.1.11　 setCondGroup

6.1.12　 setKeyword

6.1.13　 setSearchExpanse

6.1.14　 setSearchDictionary

6.1.15　 searchDoc

6.1.16　 resetCondition

6.1.1　 setFolderOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索対象となるフォルダのOIIDを設定します。

このメソッドを発行しない場合のデフォルトは，「""」（空文字）です。

(2)　形式

void setFolderOiid(
 String folderOiid
)

(3)　引数

String folderOiid

検索対象となるフォルダのOIIDを指定します。

null，または「""」（空文字）を指定した場合，登録されている文書すべてが検索対象となります。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数folderOiidにnull，または「""」（空文字）を指定した場合

引数folderOiidがnull，または「""」（空文字）でなく「133桁OIIDの設定チェック」に失敗した場合

6.1.2　 setFetchCount

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索実行時に取得するレコードの件数を設定します。

このメソッドを発行しない場合のデフォルトの取得件数は，200件です。

(2)　形式

void setFetchCount(
 int fetchCount
)

(3)　引数

int fetchCount

検索実行時に取得するレコードの件数を指定します。

指定できる値は，1～2,147,483,647の範囲です。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数fetchCountが正の整数以外の場合

6.1.3　 setSortKey

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索実行時のソート用カラム名を設定します。

setSelectListメソッドに指定可能なプロパティ名を指定できます。

このメソッドで指定したソートキーとなるプロパティ値は，検索結果のプロパティ一覧に取得されます。

なお，このメソッドを発行しない場合のデフォルトはesysProp_ModifyTime（更新日時）です。

(2)　形式

void setSortKey(
 String sortKey
)

(3)　引数

String sortKey

検索実行時のソート用カラム名を指定します。

null，または「""」（空文字）を指定した場合は，デフォルトのesysProp_ModifyTime（更新日時）が設定されます。

(4)　戻り値

なし

(5)　例外

なし

6.1.4　 setSortMode

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索実行時のソート方式（昇順，または降順）を設定します。

このメソッドを発行しない場合のデフォルトは降順です。

(2)　形式

void setSortMode(
 int sortMode
)

(3)　引数

int sortMode

検索実行時にソート方式（昇順，または降順）を指定します。

指定できる値を次に示します。

DecmSelect.SORT_MODE_UP

DecmSelect.SORT_MODE_DOWN

指定できる値以外を指定した場合は，デフォルトの降順が設定されます。

(4)　戻り値

なし

(5)　例外

なし

6.1.5　 setTrashMode

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索対象とする文書を「通常文書」，「ごみ箱の文書」，「全ての文書」から設定します。

このメソッドを発行しない場合のデフォルトは，DecmSelect.TRASH_MODE_NORMAL（通常文書）です。

なお，参照以上の権限があるごみ箱の文書が検索対照となります。

(2)　形式

void setTrashMode(
 int trashMode
)

(3)　引数

int trashMode

検索対象とする文書を指定します。

指定できる値を次に示します。

DecmSelect.TRASH_MODE_NORMAL（通常文書）

DecmSelect.TRASH_MODE_DELETED（ごみ箱の文書）

DecmSelect.TRASH_MODE_ALL（全ての文書）

指定できる値以外を指定した場合，デフォルトのDecmSelect.TRASH_MODE_NORMAL（通常文書）が設定されます。

(4)　戻り値

なし

(5)　例外

なし

6.1.6　 setFolderMode

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

フォルダ検索を行う場合に下位フォルダを検索対象とするかどうかを設定します。

このメソッドを設定しない場合のデフォルトは，true（下位フォルダを検索対象とする）です。

(2)　形式

void setFolderMode(
 boolean folderMode
)

(3)　引数

boolean folderMode

下位フォルダを検索対象とするかどうかを指定します。

true：指定したフォルダの下位フォルダも検索対象とします。

false：指定したフォルダの下位フォルダは検索対象としません。

(4)　戻り値

なし

(5)　例外

なし

6.1.7　 isSubFileSearchMode

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

関連ファイルの検索対象の指定有無を取得します。

(2)　形式

boolean isSubFileSearchMode()

(3)　引数

なし

(4)　戻り値

関連ファイルの検索対象の指定有無

(5)　例外

なし

6.1.8　 setSubFileSearchMode

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

関連ファイルを検索対象とするかどうかを設定します。

このメソッドを設定しない場合のデフォルトは，false（関連ファイルを検索の対象としない）です。

(2)　形式

void setSubFileSearchMode(
 boolean subFileSearchMode
)

(3)　引数

boolean subFileSearchMode:

関連ファイルを検索対象とするかどうかを指定します。

true：関連ファイルを検索の対象とします。

false：関連ファイルを検索の対象としません。

(4)　戻り値

なし

(5)　例外

なし

6.1.9　 addCondition

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索条件を追加します。

このメソッドを複数回コールして，指定した条件をANDで追加します。

検索条件を追加するごとに，DecmConditionクラスのインスタンスをDecmFactory#createDecmConditionメソッドで生成してください。

(2)　形式

void addCondition(
 DecmCondition condition
)

(3)　引数

DecmCondition condition

通常の検索条件を指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数conditionに対する「通常オブジェクトの設定チェック」に失敗した場合

6.1.10　 setSelectList

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索取得列を設定します。

検索結果として取得する列（プロパティ名）を指定します。

(2)　形式

void setSelectList(
 Vector<String> selectList
)

(3)　引数

Vector<String> selectList

検索カラム名を指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数selectListに対する「通常配列の設定チェック」に失敗した場合

6.1.11　 setCondGroup

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

組み合わせ検索条件を設定します。

このメソッドを複数回コールした場合，最後に指定した条件だけが有効となります。

組み合わせ検索条件の複数指定を設定する場合は，DecmCondGroupクラスのメソッドで実行してください。

また，このメソッドで設定した検索条件と，その他の検索条件はAND検索されます。

なお，このメソッドに指定するDecmCondGroupクラスのインスタンスは，DecmFactory#createDecmCondGroupメソッドで生成してください。

(2)　形式

void setCondGroup(
 DecmCondGroup condGroup
)

(3)　引数

DecmCondGroup condGroup

組み合わせ検索条件を指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数condGroupに対する「通常オブジェクトの設定チェック」に失敗した場合

6.1.12　 setKeyword

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

全文検索のキーワードを設定します。

キーワードとキーワードはAND検索されます。

また，このメソッドで設定した検索条件と，その他の検索条件もAND検索されます。

このメソッドを発行しない場合，全文検索機能は使用しない設定となります。

(2)　形式

void setKeyword(
 Vector<String> keyword
)

(3)　引数

Vector<String> keyword

全文検索のキーワードを設定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数keywordに対する「通常配列の設定チェック」に失敗した場合

引数keywordの項目数が11個以上の場合

6.1.13　 setSearchExpanse

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

異表記展開指定の組み合わせを設定します。

(2)　形式

void setSearchExpanse(
 String searchExpanse
)

(3)　引数

String searchExpanse

異表記展開指定の組み合わせを指定します。

null，または「""」（空文字）を指定した場合，この機能を使用しない設定となります。

なお，指定範囲外の値を設定した場合，不正な動作をするおそれがあります。

指定範囲

カタカナ異表記：K

アルファベット異表記：A

全角半角異表記：E

使用する異表記展開により，上記の値を組み合わせて指定できます。

例えば，カタカナ異表記とアルファベット異表記を指定する場合は，「KA」と指定してください。

(4)　戻り値

なし

(5)　例外

なし

6.1.14　 setSearchDictionary

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

全文検索実行時の同義語辞書名称を設定します。

(2)　形式

void setSearchDictionary(
 String searchDictionary
)

(3)　引数

String searchDictionary

全文検索実行時の同義語辞書名称を指定します。

null，または「""」（空文字）を指定した場合，この機能を使用しない設定となります。

(4)　戻り値

なし

(5)　例外

なし

6.1.15　 searchDoc

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書検索を実行します。

addConditionメソッド，setCondGroupメソッド，setKeywordメソッドに指定した条件でAND検索を実行します。

どのメソッドもコールしない場合，無条件で検索します。

フォルダ指定検索，プロパティ検索，全文検索，およびごみ箱検索を行います。

なお，アクセス権限のないフォルダに対して検索を実行した場合も，エラーとはなりません。

(2)　形式

Vector<DecmDocProp> searchDoc()

(3)　引数

なし

(4)　戻り値

文書プロパティの一覧

なお，関連ファイルを検索対象とした場合（setSubFileSearchModeでtrueを指定した場合），複数ファイル文書単位で検索結果をソートします。

その際，主ファイルは指定のソートキーでソートを実行しますが，関連ファイルはファイル名で昇順にソートされます。

(5)　例外

DecmApiDBException

文書管理サーバでエラーが発生した場合

6.1.16　 resetCondition

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定した検索条件をリセットします。

このメソッドをコールした場合，DecmSelectメソッドのコンストラクタを発行したあとの状態になります。

このため，次に示すメソッドによって設定した値は，すべてクリアされます。

setFolderOiid

setFetchCount

setSortKey

setSortMode

setTrashMode

setFolderMode

setSubFileSearchMode

addCondition

setSelectList

setCondGroup

setKeyword

setSearchExpanse

setSearchDictionary

(2)　形式

void resetCondition()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

6.2　 DecmConditionクラス

DecmConditionクラスは，通常の検索条件の表現用クラスです。通常の検索条件の生成機能を提供します。

次の項から，DecmConditionクラスのメソッドについて説明します。

＜この節の構成＞

6.2.1　 createStrCond

6.2.2　 createIntCond

6.2.1　 createStrCond

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文字列型の検索条件を生成します。

このメソッドをコールするとcreateIntCondメソッドは無効となり，createIntCondメソッドでセットしたConditionはクリアされます。

(2)　形式

void createStrCond(
 String field,
 int operator,
 String value
)

(3)　引数

String field

プロパティ名を指定します。

int operator

検索のオペレータを指定します。

指定できる値を次に示します。

DecmCondition.OP_EQ

DecmCondition.OP_NEQ

DecmCondition.OP_PART

DecmCondition.OP_STWITH

DecmCondition.OP_ENDWITH

String value

文字列型の検索条件の値を指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数fieldに対する「通常文字列の設定チェック」に失敗した場合

引数operatorに対して，指定できる値以外を指定した場合

引数valueにnullを指定した場合

6.2.2　 createIntCond

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

数値型の検索条件を生成します。

検索条件を開始する値（beginValue）と検索条件を終了する値（endValue）に同じ値を設定した場合は，指定した値と一致するfieldを検索条件とします。

このメソッドをコールするとcreateStrCondメソッドは無効となり，createStrCondメソッドでセットしたConditionはクリアされます。

(2)　形式

void createIntCond(
 String field,
 int beginValue,
 int endValue
)

(3)　引数

String field

プロパティ名を指定します。

int beginValue

数値型の検索条件を開始する値を指定します。

int endValue

数値型の検索条件を終了する値を指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数fieldに対する「通常文字列の設定チェック」に失敗した場合

6.3　 DecmCondGroupクラス

DecmCondGroupクラスは，組み合わせ検索条件の表現用クラスです。

次の項から，DecmCondGroupクラスのメソッドについて説明します。

＜この節の構成＞

6.3.1　 addCond

6.3.2　 addCondGroup

6.3.1　 addCond

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索条件を追加します。

なお，検索条件を追加するごとに，DecmConditionクラスのインスタンスをDecmFactory#createDecmConditionメソッドで生成してください。

(2)　形式

void addCond(
 DecmCondition cond,
 int operator
)

(3)　引数

DecmCondition cond

検索条件を指定します。

int operator

検索条件追加のオペレータを指定します。

初めに指定したオペレータは無視されます。

なお，指定範囲外の値を設定した場合は，AND検索と判断されます。

指定できる値を次に示します。

DecmCondGroup.OP_AND

DecmCondGroup.OP_OR

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数condに対する「通常オブジェクトの設定チェック」に失敗した場合

引数operatorに対して，指定できる値以外を指定した場合

6.3.2　 addCondGroup

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

組み合わせ検索条件を追加します。

(2)　形式

void addCondGroup(
 DecmCondGroup condGroup,
 int operator
)

(3)　引数

DecmCondGroup condGroup

組み合わせ検索条件を指定します。

int operator

検索条件追加のオペレータを指定します。

初めに指定したオペレータは無視されます。

なお，指定範囲外の値を設定した場合は，AND検索と判断されます。

指定できる値を次に示します。

DecmCondGroup.OP_AND

DecmCondGroup.OP_OR

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数condに対する「通常オブジェクトの設定チェック」に失敗した場合

引数operatorに対して，指定できる値以外を指定した場合

7.　文書種別マスタ操作パッケージ提供クラスの詳細

この章では，文書種別マスタ操作パッケージ（jp.co.hitachi_system.sContents.API.DocMaster）パッケージ提供のクラス，およびメソッドについて説明します。

＜この章の構成＞

7.1　 DecmDocMasterListクラス

7.2　 DecmDocMasterクラス

7.3　 DecmDocMasterPropクラス

7.4　 DecmDocPropMasterクラス

7.5　 DecmDocPropMasterPropクラス

7.1　 DecmDocMasterListクラス

DecmDocMasterListクラスは，文書種別マスタ一覧を扱うクラスです。

このクラスのインスタンスで，文書種別マスタの一覧情報を取得します。

プロパティ一覧

DecmDocMasterListクラスで扱うプロパティの一覧を次の表に示します。各プロパティの詳細は，「付録A.1　DocumentBroker Standard GUI Development Kitで使用するプロパティ」を参照してください。

表7-1　 DecmDocMasterListクラスで扱うプロパティ

プロパティ名 | データ型 | 参照可能メソッド
getDocMasterList()
dmaProp_OIID | String | ○
esysProp_Name | String | ○
ecmProp_DocNumProp | String | ○
ecmProp_DocNumDelimiter | String | ○
ecmProp_DocNumSuffix | String | ○

（凡例）　○：デフォルトで取得，または更新ができます。

次の項から，DecmDocMasterListクラスのメソッドについて説明します。

＜この節の構成＞

7.1.1　 getDocMasterList

7.1.1　 getDocMasterList

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

すべての文書種別マスタ一覧を取得します。

取得した文書種別マスタ一覧は，更新日時の降順でソートします。

(2)　形式

Vector<DecmDocMasterProp> getDocMasterList()

(3)　引数

なし

(4)　戻り値

すべての文書種別マスタ一覧のプロパティ一覧

(5)　例外

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

7.2　 DecmDocMasterクラス

DecmDocMasterクラスは，文書種別マスタ操作を扱うクラスです。このクラスのインスタンスで，文書種別マスタに対する操作を行います。

このクラスのメソッドで実行できる操作を，次に示します。

基本情報，および採番情報の取得

文書種別マスタに定義されている文書新規作成時のプロパティ項目の取得

文書種別マスタに定義されている検索に使用するプロパティ項目の取得

文書種別マスタに定義されている一覧表示に使用するプロパティ項目の取得

プロパティ一覧

DecmDocMasterクラスで扱うプロパティの一覧を次の表に示します。各プロパティの詳細は，「付録A.1　DocumentBroker Standard GUI Development Kitで使用するプロパティ」を参照してください。

表7-2　 DecmDocMasterクラスで扱うプロパティ

プロパティ名 | データ型 | 参照可能メソッド
fetchDocMasterProp()
dmaProp_OIID | String | ○
esysProp_Name | String | ○
ecmProp_DocNumProp | String | ○
ecmProp_DocNumDelimiter | String | ○
ecmProp_DocNumSuffix | String | ○

（凡例）　○：デフォルトで取得，または更新ができます。

次の項から，DecmDocMasterクラスのメソッドについて説明します。

＜この節の構成＞

7.2.1　 getOiid

7.2.2　 setOiid

7.2.3　 fetchDocMasterProp

7.2.4　 getNewDocMaster

7.2.5　 getSearchDocMaster

7.2.6　 getListDocMaster

7.2.1　 getOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

操作対象の文書種別マスタのOIIDを取得します。

(2)　形式

String getOiid()

(3)　引数

なし

(4)　戻り値

操作対象の文書種別マスタのOIID

(5)　例外

なし

7.2.2　 setOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

操作対象の文書種別マスタのOIIDを設定します。

(2)　形式

void setOiid(
 String oiid
)

(3)　引数

String oiid

操作対象の文書種別マスタのOIIDを指定します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数oiidに対する「133桁OIIDの設定チェック」に失敗した場合

7.2.3　 fetchDocMasterProp

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書種別マスタのプロパティを取得します。

(2)　形式

DecmDocMasterProp fetchDocMasterProp()

(3)　引数

なし

(4)　戻り値

文書種別マスタのプロパティ

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiMasterNotFoundException

指定した文書種別マスタが存在しない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

7.2.4　 getNewDocMaster

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書作成時に指定するプロパティ項目一覧を取得します。

(2)　形式

Vector<String> getNewDocMaster()

(3)　引数

なし

(4)　戻り値

文書作成時に指定するプロパティ項目一覧

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiMasterNotFoundException

指定した文書種別マスタが存在しない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

7.2.5　 getSearchDocMaster

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索に使用するプロパティ項目一覧を取得します。

(2)　形式

Vector<String> getSearchDocMaster()

(3)　引数

なし

(4)　戻り値

検索に使用するプロパティ項目一覧

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiMasterNotFoundException

指定した文書種別マスタが存在しない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

7.2.6　 getListDocMaster

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

一覧表示に使用するプロパティ項目一覧を取得します。

(2)　形式

Vector<String> getListDocMaster()

(3)　引数

なし

(4)　戻り値

一覧表示に使用するプロパティ項目一覧

(5)　例外

DecmApiInvalidInitialException

setOiidメソッドを発行していない場合

DecmApiMasterNotFoundException

指定した文書種別マスタが存在しない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

7.3　 DecmDocMasterPropクラス

DecmDocMasterPropクラスは，文書種別マスタを扱うクラスです。このクラスのインスタンスで，文書種別マスタに定義されている情報を表現します。文書種別マスタの基本情報，および採番情報の参照ができます。

なお，DecmDocMasterPropクラスにメソッドはありません。

7.4　 DecmDocPropMasterクラス

DecmDocPropMasterクラスは，属性値マスタの取得を扱うクラスです。

このクラスのインスタンスで，属性値マスタの階層構造を取得します。

プロパティ一覧

DecmDocPropMasterクラスで扱うプロパティの一覧を次の表に示します。各プロパティの詳細は，「付録A.1　DocumentBroker Standard GUI Development Kitで使用するプロパティ」を参照してください。

表7-3　 DecmDocPropMasterクラスで扱うプロパティ

プロパティ名 | データ型 | 参照可能メソッド
getDocPropMasterList()
dmaProp_OIID | String | ○
esysProp_Name | String | ○
ecmProp_Level | Integer | ○
ecmProp_DocTypePropName | String | ○
ecmProp_DocTypePropCode | String | ○
ecmProp_DocTypeParentCode | String | ○
ecmProp_SortNumber | Integer | ○

（凡例）　○：デフォルトで取得，または更新ができます。

次の項から，DecmDocPropMasterクラスのメソッドについて説明します。

＜この節の構成＞

7.4.1　 setParentOiid

7.4.2　 getDocPropMasterList

7.4.1　 setParentOiid

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

上位属性値マスタのOIIDを設定します。

このメソッドを発行しない場合のデフォルトは，「""」（空文字）です。

(2)　形式

void setParentOiid(
 String parentOiid
)

(3)　引数

String parentOiid

上位属性値マスタのOIIDを指定します。

「""」（空文字）を指定した場合，最上位の属性値マスタを示します。

(4)　戻り値

なし

(5)　例外

DecmApiInvalidParamException

引数parentOiidにnullを指定した場合

7.4.2　 getDocPropMasterList

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

下位属性値マスタ一覧を取得します。

取得した下位属性値マスタ一覧は，ソート用番号の昇順でソートします。

(2)　形式

Vector<DecmDocPropMasterProp> getDocPropMasterList()

(3)　引数

なし

(4)　戻り値

下位属性値マスタのプロパティ一覧

(5)　例外

DecmApiPropMasterNotFoundException

上位属性値マスタが存在しない場合

DecmApiDBException

文書管理サーバでエラーが発生した場合（DbjExceptionなど）

7.5　 DecmDocPropMasterPropクラス

DecmDocPropMasterPropクラスは，属性値マスタのプロパティを扱うクラスです。

このクラスのインスタンスで，属性値マスタに定義されている情報を表現します。

なお，DecmDocPropMasterPropクラスにメソッドはありません。

8.　 DocumentBrokerで提供されるクラスライブラリ

この章では，DocumentBroker Standard GUI Development Kitで使用するDocumentBrokerのクラス，およびメソッドについて説明します。

＜この章の構成＞

8.1　DocumentBrokerで提供されるクラスライブラリ

8.2　 DbjFactory0200クラス

8.3　 DbjFactoryインターフェース

8.4　 DbjSessionインターフェース

8.5　 DbjDocSpaceインターフェース

8.1　DocumentBrokerで提供されるクラスライブラリ

DocumentBroker Standard GUI Development Kitは，DocumentBroker Development Kit，またはDocumentBroker Runtimeで提供されるJava クラスライブラリの使用が前提となります。

DocumentBroker Development Kit，またはDocumentBroker Runtimeで提供しているJava クラスライブラリでのクラス，インターフェースおよびメソッドのうち，DocumentBroker Standard GUI Development Kitで使用するクラス，インターフェースおよびメソッドを一覧形式で示します。

＜この節の構成＞

8.1.1　使用するクラス，およびインターフェースの一覧

8.1.2　使用するメソッド一覧

8.1.1　使用するクラス，およびインターフェースの一覧

DocumentBroker Development Kit，またはDocumentBroker Runtimeで提供しているJava クラスライブラリでのクラス，およびインターフェースのうち，DocumentBroker Standard GUI Development Kitで使用するクラス，およびインターフェースを次の表に示します。

表8-1　DocumentBroker Development Kit，Runtime　Java クラスライブラリのクラス，およびインターフェース一覧

クラス／インターフェース | 説明
DbjFactory0200クラス | DocumentBrokerにアクセスするためのファクトリインターフェースを取得します。
DbjFactoryインターフェース | 指定した文書空間に対するJava クラスライブラリのセッションオブジェクトを作成します。
DbjSessionインターフェース | 文書空間への一つの接続に対応し，セッション内でのトランザクション制御などを行うためのインターフェースです。
DbjDocSpaceインターフェース※ | DbjSessionインターフェースのlogin()メソッドをコールして，このインターフェースを取得します。

注※　DocumentBroker Standard GUI Development Kitにおけるファクトリクラス（DecmFactory）には，このインターフェースを渡す必要があります。

8.1.2　使用するメソッド一覧

DocumentBroker Development Kit，またはDocumentBroker Runtimeで提供しているJava クラスライブラリでのクラス，インターフェースのメソッドのうち，DocumentBroker Standard GUI Development Kitで使用するものを示します。

＜この項の構成＞

(1)　 DbjFactory0200クラス

(2)　 DbjFactoryインターフェース

(3)　 DbjSessionインターフェース

(1)　 DbjFactory0200クラス

DbjFactory0200クラスのメソッド一覧を次の表に示します。

表8-2　 DbjFactory0200クラスのメソッド一覧

メソッド | 機能
getFactory | ファクトリインターフェースを取得します。

(2)　 DbjFactoryインターフェース

DbjFactoryインターフェースのメソッド一覧を次の表に示します。

表8-3　 DbjFactoryインターフェースのメソッド一覧

メソッド | 機能
createSession | 指定した文書空間に対するJava クラスライブラリのセッションオブジェクトを作成し，DbjSessionインターフェースを取得します。

(3)　 DbjSessionインターフェース

DbjSessionインターフェースのメソッド一覧を次の表に示します。

表8-4　 DbjSessionインターフェースのメソッド一覧

メソッド | 機能
login | 文書空間へのログイン，および文書空間インターフェース（DbjDocSpaceインターフェース）を取得します。
logout | 文書空間からログアウトしてセッションを切断します。
begin | トランザクションを開始します。
rollback | トランザクションを取り消します。
commit | トランザクションを確定します。

8.2　 DbjFactory0200クラス

DbjFactory0200クラスは，Java クラスライブラリのファクトリインターフェース，およびメタマネージャーインターフェースを取得するクラスです。なお，このクラスはインスタンスを生成できません。コンストラクタはprivate属性です。

次の項から，DbjFactory0200クラスのメソッドについて説明します。

＜この節の構成＞

8.2.1　 getFactory

8.2.1　 getFactory

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ファクトリインターフェースを取得します。

(2)　形式

static DbjFactory getFactory()

(3)　引数

なし

(4)　戻り値

ファクトリインターフェース（DbjFactoryインターフェース）

(5)　例外

なし

8.3　 DbjFactoryインターフェース

DbjFactoryインターフェースは，Java クラスライブラリのオブジェクトを生成して，そのインターフェースを取得する機能を持つファクトリインターフェースです。

次の項から，DbjFactoryインターフェースのメソッドについて説明します。

＜この節の構成＞

8.3.1　 createSession

8.3.1　 createSession

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定した文書空間に対するJava クラスライブラリのセッションオブジェクトを作成し，そのインターフェース（DbjSessionインターフェース）を取得します。

ただし，DbjSessionインターフェースを取得した時点では文書空間にアクセスしません。

形式1では，セッションを開始する文書空間の文書空間識別子を指定します。

形式２では，動作環境定義ファイルに指定したデフォルト文書空間（コンフィギュレーションキーはDefaultDocSpaceId）に接続するためのセッションオブジェクトを作成し，そのインターフェース（DbjSessionインターフェース）を取得します。

動作環境定義ファイルの詳細についてはマニュアル「uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　解説」を参照してください。

(2)　形式

(a)　形式1

DbjSession createSession(
 String     docspaceId
)

(b)　形式2

DbjSession createSession()

(3)　引数

docspaceId

文書空間識別子をGUID文字列で指定します。

GUID文字列は，16進数「X」によって，「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX（8けた-4けた-4けた-4けた-12けた）」の形式で表されます。

「X」は，0～9，a～f（小文字），およびA～F（大文字）のどれかです。null，または「""」（空文字）を指定した場合は，例外がスローされます。

(4)　戻り値

Java クラスライブラリのセッションインターフェース（DbjSessionインターフェース）

(5)　例外

NullPointerException

引数docspaceIdにnull，または「""」（空文字）を指定した場合

8.4　 DbjSessionインターフェース

DbjSessionインターフェースは，Java クラスライブラリのセッションを扱います。Java クラスライブラリの一つのセッションオブジェクトは文書空間への一つの接続に対応し，その接続している期間をセッションといいます。DbjSessionインターフェースは，同時に一つのセッションのセッション管理をサポートします。

また，DocumentBroker Standard GUI Development Kitを使用して，DocumentBroker Standard GUI環境へのオブジェクト操作に対するトランザクション制御を行う場合は，このインターフェースのメソッドをコールし，ユーザアプリケーション側で実装する必要があります。

次の項から，DbjSessionインターフェースのメソッドについて説明します。

＜この節の構成＞

8.4.1　 login

8.4.2　 logout

8.4.3　 begin

8.4.4　 rollback

8.4.5　 commit

8.4.1　 login

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間にログインしてセッションを確立し，同時にユーザ識別子およびパスワードの認証を実行して，文書空間インターフェース（DbjDocSpaceインターフェース）を取得します。

このメソッドは，一つの文書空間にアクセスするほかのメソッドの実行前に実行する必要があります。

確立しているセッションの有効期限は，DbjSession#logoutメソッドを実行するまで，または文書空間への接続をタイムアウト（DocumentBrokerサーバで設定される）するまでです。

なお，ユーザ認証の失敗，および二重のログインがあった場合は，例外がスローされます。

(2)　形式

DbjDocSpace login(
 String       userName,
 String       passWord
)

(3)　引数

userName

ログインするユーザのユーザ識別子を指定します。

passWord

ログインするユーザのパスワードを指定します。

(4)　戻り値

文書空間オブジェクトアクセスインターフェース（DbjDocSpaceインターフェース）

(5)　例外

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalDocSpaceIdException

接続先の文書空間識別子が不正の場合

DbjNotAuthenticatedException

認証エラーの場合

DbjSessionOverflowException

セッション数が同時に接続できる数を超えた場合

IllegalStateException

すでにログインしていた場合

8.4.2　 logout

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間からログアウトしてセッションを切断します。

セッションの切断によって，ログインセッション内で継続して使用される内部データ（検索結果キャッシュなど）は消去されます。

また，切断するセッションに未確定のトランザクションがある場合は，自動的にトランザクションが取り消され，最後にトランザクションが確定した状態まで戻ります。

なお，このメソッドのエラーは，エラーログファイルに出力されます。

(2)　形式

void logout()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

8.4.3　 begin

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

トランザクションを開始します。

このメソッドを二重に実行した場合，例外がスローされます。

(2)　形式

void begin()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていない場合

IllegalStateException

DbjSession#beginメソッドが二重に実行された場合

8.4.4　 rollback

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

トランザクションを取り消して，最後にDbjSession#commitメソッドが実行された状態まで戻します。

トランザクションが開始されていない場合も，正常終了します。

(2)　形式

void rollback()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていない場合

8.4.5　 commit

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

トランザクションを確定します。

トランザクションが開始されていない場合，例外がスローされます。

(2)　形式

void commit()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていない場合

IllegalStateException

DbjSession#beginメソッドの実行前にDbjSession#commitメソッドが実行された場合

8.5　 DbjDocSpaceインターフェース

DbjDocSpaceインターフェースは，文書空間へのアクセスを扱うインターフェースです。

DocumentBroker Standard GUI Development Kitにおけるファクトリクラス（DecmFactory）には，このインターフェースを渡す必要があります。

DbjDocSpaceインターフェースには，メソッドはありません。

9.　コーディング例

ここでは，クラスライブラリを使用したコーディング例について説明します。

＜この章の構成＞

9.1　作成するコーディング例

9.2　共通操作パッケージのコーディング例

9.3　文書操作パッケージのコーディング例

9.4　フォルダ操作パッケージのコーディング例

9.5　検索操作パッケージのコーディング例

9.6　文書種別マスタ操作パッケージのコーディング例

9.1　作成するコーディング例

ここでは，DocumentBroker Standard GUI Development Kitで提供しているパッケージのコーディング例について説明します。

このコーディング例では，クラスライブラリのメソッドのコールシーケンスを例示します。また，クラスライブラリの各メソッドの使用方法を例示します。

このコーディング例を参考にして，実際のアプリケーションプログラムを作成してください。

＜この節の構成＞

9.1.1　前提条件

9.1.1　前提条件

このコーディング例の前提条件を説明します。

このコーディング例では，アプリケーションプログラムのうち，クラスライブラリを使用したインターフェースの個所だけを記述します。GUIや定型業務に依存した個所については説明しません。

また，このコーディング例は，クラスライブラリのすべてのメソッドを使用しているものではありません。

9.2　共通操作パッケージのコーディング例

共通操作パッケージ（jp.co.hitachi_system.sContents.API.Common）のコーディング例を説明します。

＜この節の構成＞

9.2.1　 DecmFactoryインスタンスの作成

9.2.1　 DecmFactoryインスタンスの作成

DecmFactoryクラスのインスタンスを作成する場合のコーディング例を，次に示します。

1  ////////////////////////////////////////////////////////////
2  // dbjDocSpace: DbjDocSpaceインスタンス
3  // loginId    : DocumentBroker Serverログイン用ユーザID
4  // loginPw    : DocumentBroker Serverログイン用パスワード
5  // loginNm    : DocumentBroker Serverログイン用ユーザ名
6  ////////////////////////////////////////////////////////////
7
8  // DocumentBroker Serverログイン
9  dbjDocSpace = dbjSession.login(loginId, loginPw);
10
11 // API操作用パラメタを指定
12 String userId = loginId;
13 String userNm = loginNm;
14
15 // DecmFactoryインスタンスを取得する
16 DecmFactory decmFactory = new DecmFactory(dbjDocSpace, userId, userNm, DecmFactory.DB_HIRDB);

9.3　文書操作パッケージのコーディング例

文書操作パッケージ（jp.co.hitachi_system.sContents.API.Document）のコーディング例を説明します。

＜この節の構成＞

9.3.1　文書の作成・取得・削除

9.3.2　文書のプロパティの更新・取得

9.3.3　文書のアクセス権限の更新・取得

9.3.4　文書の履歴の取得・削除・更新

9.3.5　文書をごみ箱へ移動したあと元に戻す

9.3.6　文書の移動

9.3.1　文書の作成・取得・削除

文書を作成，取得，削除する場合のコーディング例を，次に示します。

＜この項の構成＞

(1)　主ファイルだけで構成する文書を作成後ダウンロードする

(2)　主ファイルと関連ファイルで構成する文書を作成後ダウンロードする

(3)　文書を削除する

(1)　主ファイルだけで構成する文書を作成後ダウンロードする

1  ////////////////////////////////////////////////////////////
2  // decmFactory : DecmFactoryインスタンス
3  // fldOiid     : 登録先フォルダOIID
4  // filePath    : 登録するローカルファイルパス
5  // localPath   : 取得先ローカルパス
6  ////////////////////////////////////////////////////////////
7
8  // 文書操作用のインスタンスを取得
9  DecmDoc doc = decmFactory.createDecmDoc();
10
11 // プロパティ操作用インスタンスを取得
12 DecmDocProp docProp = decmFactory.createDecmDocProp();
13
14 // プロパティを設定
15 docProp.setStrProp( "esysProp_Name", "会議資料" ); doc.setDocProp( docProp );
16
17 // 登録先フォルダ設定
18 doc.setFolderOiid( fldOiid );
19
20 // ファイル設定
21 doc.setFilePath( filePath );
22
23 // 文書作成
24 String oiid = doc.createDoc( false, true );
26 // ダウンロード
27 doc.downloadContent( null,
28                      localPath,
29                      true,
30                      true );

(2)　主ファイルと関連ファイルで構成する文書を作成後ダウンロードする

1  //////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // fldOiid        : 登録先フォルダOIID
4  // filePath       : 主ファイルに登録するローカルファイルパス
5  // subFilePath1   : 関連ファイルに登録するローカルファイルパス
6  // subFilePath2   : 関連ファイルに登録するローカルファイルパス
7  // downloadMasterPath   : 主ファイルの取得先ローカルパス
8  // downloadSubPath      : 関連ファイルの取得先ローカルパス
9  //////////////////////////////////////////////////////////////
10
11 // 文書操作用のインスタンスを取得
12 DecmDoc doc = decmFactory.createDecmDoc();
13 // プロパティ操作用インスタンスを取得
14 DecmDocProp docProp = decmFactory.createDecmDocProp();
15
16 // プロパティを設定
17 docProp.setStrProp( "esysProp_Name", "会議資料" );
18 doc.setDocProp( docProp );
19
20 // 登録先フォルダ設定
21 doc.setFolderOiid( fldOiid );
22
23 // ファイル設定
24 doc.setFilePath( masterFilePath );
25
26 // 関連ファイル操作用インスタンスを取得
27 DecmSubFile subFile1 = decmFactory.createDecmSubFile();
28 DecmSubFile subFile2 = decmFactory.createDecmSubFile();
29
30 // 関連ファイルリストを設定
31 subFile1.setFilePath( subFilePath1 );
32 subFile2.setFilePath( subFilePath2 );
33 Vector<DecmSubFile> subFileList = new Vector<DecmSubFile>();
34 subFileList.add( subFile1 );
36 subFileList.add( subFile2 );
37 doc.setSubFileList( subFileList );
38
39 // 文書作成
40 String oiid = doc.createDoc( false,
41                              true );
42
43 // 主ファイルをダウンロード
44 doc.downloadContent( null,
45                      downloadMasterPath,
46                      true,
47                      true );
48
49 // 関連ファイルをダウンロード
50 Vector<DecmSubFile> subFileList = doc.fetchSubFile( null );
51 subFileList.get( 0 ).downloadContent( downloadSubPath,
52                                       true,
53                                       true );

(3)　文書を削除する

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // docOiid        : 操作対象文書のバージョニングOIID
4  ////////////////////////////////////////////////////////////
5
6  // 文書操作用のインスタンスを取得
7  DecmDoc doc = decmFactory.createDecmDoc();
8
9  // 文書に接続
10 doc.setOiid( docOiid );
11
12 // 文書削除
13 doc.deleteDoc( true );

9.3.2　文書のプロパティの更新・取得

文書のプロパティを更新，取得する場合のコーディング例を次に示します。

＜この項の構成＞

(1)　主ファイルのプロパティを更新後に取得する

(2)　関連ファイルのコンテントを更新後にプロパティを取得する

(1)　主ファイルのプロパティを更新後に取得する

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // docOiid        : 操作対象文書のバージョニングOIID
4  // filePath       : 更新後のファイルに登録するローカルパス
5  ////////////////////////////////////////////////////////////
6
7  // 文書操作用のインスタンスを取得
8  DecmDoc doc = decmFactory.createDecmDoc();
9
10 // 文書に接続
11 doc.setOiid( docOiid );
12
13 ////////////////////////////////////////////////////////////
14 // 更新
15 ////////////////////////////////////////////////////////////
16
17 // ファイルを設定
18 doc.setFilePath( filePath );
19
20 // プロパティ操作用インスタンスを取得
21 DecmDocProp docProp = decmFactory.createDecmDocProp();
22
23 // プロパティを設定して更新
24 docProp.setStrProp( "esysProp_Name", "会議資料_改訂" );
25 docProp.setStrProp( "esysProp_Comment", "誤記訂正" );
26
27 doc.setDocProp( docProp );
28
29 doc.updateDocProp( false,
30                    true );
31
32 ////////////////////////////////////////////////////////////
33 // 取得
34 ////////////////////////////////////////////////////////////
35 DecmDocProp docProp = doc.fetchDocProp( true );

(2)　関連ファイルのコンテントを更新後にプロパティを取得する

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // docOiid        : 操作対象文書のバージョニングOIID
4  // subFilePath1   : 更新後のファイルに登録するローカルパス
5  // subFilePath2   : 更新後のファイルに登録するローカルパス
6  ////////////////////////////////////////////////////////////
7
8  // 文書操作用のインスタンスを取得
9  DecmDoc doc = decmFactory.createDecmDoc();
10
11 // 文書に接続
12 doc.setOiid( docOiid );
13
14 ////////////////////////////////////////////////////////////
15 // 更新
16 ////////////////////////////////////////////////////////////
17
18 // 関連ファイルリストを取得
19 Vector<DecmSubFile> subFileList = doc.fetchSubFile( null );
20
21 // ファイルを設定
22 subFileList.get( 0 ).setFilePath( subFilePath1 );
23 subFileList.get( 1 ).setFilePath( subFilePath2 );
24
25 // 関連ファイルリストを設定して更新
26 doc.setSubFileList( subFileList );
27
28 doc.updateDocProp( false,
29                    true );
30
31 ////////////////////////////////////////////////////////////
32 // 取得
33 ////////////////////////////////////////////////////////////
34
35 // 関連ファイルリストを取得
36 Vector<DecmSubFile> subFileList = doc.fetchSubFile( null );
37
38 // プロパティ取得
39 DecmDocProp docProp1 = subFileList.get( 0 ).fetchFileProp( true );
40 DecmDocProp docProp2 = subFileList.get( 1 ).fetchFileProp( true );

9.3.3　文書のアクセス権限の更新・取得

文書のアクセス権限を更新，取得する場合のコーディング例を次に示します。

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // docOiid        : 操作対象文書のバージョニングOIID
4  ////////////////////////////////////////////////////////////
5
6  // 文書操作用のインスタンスを取得
7  DecmDoc doc = decmFactory.createDecmDoc();
8
9  // 文書に接続
10 doc.setOiid( docOiid );
11
12 ////////////////////////////////////////////////////////////
13 // 更新
14 ////////////////////////////////////////////////////////////
15
16 // アクセス権限操作用インスタンスを取得
17 DecmDocPerm docPerm = decmFactory.createDecmDocPerm();
18
19 // アクセス権限を設定し更新
20 docPerm.setEveryonePerm( DecmACLPerm.PERM_READ );
21 doc.setDocPerm( docPerm );
22
23 doc.updateDocPerm( true );
24
25 ////////////////////////////////////////////////////////////
26 // 取得
27 ////////////////////////////////////////////////////////////
28
29 DecmDocPerm docPerm = doc.fetchDocPerm( true );

9.3.4　文書の履歴の取得・削除・更新

文書の履歴を取得，削除，更新する場合のコーディング例を次に示します。

＜この項の構成＞

(1)　文書の履歴を取得後に削除する

(2)　関連ファイルの過去のバージョンのプロパティを取得する

(3)　文書の履歴を更新する（チェックアウトしてからチェックインする）

(1)　文書の履歴を取得後に削除する

1  //////////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // docOiid        : 操作対象文書のバージョニングOIID
4  // dvOiid         : 操作対象文書のバージョンオブジェクトのOIID
5  //////////////////////////////////////////////////////////////////
6
7  // 文書操作用のインスタンスを取得
8  DecmDoc doc = decmFactory.createDecmDoc();
9
10 // 文書に接続
11 doc.setOiid( docOiid );
12
13 // 履歴取得
14 Vector<DecmDocProp> verPropList = doc.fetchDocHistory( true );
15
16 // 履歴削除
17 doc.deleteDocHistory( dvOiid,
18                       true );

(2)　関連ファイルの過去のバージョンのプロパティを取得する

1  ///////////////////////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // docOiid        : 操作対象文書のバージョニングOIID
4  // dvOiid         : 取得対象となる主ファイルのバージョンオブジェクトのOIID
5  ///////////////////////////////////////////////////////////////////////////////
6
7  // 文書操作用のインスタンスを取得
8  DecmDoc doc = decmFactory.createDecmDoc();
9
10 // 文書に接続
11 doc.setOiid( docOiid );
12
13 // 関連ファイルリストを取得
14 Vector<DecmSubFile> subFileList = doc.fetchSubFile( dvOiid );
15
16 // プロパティを取得
17 DecmDocProp docProp = subFileList.get( 0 ).fetchFileProp( true );

(3)　文書の履歴を更新する（チェックアウトしてからチェックインする）

1  ///////////////////////////////////////////////////////////////////////////////
2  // decmFactory      : DecmFactoryインスタンス
3  // docOiid          : 操作対象文書のバージョニングOIID
4  // dvOiid           : 取得対象となる主ファイルのバージョンオブジェクトのOIID
5  // updateMasterFile : 更新後の主ファイルに登録するローカルパス
6  // updateSubFile1   : 更新後の関連ファイルに登録するローカルパス
7  // updateSubFile2   : 更新後の関連ファイルに登録するローカルパス
8  ///////////////////////////////////////////////////////////////////////////////
9
10 // 文書操作用のインスタンスを取得
11 DecmDoc doc = decmFactory.createDecmDoc();
12
13 // 文書に接続
14 doc.setOiid( docOiid );
15
16 // チェックアウト
17 doc.checkoutDoc( true );
18
19 // 更新するファイルを設定(主ファイル)
20 doc.setFilePath( updateMasterFile );
21
22 // 関連ファイルを取得
23 Vector<DecmSubFile> subFileList = doc.fetchSubFile( dvOiid );
24
25 // 更新するファイルを設定(関連ファイル)
26 subFileList.get( 0 ).setFilePath( updateSubFile1 );
27 subFileList.get( 1 ).setFilePath( updateSubFile2 );
28
29 // 関連ファイルを設定
30 doc.setSubFileList( subFileList );
31
32 // チェックイン
33 doc.checkinDoc( false,
34                 true );

9.3.5　文書をごみ箱へ移動したあと元に戻す

文書をごみ箱へ移動後，元に戻す場合のコーディング例を次に示します。

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // docOiid        : 操作対象文書のバージョニングOIID
4  ////////////////////////////////////////////////////////////
5
6  // 文書操作用のインスタンスを取得
4  DecmDoc doc = decmFactory.createDecmDoc();
5
9  // 文書に接続
10 doc.setOiid( docOiid );
11
12 // ごみ箱へ移動
13 doc.trashDoc( true );
14
15 // ごみ箱から元に戻す
16 doc.trashBackDoc( true );

9.3.6　文書の移動

文書を移動する場合のコーディング例を次に示します。

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // docOiid        : 操作対象文書のバージョニングOIID
4  // fldOiid        : 移動先フォルダのOIID
5  ////////////////////////////////////////////////////////////
6
7  // 文書操作用のインスタンスを取得
8  DecmDoc doc = decmFactory.createDecmDoc();
9
10 // 文書に接続
11 oc.setOiid( docOiid );
12
13 // 移動
14 doc.moveDoc( fldOiid, true );

9.4　フォルダ操作パッケージのコーディング例

フォルダ操作パッケージ（jp.co.hitachi_system.sContents.API.Folder）のコーディング例を説明します。

＜この節の構成＞

9.4.1　フォルダの作成・削除

9.4.2　フォルダのプロパティの作成・更新

9.4.3　フォルダのアクセス権限の更新・取得

9.4.1　フォルダの作成・削除

フォルダを作成，削除する場合のコーディング例を次に示します。

＜この項の構成＞

(1)　フォルダを作成する

(2)　ノードフォルダを作成する

(3)　公開フォルダを作成する

(4)　フォルダを削除する

(1)　フォルダを作成する

1  ////////////////////////////////////////////////////////////
2  // decmFactory     : DecmFactoryインスタンス
3  ////////////////////////////////////////////////////////////
4
5  // フォルダ操作用インスタンスを取得
6  DecmFolder fld = decmFactory.createDecmFolder();
7
8  // プロパティ操作用インスタンスを取得
9  DecmFolderProp fldProp = decmFactory.createDecmFolderProp();
10
11 // プロパティを設定
12 fldProp.setStrProp( "esysProp_Name", "文書フォルダ" );
13 fld.setFolderProp( fldProp );
14
15 // フォルダ作成
16 fld.createDocFolder( DecmFolder.ACL_TYPE_PRIVATE,
17                      DecmFolder.DOC_CREATE_OK,
18                      "",
19                      true );

(2)　ノードフォルダを作成する

1  ////////////////////////////////////////////////////////////
2  // decmFactory     : DecmFactoryインスタンス
3  ////////////////////////////////////////////////////////////
4
5  // フォルダ操作用インスタンスを取得
6  DecmFolder fld = decmFactory.createDecmFolder();
7
8  // プロパティ操作用インスタンスを取得
9  DecmFolderProp fldProp = decmFactory.createDecmFolderProp();
10
11 // プロパティを設定
12 fldProp.setStrProp( "esysProp_Name", "ノードフォルダ" );
13 fld.setFolderProp( fldProp );
14
15 // フォルダ作成
16 fld.createNodeFolder( true );

(3)　公開フォルダを作成する

1  ////////////////////////////////////////////////////////////
2  // decmFactory     : DecmFactoryインスタンス
3  ////////////////////////////////////////////////////////////
4
5  // フォルダ操作用インスタンスを取得
6  DecmFolder fld = decmFactory.createDecmFolder();
7
8  // プロパティ操作用インスタンスを取得
9  DecmFolderProp fldProp = decmFactory.createDecmFolderProp();
10
11 // プロパティを設定
12 fldProp.setStrProp( "esysProp_Name", "公開フォルダ" );
13 fld.setFolderProp( fldProp );
14
15 // フォルダ作成
16 fld.createPubFolder( DecmFolder.ACL_TYPE_PRIVATE,
17                      true );

(4)　フォルダを削除する

1  ////////////////////////////////////////////////////////////
2  // decmFactory     : DecmFactoryインスタンス
3  // fldOiid         : 操作対象フォルダのOIID
4  ////////////////////////////////////////////////////////////
5
6  //フォルダ操作用インスタンスを取得
7  DecmFolder fld = decmFactory.createDecmFolder();
8
9  //フォルダに接続
10 fld.setOiid( fldOiid );
11
12 // 削除
13 fld.deleteFolder( true );

9.4.2　フォルダのプロパティの作成・更新

フォルダのプロパティを作成，更新する場合のコーディング例を次に示します。

＜この項の構成＞

(1)　文書フォルダのプロパティを更新後に取得する

(2)　ノードフォルダのプロパティを更新後に取得する

(3)　公開フォルダのプロパティを更新後に取得する

(1)　文書フォルダのプロパティを更新後に取得する

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // fldOiid        : 操作対象フォルダのOIID
4  ////////////////////////////////////////////////////////////
5
6  // フォルダ操作用インスタンスを取得
7  DecmFolder fld = decmFactory.createDecmFolder();
8
9  // フォルダに接続
10 fld.setOiid( fldOiid );
11
12 // プロパティ操作用インスタンスを取得
13 DecmFolderProp fldProp = decmFactory.createDecmFolderProp();
14
15 // プロパティを設定
16 fldProp.setStrProp( "esysProp_Name", "文書フォルダ_改訂" );
17 fldProp.setStrProp( "esysProp_Comment", "誤記訂正" );
18 fld.setFolderProp( fldProp );
19
20 // プロパティ更新
21 fld.updateDocFolderProp( true );
22
23 // プロパティ取得
24 DecmFolderProp getProp = fld.fetchFolderProp( false );

(2)　ノードフォルダのプロパティを更新後に取得する

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // fldOiid        : 操作対象フォルダのOIID
4  ////////////////////////////////////////////////////////////
5
6  // フォルダ操作用インスタンスを取得
7  DecmFolder fld = decmFactory.createDecmFolder();
8
9  // フォルダに接続
10 fld.setOiid( fldOiid );
11
12 // プロパティ操作用インスタンスを取得
13 DecmFolderProp fldProp = decmFactory.createDecmFolderProp();
14
15 // プロパティを設定
16 fldProp.setStrProp( "esysProp_Name", "ノードフォルダ_改訂" );
17 fldProp.setStrProp( "esysProp_Comment", "誤記訂正" );
18 fld.setFolderProp( fldProp );
19
20 // プロパティ更新
21 fld.updateNodeFolderProp( true );
22
23 // プロパティ取得
24 DecmFolderProp getProp = fld.fetchFolderProp( false );

(3)　公開フォルダのプロパティを更新後に取得する

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // fldOiid        : 操作対象フォルダのOIID
4  ////////////////////////////////////////////////////////////
5
6  // フォルダ操作用インスタンスを取得
7  DecmFolder fld = decmFactory.createDecmFolder();
8
9  // フォルダに接続
10 fld.setOiid( fldOiid );
11
12 // プロパティ操作用インスタンスを取得
13 DecmFolderProp fldProp = decmFactory.createDecmFolderProp();
14
15 // プロパティを設定
16 fldProp.setStrProp( "esysProp_Name", "ノードフォルダ_改訂" );
17 fldProp.setStrProp( "esysProp_Comment", "誤記訂正" );
18 fld.setFolderProp( fldProp );
19
20 // プロパティ更新
21 fld.updatePubFolderProp( true );
22
23 // プロパティ取得
24 DecmFolderProp getProp = fld.fetchFolderProp( false );

9.4.3　フォルダのアクセス権限の更新・取得

フォルダのアクセス権限を更新・取得する場合のコーディング例を次に示します。

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // fldOiid        : 操作対象フォルダのOIID
4  ////////////////////////////////////////////////////////////
5
6  // フォルダ操作用インスタンスを取得
7  DecmFolder fld = decmFactory.createDecmFolder();
8
9  // フォルダに接続
10 fld.setOiid( fldOiid );
11
12 // アクセス権限操作用インスタンスを取得
13 DecmFolderPerm fldPerm = decmFactory.createDecmFolderPerm();
14
15 // アクセス権限を設定
16 fldPerm.setEveryonePerm( DecmACLPerm.PERM_READ );
17 fld.setFolderPerm( fldPerm );
18
19 // アクセス権限更新
20 fld.updateFolderPerm( true );
21
22 // アクセス権限取得
23 DecmFolderPerm getPerm = fld.fetchFolderPerm( true );

9.5　検索操作パッケージのコーディング例

検索操作パッケージ（jp.co.hitachi_system.sContents.API.Select）のコーディング例を説明します。

＜この節の構成＞

9.5.1　文書の検索

9.5.2　組み合わせ検索条件を指定した文書の検索

9.5.3　全文検索を利用した文書の検索

9.5.1　文書の検索

文書を検索する場合のコーディング例を，次に示します。

コーディング例での検索の概要は次のとおりです。

実行する操作

文書名が「営業」で始まる文書を取得する

検索条件

文書名，および更新者の一覧を取得する

関連ファイルを検索対象とする

生成するEQL

SELECT esysProp_Name, esysProp_ModifierFROM ecmClass_FiledocDVWHERE esysProp_Name XLIKE '営業%'

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  ////////////////////////////////////////////////////////////
4
5  // 文書検索用インスタンスを取得
6  DecmSelect decmSelect = decmFactory.createDecmSelect();
7
8  ////////////////////////////////////////////////////////////
9  // 検索パラメタ指定
10 ////////////////////////////////////////////////////////////
11
12 // 検索取得列の指定
13 Vector<String> selectList = new Vector<String>();
14 selectList.add(DecmTableDef.ESYSPROP_NAME);
15 selectList.add(DecmTableDef.ESYSPROP_MODIFIER);
16 decmSelect.setSelectList(selectList);
17
18 // 関連ファイルを検索対象とする
19 decmSelect.setSubFileSearchMode(true);
20
21 ////////////////////////////////////////////////////////////
22 // 検索条件を指定
23 ////////////////////////////////////////////////////////////
24
25 //検索条件用のインスタンスを取得
26 DecmCondition condition = decmFactory.createDecmCondition();
27
28 // 検索条件作成
29 condition.createStrCond(DecmTableDef.ESYSPROP_NAME, DecmCondition.OP_STWITH, "営業");
30
31 // 検索条件を指定
32 decmSelect.addCondition(condition);
33
34 ////////////////////////////////////////////////////////////
35 // 検索結果を取得
36 ////////////////////////////////////////////////////////////
37 Vector<DecmDocProp> ret = decmSelect.searchDoc();

9.5.2　組み合わせ検索条件を指定した文書の検索

組み合わせ検索条件を指定して文書を検索する場合のコーディング例を，次に示します。

コーディング例での検索の概要は次のとおりです。

実行する操作

文書名が「営業」か「経営」で始まり，更新者が「user01」の文書を取得する

検索条件

文書名，および更新者の一覧を取得する

関連ファイルを検索対象とする

生成するEQL

SELECT esysProp_Name, esysProp_ModifierFROM ecmClass_FiledocDVWHERE (esysProp_Name XLIKE '営業%' OR esysProp_Name XLIKE '経営%') AND esysProp_Modifier == 'user01'

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  ////////////////////////////////////////////////////////////
4
5  // 文書検索用インスタンスを取得
6  DecmSelect decmSelect = decmFactory.createDecmSelect();
7
8  ////////////////////////////////////////////////////////////
9  // 検索パラメタ指定
10 ////////////////////////////////////////////////////////////
11
12 // 検索取得列の指定
13 Vector<String> selectList = new Vector<String>();
14 selectList.add(DecmTableDef.ESYSPROP_NAME);
15 selectList.add(DecmTableDef.ESYSPROP_MODIFIER);
16 decmSelect.setSelectList(selectList);
17
18 // 関連ファイルを検索対象とする
19 decmSelect.setSubFileSearchMode(true);
20
21 ////////////////////////////////////////////////////////////
22 // 検索条件を指定
23 ////////////////////////////////////////////////////////////
24
25 //検索条件用のインスタンスを取得
26 DecmCondition condition_A = decmFactory.createDecmCondition();
27 DecmCondition condition_B = decmFactory.createDecmCondition();
28 DecmCondition condition_C = decmFactory.createDecmCondition();
29
30 // 組み合わせ検索条件用のインスタンスを取得
31 DecmCondGroup condGroupTop = decmFactory.createDecmCondGroup();
32 DecmCondGroup condGroupSub = decmFactory.createDecmCondGroup();
33
34 // 検索条件作成
35 condition_A.createStrCond(DecmTableDef.ESYSPROP_NAME, DecmCondition.OP_STWITH, "営業");       /* A */
36 condition_B.createStrCond(DecmTableDef.ESYSPROP_NAME, DecmCondition.OP_STWITH, "経営");       /* B */
37 condition_C.createStrCond(DecmTableDef.ESYSPROP_MODIFIER, DecmCondition.OP_EQ, "user01");     /* C */
38
39 // 組み合わせ検索条件を作成
40 // A or B
41 condGroupSub.addCond(condition_A, DecmCondGroup.OP_AND); // 第二引数の指定値は無視される
42 condGroupSub.addCond(condition_B, DecmCondGroup.OP_OR);
43
44 // (A or B) and C
45 condGroupTop.addCondGroup(condGroupSub, DecmCondGroup.OP_AND); // 第二引数の指定値は無視される
46 condGroupTop.addCond(condition_C, DecmCondGroup.OP_AND);
47
48 // 検索条件を指定
49 decmSelect.setCondGroup(condGroupTop);
50
51 ////////////////////////////////////////////////////////////
52 // 検索結果を取得
53 ////////////////////////////////////////////////////////////
54 Vector<DecmDocProp> ret = decmSelect.searchDoc();

9.5.3　全文検索を利用した文書の検索

全文検索を利用して文書を検索する場合のコーディング例を，次に示します。

コーディング例での検索の概要は次のとおりです。

実行する操作

登録ファイルの内容に「営業」という単語が含まれる文書を取得する

検索条件

文書名，および更新者の一覧を取得する

関連ファイルを検索対象とする

生成するEQL

SELECT esysProp_Name, esysProp_ModifierFROM ecmClass_FiledocDVWHERE contains_with_score( edmProp_TextIndex, { "営業" }) IS TRUE

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  ////////////////////////////////////////////////////////////
4
5  // 文書検索用インスタンスを取得
6  DecmSelect decmSelect = decmFactory.createDecmSelect();
7
8  ////////////////////////////////////////////////////////////
9  // 検索パラメタ指定
10 ////////////////////////////////////////////////////////////
11
12 // 検索取得列の指定
13 Vector<String> selectList = new Vector<String>();
14 selectList.add(DecmTableDef.ESYSPROP_NAME);
15 selectList.add(DecmTableDef.ESYSPROP_MODIFIER);
16 decmSelect.setSelectList(selectList);
17
18 // 関連ファイルを検索対象とする
19 decmSelect.setSubFileSearchMode(true);
20
21 ////////////////////////////////////////////////////////////
22 // 検索条件を指定
23 ////////////////////////////////////////////////////////////
24
25 // 全文検索キーワードを指定
26 Vector<String> keywordList = new Vector<String>();
27 keywordList.add("営業");
28 decmSelect.setKeyword(keywordList);
29
30 ////////////////////////////////////////////////////////////
31 // 検索結果を取得
32 ////////////////////////////////////////////////////////////
33 Vector<DecmDocProp> ret = decmSelect.searchDoc();

9.6　文書種別マスタ操作パッケージのコーディング例

文書種別マスタ操作パッケージ（jp.co.hitachi_system.sContents.API.DocMaster）のコーディング例を説明します。

＜この節の構成＞

9.6.1　文書種別マスタ一覧の取得

9.6.2　特定の文書種別マスタのOIIDの取得

9.6.3　属性値マスタ一覧の取得

9.6.1　文書種別マスタ一覧の取得

文書種別マスタ一覧を取得する場合のコーディング例を，次に示します。

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  ////////////////////////////////////////////////////////////
4
5  // 文書種別マスタ一覧取得用インスタンスを取得
6  DecmDocMasterList docMasterList = decmFactory.createDecmDocMasterList();
7
8  // 文書種別マスタ一覧を取得
9  Vector<DecmDocMasterProp> ret = docMasterList.getDocMasterList();

9.6.2　特定の文書種別マスタのOIIDの取得

特定の文書種別マスタのOIIDを取得する場合のコーディング例を，次に示します。

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  // masterOiid     : 操作対象マスタのOIID
4  ////////////////////////////////////////////////////////////
5
6  // 文書種別マスタ操作用インスタンスを取得
7  DecmDocMaster docMaster = decmFactory.createDecmDocMaster();
8
9  // 操作対象マスタに接続
10 docMaster.setOiid(masterOiid);
11
12 // 文書種別マスタのOIIDを取得
13 Vector<DecmDocMasterProp> ret = docMaster.fetchDocMasterProp();

9.6.3　属性値マスタ一覧の取得

属性値マスタ一覧を取得する場合のコーディング例を，次に示します。

1  ////////////////////////////////////////////////////////////
2  // decmFactory    : DecmFactoryインスタンス
3  ////////////////////////////////////////////////////////////
4
5  // 属性値マスタ操作用インスタンスを取得
6  DecmDocPropMaster docPropMaster = decmFactory.createDecmDocPropMaster();
7
8  // 属性値マスタ一覧を取得
9  Vector<DecmDocPropMasterProp> ret = docPropMaster.getDocPropMasterList();

10.　 DocumentBroker Standard GUI Development Kitの環境構築

DocumentBroker Standard GUI Development Kitのインストール，および環境構築の手順について説明します。

＜この章の構成＞

10.1　DocumentBroker Standard GUI Development Kitのインストール，および環境構築手順

10.1　DocumentBroker Standard GUI Development Kitのインストール，および環境構築手順

ここでは，DocumentBroker Standard GUI Development Kitのインストール，および環境構築の手順について説明します。

＜この節の構成＞

10.1.1　DocumentBroker Standard GUI Development Kitのインストール

10.1.2　 Java実行環境の設定

10.1.3　 uCosminexusで使用する場合の設定

10.1.1　DocumentBroker Standard GUI Development Kitのインストール

この節では，DocumentBroker Standard GUI Development Kitのインストールの方法について説明します。

DocumentBroker Standard GUI Development Kitは，次に示す手順でインストールします。

システム管理者（Administrators）の権限を持つユーザIDでログインします。

DocumentBroker Standard GUI Development Kitのインストーラを起動します。

インストーラの画面の指示に従って，DocumentBroker Standard GUI Development Kitをインストールしてください。

上書きインストールをするときは，DocumentBroker Standard GUI Development Kitのファイルとライブラリを使用しているプログラムをすべて停止してからインストールをしてください。

上書きインストールをすると，インストールフォルダ以下のすべてのファイルが上書きされます。

10.1.2　 Java実行環境の設定

Java クラスライブラリのパッケージのJARファイルは，次のディレクトリに格納されます。

<インストールディレクトリ>※¥java¥lib¥StdGuiApi.jar

注※

DocumentBroker Runtimeまたは，DocumentBroker Development Kitのインストールディレクトリです。

上記のJARファイルのパスを，Java実行環境に設定します。使用する環境に合わせてパスを追加してください。

10.1.3　 uCosminexusで使用する場合の設定

DocumentBroker Standard GUI Development Kitは，uCosminexus Application ServerのJ2EEモードでの動作を前提としています。このため，uCosminexus Application Serverは，J2EEモードで動作するように環境を構築してください。

なお，uCosminexus Application Serverの環境構築の詳細は，マニュアル「Cosminexus　システム構築ガイド」を参照してください。

＜この項の構成＞

(1)　 DocumentBroker Runtime，またはDocumentBroker Development Kitの設定

(2)　uCosminexusへの設定の追加

(1)　 DocumentBroker Runtime，またはDocumentBroker Development Kitの設定

DocumentBroker Runtime，またはDocumentBroker Development Kitでの設定を実施してください。

(2)　uCosminexusへの設定の追加

Cosminexus Component Containerのusrconf.cfgファイルに，次のパスを追加設定します。

add.class.path=<インストールディレクトリ>※¥java¥lib¥StdGuiApi.jar

注※

DocumentBroker Runtimeまたは，DocumentBroker Development Kitのインストールディレクトリです。

付録

＜この付録の構成＞

付録A　 DocumentBroker Standard GUI Development Kitで使用するプロパティ一覧

付録B　用語解説

付録A　 DocumentBroker Standard GUI Development Kitで使用するプロパティ一覧

ここでは，DocumentBroker Standard GUI Development Kitで使用するプロパティについて説明します。

＜この節の構成＞

付録A.1　 DocumentBroker Standard GUI Development Kitで使用するプロパティ

付録A.1　 DocumentBroker Standard GUI Development Kitで使用するプロパティ

DocumentBroker Standard GUI Development Kitで使用するプロパティの一覧を次の表に示します。

表A-1　 DocumentBroker Standard GUI Development Kitで使用するプロパティ

プロパティ名称
説明
更新
指定の省略

dmaProp_OIID
オブジェクトのOIID値が表示されます。
文書，フォルダ，文書種別マスタ，属性値マスタのオブジェクトで使用されます。
×
－

esysProp_Name※
次に示すオブジェクトの名前，または表示名のプロパティです。

文書，およびフォルダ：「名前」のプロパティを示します。

文書種別マスタ：「文書種別マスタ名」のプロパティを示します。

属性値マスタ：「表示名」のプロパティを示します。

指定できるバイト数は255バイトまでです。
○
作成時：×

更新時：○

edmProp_OwnerId※
文書，またはフォルダオブジェクトの検索時用所有者IDプロパティが表示されます。
255バイトまでの値が設定されます。
×
－

dbrProp_OwnerId※
文書，またはフォルダオブジェクトのプロパティ値取得時の所有者IDプロパティが表示されます。
255バイトまでの値が設定されます。
×
－

dbuUserProp_OwnerName※
文書，またはフォルダオブジェクトの所有者名のプロパティが表示されます。
255バイトまでの値が設定されます。
×
－

esysProp_CreateTime※
文書，フォルダ，文書種別マスタ，属性値マスタのオブジェクト作成日時プロパティが表示されます。
表示されるのは，1970/01/01からの通算秒値，またはtime_t型の値です。
255バイトまでの値が設定されます。
×
－

esysProp_Creator※
文書，フォルダ，文書種別マスタ，属性値マスタのオブジェクトに対する作成者IDプロパティが表示されます。
255バイトまでの値が設定されます。
×
－

esysProp_ModifyTime
文書，フォルダ，文書種別マスタ，属性値マスタのオブジェクトの更新日時プロパティが表示されます。
表示されるのは，1970/01/01からの通算秒値，またはtime_t型の値です。
×
－

esysProp_Modifier※
文書，フォルダ，文書種別マスタ，属性値マスタのオブジェクトに対する更新者IDプロパティが表示されます。
255バイトまでの値が設定されます。
×
－

dbuUserProp_ModifierName※
文書，フォルダ，文書種別マスタ，属性値マスタのオブジェクトに対する更新者名プロパティが表示されます。
255バイトまでの値が設定されます。
×
－

dbuUserProp_ReservedUserId※
フォルダオブジェクトに対するチェックアウト中ユーザIDプロパティが表示されます。
255バイトまでの値が設定されます。
×
－

dbuUserProp_ReservedUserName※
フォルダオブジェクトに対するチェックアウト中ユーザ名プロパティが表示されます。
255バイトまでの値が設定されます。
×
－

esysProp_Comment※
文書，またはフォルダのオブジェクトに対するコメントプロパティです。
指定できるバイト数は1,024バイトまでです。
○
○

ecmProp_FolderType
フォルダ種別が表示されます。
次の値でフォルダ種別を判断します。

1：ノードフォルダ

2：文書フォルダ

3：公開フォルダ

×
－

ecmProp_FolderLevel
フォルダ階層のレベルのプロパティが表示されます。
次の値で，フォルダ階層のレベルのプロパティを判断します。

1：最上位フォルダ

2：下位フォルダ

×
－

ecmProp_DocCreateFlg
フォルダ下の文書の作成可否を示すプロパティが表示されます。
次の値で作成の可否を判断します。

0：文書作成不可

1：文書作成可

×
－

ecmProp_AclType
文書フォルダ，または公開フォルダに対して，アクセス権限の設定方式を示すプロパティが表示されます。
次の値で文書フォルダ，または公開フォルダのアクセス権限の設定方式を判断します。

文書フォルダの場合

1：個別に設定

2：同じ権限を共有

公開フォルダの場合

1：全員に公開

2：公開範囲を限定

×
－

ecmProp_OpenPubACL
アクセス権限の設定方式で，文書フォルダに「同じ権限を共有」，公開フォルダに「公開範囲を限定」とした場合に設定しているパブリックACLのoiid値が表示されます。
フォルダオブジェクトで使用されます。
返却値は，OIID文字列の下位52バイトです。
×
－

ecmProp_OpenPubACL_FULL
アクセス権限の設定方式で，文書フォルダに「同じ権限を共有」，公開フォルダに「公開範囲を限定」とした場合に設定しているパブリックACLのoiid値が表示されます。
フォルダオブジェクトで使用されます。
返却値は，OIID文字列の下位133バイトです。
×
－

ecmProp_AclSucceed
上位フォルダからのアクセス権限の継承を示すプロパティが表示されます。
次の値で，アクセス権限の継承を判断します。

0：上位フォルダからのアクセス権限継承する

1：上位フォルダからのアクセス権限継承しない

×
－

ecmProp_DocTypeOIID
フォルダ，または文書に設定されている文書種別マスタのOIIDを示すプロパティが表示されます。
返却値は，OIID文字列の下位52バイトです。
×
－

ecmProp_DocTypeOIID_FULL
フォルダ，または文書に設定されている文書種別マスタのOIIDを示すプロパティが表示されます。
返却値は，OIID文字列の下位133バイトです。
×
－

ecmProp_ExtInt1
フォルダ下ファイル容量制限の使用有無を示すプロパティが表示されます。
次の値で，ファイル容量制限の使用有無を判断します。

0：フォルダ下容量制限を使用しない

1：フォルダ下容量制限を使用する

なお，このプロパティは最上位のフォルダにだけ設定されます。
×
－

ecmProp_MaxCapacity
フォルダ下ファイル容量制限機能する場合の最大容量（数値部分）を1～9,999の範囲で示すプロパティが表示されます。
なお，このプロパティは最上位のフォルダにだけ設定されます。
×
－

ecmProp_CapacityUnit
フォルダ下ファイル容量制限機能する場合の最大容量（単位部分）を示すプロパティが表示されます。
「ecmProp_MaxCapacity」が示す数値に対する単位が表示されます。
次の値で，フォルダ下ファイル容量制限機能する場合の最大容量（単位部分）を判断します。

2：メガバイト

3：ギガバイト

4：テラバイト

なお，このプロパティは最上位のフォルダにだけ設定されます。
×
－

ecmProp_UseCapacity
フォルダ下ファイル容量制限機能する場合の使用済み容量を示すプロパティが表示されます。
なお，このプロパティは最上位のフォルダにだけ設定されます。
×
－

ecmProp_CHOiid
文書のバージョニングオブジェクトのOIIDを示すプロパティが表示されます。
返却値は，OIID文字列の下位52バイトです。なお，関連ファイルの場合は，主ファイルのバージョニングオブジェクトのOIIDが表示されます。
×
－

ecmProp_CHOiid_FULL
文書のバージョニングオブジェクトのOIID値を示すプロパティが表示されます。
返却値は，OIID文字列の下位133バイトです。
×
－

ecmProp_DocType
文書の種類（一般文書，公開文書）を示すプロパティが表示されます。
次の値で文書の種類を判断します。

1：一般文書

2：審査・承認機能による公開文書

×
－

ecmProp_FileName※
登録されている文書のファイル名称を示すプロパティが表示されます。
255バイトまでの値が設定されます。
×
－

ecmProp_FileSize
登録されている文書のファイルサイズ（バイト数）を示すプロパティが表示されます。
×
－

ecmProp_ParentContainer
文書が所属しているフォルダのOIID値を示すプロパティが表示されます。
返却値は，OIID文字列の下位52バイトです。
×
－

ecmProp_ParentContainer_FULL
文書が所属しているフォルダのOIID値を示すプロパティが表示されます。
返却値は，OIID文字列の下位133バイトです。
×
－

ecmProp_DeleteFlag
文書削除フラグ（ごみ箱の文書）を示すプロパティが表示されます。
次の値で，ごみ箱への削除状態を判断します。

0：通常

1：ごみ箱へ削除した状態

×
－

ecmProp_DeleteUserId※
文書削除を実行したユーザのIDを示すプロパティが表示されます。
255バイトまでの値が設定されます。
×
－

ecmProp_DeleteTime
ごみ箱への削除を実行した日時を示すプロパティが表示されます。
time_t型の値で表示されます。
×
－

ecmProp_DocNumber※
採番した文書番号を示すプロパティが表示されます。
255バイトまでの値が設定されます。
×
－

ecmProp_UserInt1～ecmProp_UserInt5
ユーザプロパティです。
数値型，または日付型に使用します。
次の値で数値型，または日付型を示します。

数値型の場合：INT型の数値

日付型の場合：「YYYYMMDD」形式の数値
例えば，2008年1月18日の場合，20080118と指定します。

○
○

ecmProp_UserStr1～ecmProp_UserStr5※
ユーザプロパティです。
文字列型に使用します。
指定できるバイト数は255バイトまでです。
○
○

ecmProp_DocTypePropInt1～ecmProp_DocTypePropInt10
文書種別マスタ用プロパティ（数値）です。
数値型，または日付型に使用します。
○
○

ecmProp_DocTypePropStr1～ecmProp_DocTypePropStr10※
文書種別マスタ用プロパティ（文字列）です。
文字列型，またはマスタ型に使用します。
指定できるバイト数は255バイトまでです。
○
○

ecmProp_DocTypePropLongStr1～ecmProp_DocTypePropLongStr5※
文書種別マスタ用プロパティ（文字列）です。
文字列型に使用します。
指定できるバイト数は4,096バイトまでです。
○
○

ecmProp_DocNumProp※
採番に使用するプロパティ名を示すプロパティが表示されます。
文書種別マスタオブジェクトで使用されます。
255バイトまでの値が設定されます。
×
－

ecmProp_DocNumDelimiter※
採番用の区切り文字を示すプロパティが表示されます。
文書種別マスタオブジェクトで使用されます。
255バイトまでの値が設定されます。
×
－

ecmProp_DocNumSuffix※
採番の接尾辞を示すプロパティが表示されます。
文書種別マスタオブジェクトで使用されます。
255バイトまでの値が設定されます。
×
－

ecmProp_Level※
属性値マスタの階層を示すプロパティが表示されます。
255バイトまでの値が設定されます。
次の値で属性値階層の階層を判断します。

1：最上位

2～10：下位

×
－

ecmProp_DocTypePropName※
属性値マスタを使用する文書種別マスタ用のプロパティ名を示すプロパティが表示されます。
255バイトまでの値が設定されます。
最上位のオブジェクトにだけ設定されます。
×
－

ecmProp_DocTypePropCode※
属性値マスタの階層を示すプロパティ表示名のコード値を示すプロパティが表示されます。
255バイトまでの値が設定されます。
×
－

ecmProp_DocTypeParentCode※
上位属性値階層の属性値コードを示すプロパティが表示されます。
255バイトまでの値が設定されます。
指定例を次に示します。
A（最上位）←B←C←Dの階層を持つ場合
Bの設定値：A
Cの設定値：A-B
Dの設定値：A-B-C
自分の最上位の属性値コードから，一つ上の親コードまでを「-」で区切った属性値コードで設定されます（階層情報を持たせます）。
最上位の属性値は空白が指定されます。
×
－

ecmProp_SortNumber
同一階層の属性値コードをソートするためのソート用の番号を示すプロパティが表示されます。
属性値マスタオブジェクトで使用されます。
×
－

under
取得したフォルダに対して，下位フォルダの存在有無を示すプロパティが表示されます。
次の値で，下位フォルダの存在有無を判断します。

0：下位フォルダは存在しない

1：下位フォルダが存在する

×
－

esysProp_FileType
文書が，主ファイルか関連ファイルかを示すフラグが表示されます。
次の値で，主ファイル，関連ファイルの別を判断します。

0：主ファイル

1：関連ファイル

×
－

esysProp_TopDVOIID_FULL
関連ファイルが対応する主ファイルのバージョンオブジェクトのOIIDが表示されます。
値を次に示します。

主ファイルの場合：null，または「""」空文字

関連ファイルの場合：関連ファイルと関連付けられた主ファイルのバージョンオブジェクトのOIID（133桁）

×
－

凡例

○：更新，または省略ができます。

×：更新，または省略ができません。

－：更新，または省略の対象外です。

注※

指定できるバイト数は，文字コード種別がUTF-8の場合のバイト数です。

バイト数を確認するときは，UTF-8形式で文字列長を調べてください。

付録B　用語解説

ここでは，DocumentBroker Standard GUI Development Kitで使用する用語について説明しています。

（英字）

ACL（Access Control List）

アクセス制御エレメントのことです。

AND検索

検索条件同士の論理積を求める結合条件です。例えば，著者が「日立太郎」で，文書の実体（コンテント）中に「コンピュータ」という文字列を含む文書を検索する，というような場合に使用できます。

API（Application Programming Interface）

アプリケーションプログラムとのインターフェースです。

CORBA（Common Object Request Broker Architecture）

OMG（Object Management Group）が提唱するオブジェクト間の通信メカニズムを提唱するORB（Object Request Broker）の標準アーキテクチャです。

DMA（Document Management Alliance）

文書管理インターフェースの標準化を図る団体AIIM（Association for Information and Image Management International）によって定義される共通インターフェースです。

GUID（Gllobary Unique Idenifier）

DMAのクラス，プロパティなどに与えるユニークな識別子です。GUIDは，「X」を0～9，a～f（小文字），およびA～F（大文字）で表される16進数とした「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX（8けた-4けた-4けた-4けた-12けた）」の形式で表されます。

Javaクラスライブラリ

DocumentBrokerサーバにアクセスするユーザアプリケーションプログラムをJava言語で作成するために，DocumentBroker Development KitおよびDocumentBroker Runtimeが提供しているインターフェースです。

OIID（Object Instance Identifier）

データベースに格納されたオブジェクトの存在や格納位置などを明確にするために，各オブジェクトに与えるユニークな識別子です。

Webサービス

DocumentBroker Standard GUIを使用した文書管理サービスを，クライアントに対して提供するサーバです。

（ア行）

アクセス権限

文書空間オブジェクトを作成したり，すでに作成されているオブジェクトにアクセスしたりする権利です。

一般文書

作成済みの文書で，公開していない文書のことです。

イメージ文書登録サーバ

デジタル複合機でスキャンした紙の文書や受信したFAXを，DocumentBroker Standard GUIのイメージ文書として登録するサーバです。

インターフェース

Java クラスライブラリの機能を実行するためのメソッドが定義されている，クラスの仕様です。Java クラスライブラリでは，オブジェクトを操作する時，まず，インターフェースを取得して，そのインターフェースで定義されているメソッドを実行する，という手順で操作します。

案件

文書に対して審査・承認を依頼してから，その文書が審査・承認を経て，公開されるまでの処理単位です。

オリジナルファイル

文書をPDF形式に変換する設定の場合，PDF形式に変換される前の文書ファイルのことです。

（カ行）

監査証跡ログ

フォルダや文書などに対するユーザの操作を記録した履歴のことです。監査証跡ログを参照することで，システムの使用状況や不正なアクセスがないかどうかを確認できます。

関連ファイル

文書に登録された文書ファイルのうち，主ファイル以外の文書ファイルのことです。関連ファイルは複数登録できます。関連ファイルには，一般文書に登録された一般関連ファイルと，公開文書に登録された公開関連ファイルがあります。

継承

既存のクラスを利用して，新しいクラスを定義するオブジェクト指向の技術です。

検索結果キャッシュ

キャッシュ付き検索実行時に作成される検索結果のキャッシュです。キャッシュ付き検索では，例えば，10,000件の検索結果がある場合に，これを検索結果キャッシュとして保存しておき，ユーザアプリケーションプログラムではこれを100件ずつ取得する，という検索ができます。

公開フォルダ

公開文書を格納するフォルダのことです。

公開文書

審査・承認後に公開された文書のことです。

ごみ箱

削除した文書を一時的に退避する場所です。

ごみ箱検索

ごみ箱を指定した検索です。

コンテント

文書のデータ部分を指します。DMAで規定されているコンテント管理モデルに従ってアクセスされるオブジェクトの実体（例えば，report.doc，document.htmなど）です。

（サ行）

主ファイル

文書に一つだけ登録される文書ファイルのことです。主ファイルに対する操作が文書ファイル全体に反映されます。

システム管理者

DocumentBroker Standard GUI Development Kitの運用，管理および保守をするユーザです。DocumentBroker Standard GUI Development Kitの実行環境を設定することができます。

所有者

文書空間オブジェクトの所有者として設定されているユーザです。

スーパークラス

あるクラスのクラス定義に使用されたクラスを，派生したクラスのスーパークラスといいます。

セッション

文書空間に接続している間のことです。文書空間に接続することを，セッションの確立といいます。文書空間との接続を解除することを，セッションの切断といいます。

セッションオブジェクト

セッションを確立する機能と，セッション内のトランザクションを制御する機能を持つ，Java クラスライブラリのオブジェクトです。DbjSessionインターフェースの機能を実行できます。

全文検索

文書中に含まれるキーワードを条件（全文検索条件）として，キーワードを含む文書を検索する方法です。

全文検索テキストインデクス登録サーバ

文書から全文検索用のテキストデータを抽出し，データベースに対してテキストインデクス情報を登録するためのサーバです。

（タ行）

チェックアウト

文書を更新するために，文書ファイルの実体をダウンロードして，ほかのユーザによって更新されないようにすることです。

チェックイン

チェックアウトした文書を更新し，新しい版（バージョン）の文書をフォルダに再登録することです。

同義語辞書

全文検索実行時に指定する検索タームと同じ意味を持つ単語（同義語）を定義する辞書です。

トランザクション

文書空間オブジェクトの処理単位です。トランザクション単位で，文書空間オブジェクトへの操作を確定，または取り消すことができます。

トランザクションの単位は，ユーザが明示的に指定できます。指定しなかった場合は，メソッド単位でトランザクションが分割されます。

（ナ行）

ノードフォルダ

フォルダ体系に対して階層の分類を整理するために使用するフォルダです。ノードフォルダには文書を格納できません。

（ハ行）

バージョニングオブジェクト

文書の一連のバージョンを統括する文書空間オブジェクトです。

バージョンオブジェクト

文書の個々のバージョンを表現する文書空間オブジェクトです。

パーミッション

文書空間オブジェクトの作成，プロパティ参照，コンテンツ更新などの実行できる操作の範囲を表す値です。オブジェクト作成権限を与えるパーミッション，オブジェクトの操作の範囲を定めるパーミッションがあります。

パブリックACL

文書空間オブジェクトとして存在するアクセス制御情報です。複数の文書空間オブジェクトで共有できます。

ファクトリクラス

パラメタクラスのオブジェクトの生成，セッションオブジェクトの生成，および文書空間メタ情報アクセスインターフェースの取得を実行する，クラスならびにインターフェースです。

フォルダ

フォルダのプロパティと，フォルダに格納するファイルとの関連づけについての情報で構成される概念です。これらの情報はデータベースに格納されて管理されます。

DocumentBroker Standard GUI Development Kitで扱うフォルダには，文書フォルダ，公開フォルダ，およびノードフォルダがあります。

フォルダ指定検索

指定したフォルダに格納されている文書を検索する方法です。

プロパティ

オブジェクトに関する付加情報です。プロパティに設定される値をプロパティ値といいます。

プロパティ検索

文書のプロパティ（作成日やファイルサイズなど）を検索条件として検索する方法です。

文書

Wordやテキストエディターなどのアプリケーションプログラムで作成したファイルの実体と，そのファイルのプロパティを合わせて文書といいます。主ファイルと関連ファイルの複数のファイルを持つことができます。また，複数の版（バージョン）を持つことができ，それぞれの版にファイルを持つことができます。文書には一般文書と公開文書があります。

文書空間

DMAオブジェクトモデルを実装するリポジトリです。

文書管理サーバ

文書の管理機能を提供するサーバです。

文書空間オブジェクト

DocumentBroker Standard GUI Development Kitの文書管理で使用する，文書空間に存在するオブジェクトの総称です。バージョンなし文書，バージョン付き文書，バージョンなしフォルダ，バージョン付きフォルダ，独立データおよびパブリックACLがあります。

文書空間アクセスオブジェクト

セッションを確立した文書空間を，概念的なオブジェクトとして扱うためのオブジェクトです。DbjDocSpaceインターフェースの機能を実行できます。

文書空間識別子

セッションを確立する文書空間を特定するための識別子です。GUID文字列で表されます。

文書種別

文書の種類を表す定義です。

文書フォルダ

一般文書を格納するフォルダのことです。文書の登録の可否が指定できます。

（マ行）

メソッド

データを操作するために定義されている方法です。Java クラスライブラリでは，インターフェースおよびクラスごとにメソッドが定義されています。

（ラ行）

例外クラス

Java クラスライブラリで発生する例外のうち，Java クラスライブラリ固有の例外を扱うクラスの総称です。java.lang.Exceptionクラスを継承しています。

レンディション

文書の実体（コンテント）の形式，およびそのコンテントを併せた概念です。

ログアウト

文書空間とのセッションを切断することです。

ログイン

文書空間とのセッションを確立することです。ログインするときには，ユーザ識別子とパスワードによる認証処理も実行されます。

ロック

排他制御を実行するために設定する，ロックの種類です。参照ロックと更新ロックがあります。

索引

[Ａ][Ｂ][Ｃ][Ｄ][Ｅ][Ｆ][Ｇ][Ｉ][Ｊ][Ｌ][Ｍ][Ｏ][Ｐ][Ｒ][Ｓ][Ｔ][Ｕ][Ｗ]
[ア行][カ行][サ行][タ行][ナ行][ハ行][マ行][ヤ行][ラ行]

(英字)

(Ａ)

ACL（Access Control List）〔用語解説〕

ACL_TYPE_PRIVATE

ACL_TYPE_PUBLIC

addcond

addCondGroup

addCondition

AND検索〔用語解説〕

API（Application Programming Interface）〔用語解説〕

(Ｂ)

begin

(Ｃ)

cancelCheckoutDoc

CAP_NOUSE

CAP_USE

changeCapacityMode

checkinDoc

checkoutDoc

commit

CORBA（Common Object Request Broker Architecture）〔用語解説〕

createDecmACLPerm

createDecmCondGroup

createDecmCondition

createDecmDoc

createDecmDocMaster

createDecmDocMasterList

createDecmDocMasterProp

createDecmDocPerm

createDecmDocProp

createDecmDocPropMaster

createDecmDocPropMasterProp

createDecmFolder

createDecmFolderPerm

createDecmFolderProp

createDecmFolderTree

createDecmSelect

createDecmSubFile

createDoc

createDocFolder

createIntCond

createNodeFolder

createPubFolder

createSession

createStrCond

(Ｄ)

DB_HIRDB

DbjDocSpaceインターフェース

DbjFactory0200クラス

DbjFactory0200クラス

DbjFactory0200クラスのメソッド一覧

DbjFactoryインターフェース

DbjFactoryインターフェース

DbjFactoryインターフェースのメソッド一覧

DbjSessionインターフェース

DbjSessionインターフェース

DbjSessionインターフェースのメソッド一覧

dbrProp_OwnerId

dbuUserProp_ModifierName

dbuUserProp_OwnerName

dbuUserProp_ReservedUserId

dbuUserProp_ReservedUserName

DecmACLPermクラス

DecmACLPermクラスのフィールド一覧

DecmACLPermクラスのメソッド一覧

DecmACLPermクラスのメソッド一覧

DecmApiAccessExceptionクラス

DecmApiACLOutOfRangeExceptionクラス

DecmApiAlreadyCheckoutExceptionクラス

DecmApiCapacityExceptionクラス

DecmApiDBExceptionクラス

DecmApiDocNotFoundExceptionクラス

DecmApiDocNumNotCorrectExceptionクラス

DecmApiExceptionクラス

DecmApiFileNotFoundExceptionクラス

DecmApiFolderNotCorrectExceptionクラス

DecmApiFolderNotFoundExceptionクラス

DecmApiInvalidDocMasterExceptionクラス

DecmApiInvalidFileExceptionクラス

DecmApiInvalidFolderクラス

DecmApiInvalidInitialExceptionクラス

DecmApiInvalidParamExceptionクラス

DecmApiInvalidPropValueExceptionクラス

DecmApiIOExceptionクラス

DecmApiLastVersionExceptionクラス

DecmApiMasterNotFoundExceptionクラス

DecmApiNotCheckoutExceptionクラス

DecmApiNotSupportクラス

DecmApiPropMasterNotFoundExceptionクラス

DecmApiReferenceExceptionクラス

DecmCommonPermクラス

DecmCommonPermクラスのメソッド一覧

DecmCommonPermクラスのメソッド一覧

DecmCommonPropクラス

DecmCommonPropクラスのメソッド一覧

DecmCommonPropクラスのメソッド一覧

DecmCondGroupクラス

DecmCondGroupクラス

DecmCondGroupクラスのフィールド一覧

DecmCondGroupクラスのメソッド一覧

DecmConditionクラス

DecmConditionクラス

DecmConditionクラスのフィールド一覧

DecmConditionクラスのメソッド一覧

DecmDBControlクラス

DecmDBControlクラス

DecmDocMasterListクラス

DecmDocMasterListクラス

DecmDocMasterListクラスで扱うプロパティ

DecmDocMasterListクラスのメソッド一覧

DecmDocMasterPropクラス

DecmDocMasterPropクラス

DecmDocMasterクラス

DecmDocMasterクラス

DecmDocMasterクラスで扱うプロパティ

DecmDocMasterクラスのメソッド一覧

DecmDocPermクラス

DecmDocPermクラス

DecmDocPropMasterPropクラス

DecmDocPropMasterPropクラス

DecmDocPropMasterクラス

DecmDocPropMasterクラス

DecmDocPropMasterクラスで扱うプロパティ

DecmDocPropMasterクラスのメソッド一覧

DecmDocPropクラス

DecmDocPropクラス

DecmDocクラス

DecmDocクラス

DecmDocクラスで扱うプロパティ

DecmDocクラスで扱うプロパティ

DecmDocクラスのメソッド一覧

DecmFactory

DecmFactoryインスタンスの作成

DecmFactoryクラス

DecmFactoryクラスのフィールド一覧

DecmFactoryクラスのメソッド一覧

DecmFactoryクラスのメソッド一覧

DecmFolderPermクラス

DecmFolderPermクラス

DecmFolderPropクラス

DecmFolderPropクラス

DecmFolderTreeクラス

DecmFolderTreeクラス

DecmFolderTreeクラスで扱うプロパティ

DecmFolderTreeクラスのメソッド一覧

DecmFolderクラス

DecmFolderクラス

DecmFolderクラスで扱うプロパティ

DecmFolderクラスのフィールド一覧

DecmFolderクラスのメソッド一覧

DecmObjectクラス

DecmObjectクラス

DecmSelectクラス

DecmSelectクラス

DecmSelectクラスで扱うプロパティ

DecmSelectクラスのフィールド一覧

DecmSelectクラスのメソッド一覧

DecmSubFileクラス

DecmSubFileクラス

DecmSubFileクラスのメソッド一覧

deleteDoc

deleteDocHistory

deleteFolder

DMA（Document Management Alliance）〔用語解説〕

dmaProp_OIID

DOC_CREATE_NG

DOC_CREATE_OK

DocumentBroker Runtime，またはDocumentBroker Development Kitの設定

DocumentBroker Standard GUI Development Kit提供のクラス一覧

DocumentBroker Standard GUI Development Kitで実現する機能

DocumentBroker Standard GUI Development Kitで使用するプロパティ

DocumentBroker Standard GUI Development Kitで使用するプロパティ一覧

DocumentBroker Standard GUI Development Kitで使用するユーザ種別

DocumentBroker Standard GUI Development Kitとは

DocumentBroker Standard GUI Development Kitの概要

DocumentBroker Standard GUI Development Kitの環境構築

DocumentBroker Standard GUI Development Kitのシステム構成

DocumentBroker Standard GUI Development Kitのシステム構成例

DocumentBroker Standard GUI Development Kitのシステム内の前提ソフトウェア

DocumentBroker Standard GUI Development Kitの前提OS

DocumentBroker Standard GUI Development Kitの前提プログラム

DocumentBroker Standard GUI Development Kitの同一装置内の前提ソフトウェア

DocumentBroker Standard GUI Development Kitのパッケージ一覧

DocumentBroker Standard GUI Development Kitパッケージが提供するクラス

DocumentBroker Standard GUI Development Kitを使用してユーザアプリケーションを開発する場合

DocumentBroker Standard GUI Development Kitを使用してユーザアプリケーションを実行する場合

DocumentBrokerで提供されるクラスライブラリ

downloadContent

downloadContent

(Ｅ)

ecmProp_AclSucceed

ecmProp_AclType

ecmProp_CapacityUnit

ecmProp_CHOiid

ecmProp_CHOiid_FULL

ecmProp_DeleteFlag

ecmProp_DeleteTime

ecmProp_DeleteUserId

ecmProp_DocCreateFlg

ecmProp_DocNumber

ecmProp_DocNumDelimiter

ecmProp_DocNumProp

ecmProp_DocNumSuffix

ecmProp_DocType

ecmProp_DocTypeOIID

ecmProp_DocTypeOIID_FULL

ecmProp_DocTypeParentCode

ecmProp_DocTypePropCode

ecmProp_DocTypePropInt1～ecmProp_DocTypePropInt10

ecmProp_DocTypePropLongStr1～ecmProp_DocTypePropLongStr5

ecmProp_DocTypePropName

ecmProp_DocTypePropStr1～ecmProp_DocTypePropStr10

ecmProp_ExtInt1

ecmProp_FileName

ecmProp_FileSize

ecmProp_FolderLevel

ecmProp_FolderType

ecmProp_Level

ecmProp_MaxCapacity

ecmProp_OpenPubACL

ecmProp_OpenPubACL_FULL

ecmProp_ParentContainer

ecmProp_ParentContainer_FULL

ecmProp_SortNumber

ecmProp_UseCapacity

ecmProp_UserInt1～ecmProp_UserInt5

ecmProp_UserStr1～ecmProp_UserStr5

edmProp_OwnerId

esysProp_Comment

esysProp_CreateTime

esysProp_Creator

esysProp_FileType

esysProp_Modifier

esysProp_ModifyTime

esysProp_Name

esysProp_TopDVOIID_FULL

(Ｆ)

fetchDocHistory

fetchDocMasterProp

fetchDocPerm

fetchDocProp

fetchFileProp

fetchFolderPerm

fetchFolderProp

fetchSubFile

(Ｇ)

getACLList

getDocMasterList

getDocPropMasterList

getEveryonePerm

getFactory

getFolderList

getIntProp

getListDocMaster

getLongProp

getNewDocMaster

getOiid

getOiid

getOiid

getOiid

getOwnerId

getOwnerName

getPermission

getSearchDocMaster

getStrProp

getSubject

getSubjectType

GUID（Gllobary Unique Idenifier）〔用語解説〕

(Ｉ)

initUserProp（文字列型）

initUserProp（文字列型以外）

isCapacityUse

isSubFileSearchMode

isSubTraceMode

(Ｊ)

Javaクラスライブラリ〔用語解説〕

Java実行環境の設定

(Ｌ)

lockRead

lockRead

lockWrite

lockWrite

login

logout

(Ｍ)

moveDoc

(Ｏ)

OIID（Object Instance Identifier）〔用語解説〕

OP_AND

OP_ENDWITH

OP_EQ

OP_GT

OP_GTEQ

OP_LT

OP_LTEQ

OP_NEQ

OP_OR

OP_PART

OP_STWITH

(Ｐ)

PERM_TYPE_GROUP

PERM_TYPE_USER

PERM_FULL

PERM_LINK

PERM_NONE

PERM_READ

PERM_UPDATE

PROP_TYPE_DAT

PROP_TYPE_INTEGER

PROP_TYPE_MASTER

PROP_TYPE_STRING

PUBFOL_ACL_TYPE_PRIVATE

PUBFOL_ACL_TYPE_PUBLIC

(Ｒ)

resetCapacityMax

resetCondition

rollback

(Ｓ)

searchDoc

setACLList

setCapacityMax

setCondGroup

setDocMaster

setDocPerm

setDocProp

setEveryonePerm

setFetchCount

setFilePath

setFilePath

setFolderMode

setFolderOiid

setFolderOiid

setFolderPerm

setFolderProp

setIntProp

setKeyword

setLongProp

setOiid

setOiid

setOiid

setOwnerId

setOwnerName

setParentOiid

setParentOiid

setParentOiid

setPermission

setRenditionType

setRenditionType

setSearchDictionary

setSearchExpanse

setSelectList

setSortKey

setSortMode

setStrProp

setSubFileList

setSubFileSearchMode

setSubject

setSubjectType

setSubTraceMode

setTextPath

setTrashMode

SORT_MODE_DOWN

SORT_MODE_UP

(Ｔ)

TRASH_MODE_ALL

TRASH_MODE_DELETED

TRASH_MODE_NORMAL

trashBackDoc

trashDoc

(Ｕ)

uCosminexusで使用する場合の設定

under

UNIT_GB

UNIT_MB

UNIT_TB

updateDocFolderProp

updateDocPerm

updateDocProp

updateFolderPerm

updateNodeFolderProp

updatePubFolderProp

(Ｗ)

Webサービス〔用語解説〕

(ア行)

(あ)

アクセス権限〔用語解説〕

案件〔用語解説〕

(い)

一般文書〔用語解説〕

イメージ文書登録サーバ〔用語解説〕

インターフェース〔用語解説〕

インターフェースの処理の流れ

(お)

オリジナルファイル〔用語解説〕

(カ行)

(か)

監査証跡ログ〔用語解説〕

関連ファイル〔用語解説〕

(き)

共通処理機能

共通操作パッケージのクラス

共通操作パッケージのコーディング例

共通操作パッケージのメソッド一覧

共通操作パッケージの例外クラス

共通パッケージ提供クラスの詳細

(く)

組み合わせ検索条件を指定した文書の検索

(け)

継承〔用語解説〕

検索結果キャッシュ〔用語解説〕

検索操作機能

検索操作パッケージ提供クラス

検索操作パッケージ提供クラスの詳細

検索操作パッケージのクラス一覧

検索操作パッケージのコーディング例

検索操作パッケージのメソッド一覧

(こ)

公開フォルダ〔用語解説〕

公開文書〔用語解説〕

コーディング時の注意事項

コーディング例

ごみ箱〔用語解説〕

ごみ箱検索〔用語解説〕

コンテント〔用語解説〕

(サ行)

(さ)

作成するコーディング例

(し)

システム管理者〔用語解説〕

主ファイル〔用語解説〕

使用するクラス，およびインターフェースの一覧

使用するメソッド一覧

使用できる文字コード種別

所有者〔用語解説〕

(す)

スーパークラス〔用語解説〕

(せ)

セッション〔用語解説〕

セッションオブジェクト〔用語解説〕

前提条件

全文検索〔用語解説〕

全文検索テキストインデクス登録サーバ〔用語解説〕

全文検索を利用した文書の検索

(そ)

属性値マスタ一覧の取得

(タ行)

(ち)

チェックアウト〔用語解説〕

チェックイン〔用語解説〕

(と)

同義語辞書〔用語解説〕

特定の文書種別マスタのOIIDの取得

トランザクション〔用語解説〕

トランザクションの開始と終了

(ナ行)

(の)

ノードフォルダ〔用語解説〕

(ハ行)

(は)

バージョニングオブジェクト〔用語解説〕

バージョンオブジェクト〔用語解説〕

パーミッション〔用語解説〕

パッケージ提供クラス，およびメソッドの説明形式

パブリックACL〔用語解説〕

(ふ)

ファクトリクラス〔用語解説〕

フォルダ〔用語解説〕

フォルダ指定検索〔用語解説〕

フォルダ操作機能

フォルダ操作パッケージ提供クラス

フォルダ操作パッケージ提供クラスの詳細

フォルダ操作パッケージのクラス一覧

フォルダ操作パッケージのコーディング例

フォルダ操作パッケージのメソッド一覧

フォルダのアクセス権限の更新・取得

フォルダの作成・削除

フォルダのプロパティの作成・更新

プロパティ〔用語解説〕

プロパティ検索〔用語解説〕

文書〔用語解説〕

文書管理サーバ〔用語解説〕

文書空間〔用語解説〕

文書空間アクセスオブジェクト〔用語解説〕

文書空間オブジェクト〔用語解説〕

文書空間オブジェクト操作時に必要なアクセス権限

文書空間オブジェクトの操作時に影響するsetterメソッド

文書空間識別子〔用語解説〕

文書種別〔用語解説〕

文書種別マスタ一覧の取得

文書種別マスタ操作パッケージ提供クラス

文書種別マスタ操作パッケージ提供クラスの詳細

文書種別マスタ操作パッケージのクラス一覧

文書種別マスタ操作パッケージのメソッド一覧

文書種別マスタの操作機能

文書種別マスタ操作パッケージのコーディング例

文書操作機能

文書操作パッケージ提供クラス

文書操作パッケージ提供クラスの詳細

文書操作パッケージのクラス

文書操作パッケージのコーディング例

文書操作パッケージのメソッド一覧

文書のアクセス権限の更新・取得

文書の移動

文書の検索

文書の作成・取得・削除

文書の状態によるメソッドの実行可否

文書のプロパティの更新・取得

文書の履歴の取得・削除・更新

文書フォルダ〔用語解説〕

文書をごみ箱へ移動したあと元に戻す

(マ行)

(ま)

マルチスレッド環境での注意事項

(め)

メソッド〔用語解説〕

メソッドで説明する項目

メソッドの関係

(ヤ行)

(よ)

用語解説

(ラ行)

(れ)

例外クラス〔用語解説〕

レンディション〔用語解説〕

(ろ)

ログアウト〔用語解説〕

ログイン〔用語解説〕

ロック〔用語解説〕

■ 商標類

Adobeは，Adobe Systems Incorporated（アドビシステムズ社）の商標です｡
CORBAは，Object Management Groupが提唱する分散処理環境アーキテクチャの名称です。
Microsoftは，米国およびその他の国における米国Microsoft Corp.の登録商標です。