表 71 に、BusObjAttr クラスのメンバー・メソッドについて要約します。
メンバー・メソッド | 説明 | ページ |
---|---|---|
BusObjAttr() | ビジネス・オブジェクト属性のオブジェクトを作成します。 | BusObjAttr() |
getAppText() | 属性のアプリケーション固有情報を取得します。 | getAppText() |
getAttrType() | 単純属性のタイプを取得します。 | getAttrType() |
getAttrTypeName() | 属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合、子ビジネス・オブジェクトのタイプを属性タイプとして取得します。 | getAttrTypeName() |
getBOVersion() | 属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合、ビジネス・オブジェクト定義のバージョン番号を取得します。 | getBOVersion() |
getCardinality() | 属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合、属性のカーディナリティーを取得します。 | getCardinality() |
getComments() | 属性に関連付けられているコメントを取得します。 | getComments() |
getDefault() | 属性のデフォルト値を取得します。 | getDefault() |
getMaxLength() | この属性の最大長を取得します。 | getMaxLength() |
getName() | 属性の名前を取得します。 | getName() |
getRelationType() | 属性の関係タイプ (属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合は containment) を取得します。 | getRelationType() |
isForeignKey() | この属性がビジネス・オブジェクトの外部キーの一部となっているかどうかを判別します。 | isForeignKey() |
isKey() | この属性がビジネス・オブジェクトのキーの一部となっているかどうかを判別します。 | isKey() |
isRequiredKey() | この属性がビジネス・オブジェクトの必須キーの一部となっているかどうかを判別します。 | isRequiredKey() |
isRequiredServerBound() | ビジネス・オブジェクトがトリガー・イベントを表すときに属性を必要とするかどうかを判別します。 | isRequiredServerBound() |
isSimpleType() | 属性が単純タイプ (例えば、String、Integer、Float など) かどうかを判別します。あるいは、属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクトの配列を表すかどうかを判別します。 | isSimpleType() |
setAppText() | 属性のアプリケーション固有情報を設定します。 | setAppText() |
setAttrType() | 属性のタイプを設定します。 | setAttrType() |
setBOVersion() | 属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合、属性で表される子ビジネス・オブジェクトまたはオブジェクトのバージョンを設定します。 | setBOVersion() |
setCardinality() | 属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合、属性のカーディナリティーを設定します。 | setCardinality() |
setComments() | 属性に関連付けられているコメントを設定します。 | setComments() |
setDefault() | 属性のデフォルト値を設定します。 | setDefault() |
setIsForeignKey() | 属性を、その属性が外部キーの一部となっているかどうかを示す Boolean 値に設定します。 | setIsForeignKey() |
setIsKey() | 属性を、その属性がキーの一部となっているかどうかを示す Boolean 値に設定します。 | setIsKey() |
setIsRequiredKey() | 属性を、その属性が必須キーの一部となっているかどうかを示す Boolean 値に設定します。 | setIsRequiredKey() |
setMaxLength() | 属性の最大長を設定します。 | setMaxLength() |
setName() | 属性の名前を設定します。 | setName() |
setRelationType() | 属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合、属性の関係タイプを containment に設定します。 | setRelationType() |
ビジネス・オブジェクト属性のオブジェクトを新規に作成します。
構文
public BusObjAttr(String name, int type);
public BusObjAttr(String name, int type, String typeName);
public BusObjAttr(String name, int type, String typeName, boolean isKey, boolean isForeignKey, boolean isReqd, String appSpecInfo, int maxLen String defaultValue, String BOversion, String cardinality, String relType, boolean isReqdServerBound, String comments);
パラメーター
戻り値
新規にインスタンス化された BusObjAttr オブジェクト。
構文
public String getAppText();
パラメーター
なし。
戻り値
属性のアプリケーション固有情報が格納されている String。
参照
構文
public int getAttrType();
パラメーター
なし。
戻り値
属性のタイプを表す整数。この整数値を属性タイプ定数の 1 つと比較します。
参照
getAttrTypeName(), setAttrType()
構文
public String getAttrTypeName();
パラメーター
なし。
戻り値
子ビジネス・オブジェクト (属性に子ビジネス・オブジェクトが含まれている場合) のタイプであるビジネス・オブジェクト定義の名前が格納されている String。
注記
getAttrTypeName() メソッドは、子ビジネス・オブジェクトの属性タイプの名前を取得します。
属性が子ビジネス・オブジェクト (または子ビジネス・オブジェクトの配列) を表している場合、その属性の属性タイプは BusObjAttrType.OBJECT であり、属性タイプの名前は子ビジネス・オブジェクトのビジネス・オブジェクト定義の名前です。
参照
属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合、ビジネス・オブジェクト定義のバージョン番号を取得します。
構文
public String getBOVersion();
パラメーター
なし。
戻り値
属性によって表される子ビジネス・オブジェクト定義のバージョン番号が格納されている String。
参照
属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合、属性のカーディナリティーを取得します。
構文
public String getCardinality();
パラメーター
なし。
戻り値
子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す属性のカーディナリティーが格納されている String。このストリング値を以下のカーディナリティー定数と比較します。
参照
構文
public String getComments();
パラメーター
なし。
戻り値
構文
public String getDefault();
パラメーター
なし。
戻り値
属性のデフォルト値が格納されている String。
参照
構文
public int getMaxLength();
パラメーター
なし。
戻り値
属性値の最大長を表す整数。
参照
構文
public String getName();
パラメーター
なし。
戻り値
属性の名前が格納されている String。
参照
属性の関係タイプ (属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合は containment) を取得します。
構文
public String getRelationType();
パラメーター
なし。
戻り値
子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す属性の関係タイプ (「containment」) が格納されている String。
参照
この属性がビジネス・オブジェクトの外部キーの一部となっているかどうかを判別します。
構文
public boolean isForeignKey();
パラメーター
なし。
戻り値
属性が外部キー、または外部キーの一部となっている場合は true を戻します。それ以外の場合は false を戻します。
参照
この属性がビジネス・オブジェクトの基本キーの一部となっているかどうかを判別します。
構文
public boolean isKey();
パラメーター
なし。
戻り値
属性がキー、またはそのキーの一部となっている場合は true を戻します。それ以外の場合は false を戻します。
参照
この属性がビジネス・オブジェクトの必須キーの一部となっているかどうかを判別します。
構文
public boolean isRequiredKey();
パラメーター
なし。
戻り値
属性が必須キー、または必須キーの一部となっている場合は true を戻します。それ以外の場合は false を戻します。
参照
ビジネス・オブジェクトがトリガー・イベントを表すときに属性を必要とするかどうかを判別します。
構文
public boolean isRequiredServerBound();
パラメーター
なし。
戻り値
ビジネス・オブジェクトがコラボレーション・オブジェクト要求を表す場合に、属性が必要であれば true、それ以外の場合は false を戻します。
属性が単純タイプ (例えば、String、Integer、Float など) かどうかを判別します。あるいは、属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクトの配列を表すかどうかを判別します。
構文
public boolean isSimpleType();
パラメーター
なし。
戻り値
属性が単純タイプである場合は true、それ以外の場合は false。
参照
構文
public void setAppText(String appInfo);
パラメーター
戻り値
なし。
参照
構文
public void setAttrType(int type);
public void setAttrType(int type, String typeName);
パラメーター
BusObjAttrType.BOOLEAN BusObjAttrType.CIPHERTEXT BusObjAttrType.DATE BusObjAttrType.DOUBLE BusObjAttrType.FLOAT BusObjAttrType.INTEGER BusObjAttrType.LONGTEXT BusObjAttrType.OBJECT BusObjAttrType.STRING
戻り値
なし。
例外
type が無効な場合、つまり、属性タイプ定数で表される値の 1 つに該当しない場合、スローされます。
注記
setAttrType() メソッドには、以下の構文形式があります。
参照
getAttrType(), getAttrTypeName()
関連する参照情報については、BusObjAttrType インターフェースおよび ODKException クラスを参照してください。
属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合、ビジネス・オブジェクト定義のバージョン番号を設定します。
構文
public void setBOVersion(String version);
パラメーター
戻り値
なし。
参照
属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合、属性のカーディナリティーを設定します。
構文
public void setCardinality(String cardinality);
パラメーター
BusObjAttr.CARD_SINGLE BusObjAttr.CARD_MULTIPLE
戻り値
なし。
例外
cardinality が有効な値でない場合、つまり、有効なカーディナリティー定数が指定されていない場合にスローされます。
参照
構文
public void setComments(String comment);
パラメーター
戻り値
なし。
参照
構文
public void setDefault(String defaultValue);
パラメーター
戻り値
なし。
参照
属性が外部キーの一部となっているかどうかを示す属性プロパティーを設定します。
構文
public void setIsForeignKey(boolean fKey);
パラメーター
戻り値
なし。
参照
属性が基本キーの一部となっているかどうかを示す属性プロパティーを設定します。
構文
public void setIsKey(boolean key);
パラメーター
戻り値
なし。
参照
属性を、その属性が必須キーの一部となっているかどうかを示す Boolean 値に設定します。
構文
public void setIsRequiredKey(boolean isReqd);
パラメーター
戻り値
なし。
参照
構文
public void setMaxLength(int maxLength);
パラメーター
戻り値
なし。
例外
最大長が maxLength < 0 または maxLength > 2^31-1 に該当する場合、スローされます。
参照
構文
public void setName(String name);
パラメーター
戻り値
なし。
参照
属性が子ビジネス・オブジェクトまたは子ビジネス・オブジェクト配列を表す場合、属性の関係タイプを containment に設定します。
構文
public void setRelationType(String relType);
パラメーター
戻り値
なし。
参照