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で使用するプロパティ一覧」を参照してください。