2.2.12 createSessionJava クラスライブラリのセッションオブジェクトの作成

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

(1) 機能

指定した文書空間に対するJava クラスライブラリのセッションオブジェクトを作成し,そのインターフェース(DbjSessionインターフェース)を取得します。ただし,DbjSessionインターフェースを取得した時点では文書空間にアクセスしません。

形式1では,セッションを開始する文書空間の文書空間識別子を指定します。形式2では,動作環境定義ファイルに指定したデフォルト文書空間(コンフィギュレーションキーはDefaultDocSpaceId)に接続するためのセッションオブジェクトを作成し,そのインターフェース(DbjSessionインターフェース)を取得します。

(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を指定した場合