WSAttributeMetadata

WSAttributeMetadata は、特定の型付き属性のデータに関する情報、例えば値データ型、 ローカライズされたテキスト (表示名、説明、プロンプトなど)、 そのデフォルト値、暗黙的値の範囲、選択タイプ、オプション (単一または複数選択の場合) などを定義します。属性の場合と同様に、属性メタデータは型設定されています。例えば WSDecimalAttribute myNumber には WS DecimalAttributeMetadata がバインドされている必要があり、 属性値、メタデータのデフォルト値、可能なオプション値を含むすべての値には Double 型が設定されます。

説明、ラベル、および他の属性メタデータのテキストは、ローカライズされます。 ただし、ユーザー指定のテキストはユーザーが入力した状態でのみ表示されることがあります。各 API 呼び出しには、クライアント・コードが、 特定のユーザーがローカライズされたメッセージの表示を希望する場合のロケールを定義するために使用できる、要求されたロケールが含まれます。要求に応じるために、通常の Java™ ロケール・フォールバック・ポリシーが使用されます。

WSAttributeMetadata には、以下のフィールドが含まれます。

• name: 標準またはカスタムの属性名。また、このメタデータにバインドされる属性によって使用される名前。標準属性はシステムによって定義され、予約名スペースに標準名が入っています (つまり、「uac」プレフィックスを使用します)。 カスタム名は他の任意の命名規則を使用できます。
  注: 属性名は一意である必要があり、ローカライズされず、長さ制限 (文字コンテンツとデータベースに依存する) があります。名前には大/小文字の区別がなく、Unicode 文字、数字、および下線文字「_」の任意の組み合わせで構成できますが、先頭を数字にすることはできません。
• description: 属性のオプションの説明。ツールチップや他のユーザー・インターフェースを表示するために適しています。
• Predicates: 属性について説明する、以下に示すようなさまざまな述部。
  • isRequired: 属性が必須の場合には true。
  • isInternal: 属性がシステムによって定義され、内部使用に限定される (ユーザーには表示されない) 場合は true。
  • isGenerated: ターゲット・セル・コードなど、 属性の値がコンポーネントの作成時に IBM® Campaign によって自動生成される場合は true。通常、生成される値の accessTypeEnum は READ_ONLY となります。
  • hasOptions: 属性にオプションがある場合は true。このメタデータに対してオプションが定義されていることと、selectTypeEnum が SINGLE_SELECT または MULTIPLE_SELECT であることが暗黙に示されます。
• typeEnum: 属性のタイプを定義する WSAttributeTypeEnum。STANDARD や CUSTOM など。
• statusEnum: 属性のステータスを定義する WSAttributeStatusEnum。ACTIVE など。
• accessTypeEnum: 属性値へのアクセス権限のタイプを定義する WSAccessTypeEnum。READ_ONLY など。
• selectTypeEnum: 属性に使用される選択のタイプを定義する WSAccessTypeEnum。SINGLE など。キャンペーンおよびセル属性の場合、またはオプションが指定されない場合には、NONE でなければなりません。
• componentTypeEnum: API によって公開されるすべての可能なキャンペーン・コンポーネントの WSComponentTypeEnum。CAMPAIGN、FOLDER など。
• defaultValue (フローチャートのみ): 属性のタイプのデフォルト値 (オプション)。この値は、具象属性メタデータ・クラスによって提供されます。 例えば、WSTextAttributeMetadata のデフォルト値のタイプは文字列となります。(属性値に関する説明を参照してください)。フローチャート以外のコンポーネントについては、デフォルト値は定義されません。
• options: この属性のオプションのリスト (オプション)。属性の複数のオプションを一緒に指定することにより、その属性の暗黙的値のセットを正確に定義できます。 各オプションは型指定されているので、例えば WSTextAttributeMetadata には WSTextAttributeOption だけをバインドできます。

各オプションは、以下を定義します。

• prompt: プルダウン・メニューに適したオプションのプロンプト。性別属性のオプションとして「男性」など。メタデータのプロンプトとは異なり、オプションの表示名には句読点が通常含まれません。
• description: オプションのローカライズされた説明。「性別が男性の人」など。ツールチップのテキストに適しています。
• isDefault: この特定のオプションがデフォルトの場合は true。MULTIPLE_SELECT 選択タイプでは、複数のオプションをデフォルトとしてマーク付けできます。
• value: 型付きのオプションの値。属性メタデータ defaultValue と同様に、この値は具象オプション・サブクラスによって提供されます。 例えば、WSDecimalAttributeOption's 値の型は Decimal です。(属性値に関する説明を参照してください)。上記の性別の例を続けると、値は文字列｢m｣で宣言すること (WSTextAttributeOption)、 または数字コード 123 で宣言すること (WSDecimalAttributeOption) ができます。