ContentItemDefinition (PEXA API Document)

すべてのスーパーインタフェース:

Definition

既知の実装クラスのリスト:

XMLContentItemDefinition
```
public interface ContentItemDefinition
extends Definition
```
Content項目に対する定義を表すインタフェース

バージョン:

$Revision: 6627 $ $Date:: 2011-09-17 12:46:24 #$

作成者:

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`ACCESS_HIDDEN` accessで指定できる値(hidden) コンポーネント側からはアクセスできない内部項目を表す
`static int`	`ACCESS_INOUT` accessで指定できる値(inout) 入出力できる項目を表す
`static int`	`ACCESS_INPUT` accessで指定できる値(input) 入力のみできる項目を表す
`static int`	`ACCESS_OUTPUT` accessで指定できる値(output) 出力のみできる項目を表す
`static java.lang.String`	`ATTR_Access` 属性値のキー(アクセス種別)
`static java.lang.String`	`ATTR_ItemID` 属性値のキー(項目ID)
`static java.lang.String`	`ATTR_Scope` 属性値のキー(有効範囲)
`static java.lang.String`	`ATTR_Type` 属性値のキー(項目種別)
`static int`	`SCOPE_GLOBAL` scopeで指定できる値(global) 有効範囲が全体であることを表す
`static int`	`SCOPE_GROUP` scopeで指定できる値(group) 有効範囲が画面遷移グループ内であることを表す
`static int`	`SCOPE_LOCAL` scopeで指定できる値(local) 有効範囲がそのコンテント内のみであることを表す
`static int`	`TYPE_BINARY` typeで指定できる値(binary) この項目がデータモデルを指していることを表す
`static int`	`TYPE_MODEL` typeで指定できる値(model) この項目がデータモデルを指していることを表す
`static int`	`TYPE_VALUE` typeで指定できる値(value) この項目が値を指していることを表す

インタフェースから継承されたフィールド pexa.client.std.definition.Definition
ATTR_Definition, ATTR_DefinitionOwner

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`checkAccess(int access)` コンテント項目のアクセス種別を判定する。
`boolean`	`checkScope(int scope)` コンテント項目のスコープを判定する。
`boolean`	`checkType(int type)` コンテント項目の種別を判定する。
`boolean`	`containsOption(java.lang.String optionName)` 指定された名前のオプション設定があるかを判定する
`int`	`getAccess()` コンテント項目のアクセス種別を取得する。
`java.lang.Class`	`getItemTypeClass()` コンテント項目の型を表すクラスオブジェクトを取得する
`Option[]`	`getOption(java.lang.String optionName)` コンテント項目のオプション設定情報を取得する
`PhenomenonType`	`getPhenomenonType()` コンテント項目が現象型に紐付く場合、現象型スキーマを取得できる。
`int`	`getScope()` コンテント項目のスコープを取得する。
`Option`	`getSingleOption(java.lang.String optionName)` コンテント項目のオプション設定情報を取得する
`int`	`getType()` コンテント項目の種別を取得する。
`boolean`	`isPreferenceSave()` コンテント項目をPreferenceに保存するかを判定する
`boolean`	`isSingle()` コンテント項目の単複を判定する

インタフェースから継承されたメソッド pexa.client.std.definition.Definition
containsAttribute, getAttribute, getAttribute

- フィールドの詳細
  - ATTR_ItemID
```
static final java.lang.String ATTR_ItemID
```
    属性値のキー(項目ID)
    
    関連項目:
    
    定数フィールド値
  - ATTR_Access
```
static final java.lang.String ATTR_Access
```
    属性値のキー(アクセス種別)
    
    関連項目:
    
    定数フィールド値
  - ATTR_Type
```
static final java.lang.String ATTR_Type
```
    属性値のキー(項目種別)
    
    関連項目:
    
    定数フィールド値
  - ATTR_Scope
```
static final java.lang.String ATTR_Scope
```
    属性値のキー(有効範囲)
    
    関連項目:
    
    定数フィールド値
  - ACCESS_INPUT
```
static final int ACCESS_INPUT
```
    accessで指定できる値(input) 入力のみできる項目を表す
    
    関連項目:
    
    定数フィールド値
  - ACCESS_OUTPUT
```
static final int ACCESS_OUTPUT
```
    accessで指定できる値(output) 出力のみできる項目を表す
    
    関連項目:
    
    定数フィールド値
  - ACCESS_INOUT
```
static final int ACCESS_INOUT
```
    accessで指定できる値(inout) 入出力できる項目を表す
    
    関連項目:
    
    定数フィールド値
  - ACCESS_HIDDEN
```
static final int ACCESS_HIDDEN
```
    accessで指定できる値(hidden) コンポーネント側からはアクセスできない内部項目を表す
    
    関連項目:
    
    定数フィールド値
  - SCOPE_LOCAL
```
static final int SCOPE_LOCAL
```
    scopeで指定できる値(local) 有効範囲がそのコンテント内のみであることを表す
    
    関連項目:
    
    定数フィールド値
  - SCOPE_GROUP
```
static final int SCOPE_GROUP
```
    scopeで指定できる値(group) 有効範囲が画面遷移グループ内であることを表す
    
    関連項目:
    
    定数フィールド値
  - SCOPE_GLOBAL
```
static final int SCOPE_GLOBAL
```
    scopeで指定できる値(global) 有効範囲が全体であることを表す
    
    関連項目:
    
    定数フィールド値
  - TYPE_VALUE
```
static final int TYPE_VALUE
```
    typeで指定できる値(value) この項目が値を指していることを表す
    
    関連項目:
    
    定数フィールド値
  - TYPE_MODEL
```
static final int TYPE_MODEL
```
    typeで指定できる値(model) この項目がデータモデルを指していることを表す
    
    関連項目:
    
    定数フィールド値
  - TYPE_BINARY
```
static final int TYPE_BINARY
```
    typeで指定できる値(binary) この項目がデータモデルを指していることを表す
    
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - checkAccess
```
boolean checkAccess(int access)
```
    コンテント項目のアクセス種別を判定する。
    
    パラメータ:
    
    access - ACCESS_INPUT,ACCESS_OUTPUT,ACCESS_INOUT,ACCESS_HIDDENのいずれか
    
    戻り値:
    
    引数で指定した種別であればtrue、違うならfalse
  - getAccess
```
int getAccess()
```
    コンテント項目のアクセス種別を取得する。
    
    戻り値:
    
    ACCESS_INPUT,ACCESS_OUTPUT,ACCESS_INOUT,ACCESS_HIDDENのいずれか
  - checkType
```
boolean checkType(int type)
```
    コンテント項目の種別を判定する。
    
    パラメータ:
    
    type - TYPE_VALUE, TYPE_MODELのいずれか
    
    戻り値:
    
    引数で指定した種別であればtrue、違うならfalse
  - getType
```
int getType()
```
    コンテント項目の種別を取得する。
    
    戻り値:
    
    TYPE_VALUE, TYPE_MODELのいずれか
  - checkScope
```
boolean checkScope(int scope)
```
    コンテント項目のスコープを判定する。
    
    パラメータ:
    
    scope - SCOPE_LOCAL, SCOPE_GROUP, SCOPE_GLOBALのいずれか
    
    戻り値:
    
    引数で指定したスコープであればtrue、違うならfalse
  - getScope
```
int getScope()
```
    コンテント項目のスコープを取得する。
    
    戻り値:
    
    SCOPE_LOCAL, SCOPE_GROUP, SCOPE_GLOBALのいずれか
  - isSingle
```
boolean isSingle()
```
    コンテント項目の単複を判定する
    
    戻り値:
    
    単値ならtrue、複値ならfalse
  - getOption
```
Option[] getOption(java.lang.String optionName)
```
    コンテント項目のオプション設定情報を取得する
    
    パラメータ:
    
    optionName - オプション名
    
    戻り値:
    
    オプション情報の配列
  - getSingleOption
```
Option getSingleOption(java.lang.String optionName)
```
    コンテント項目のオプション設定情報を取得する
    
    パラメータ:
    
    optionName - オプション名称
    
    戻り値:
    
    オプション定義
  - containsOption
```
boolean containsOption(java.lang.String optionName)
```
    指定された名前のオプション設定があるかを判定する
    
    パラメータ:
    
    optionName - オプション名称
    
    戻り値:
    
    あればtrue、なければfalse
  - getPhenomenonType
```
PhenomenonType getPhenomenonType()
```
    コンテント項目が現象型に紐付く場合、現象型スキーマを取得できる。
    
    戻り値:
    
    現象型スキーマ。なければnull。
  - getItemTypeClass
```
java.lang.Class getItemTypeClass()
```
    コンテント項目の型を表すクラスオブジェクトを取得する
    
    戻り値:
    
    型を表すクラスオブジェクト
  - isPreferenceSave
```
boolean isPreferenceSave()
```
    コンテント項目をPreferenceに保存するかを判定する
    
    戻り値:
    
    保存するならtrue

インタフェース ContentItemDefinition

フィールドのサマリー

インタフェースから継承されたフィールド pexa.client.std.definition.Definition

メソッドのサマリー

インタフェースから継承されたメソッド pexa.client.std.definition.Definition

フィールドの詳細

ATTR_ItemID

ATTR_Access

ATTR_Type

ATTR_Scope

ACCESS_INPUT

ACCESS_OUTPUT

ACCESS_INOUT

ACCESS_HIDDEN

SCOPE_LOCAL

SCOPE_GROUP

SCOPE_GLOBAL

TYPE_VALUE

TYPE_MODEL

TYPE_BINARY

メソッドの詳細

checkAccess

getAccess

checkType

getType

checkScope

getScope

isSingle

getOption

getSingleOption

containsOption

getPhenomenonType

getItemTypeClass

isPreferenceSave