ユーザー入力パラメーターは、パラメーターオブジェクトを作成し、「addParameter()」メソッドを通して、それを高度な関数へ追加することで、「setupParameters()」内に作成されます。
| メソッド | 説明 |
addParameter(Parameter p, boolean suitableForUserPrompt) | 指定されたパラメーターを高度な関数に含めます。オプションの「suitableForUserPrompt」パラメーターを使用すると、レポート出力でのフィルターと同様に、パラメーター値を手動で指定することができます。 |
パラメーターメソッド
| パラメーターメソッド | 説明 |
| setUniqueKey | パラメーターデータへのアクセスと、依存表示の制御に使用される、このパラメーターに一意のテキストキーです。 |
| setDisplayName | テキスト名です。 |
| setDescription | テキストの説明です。 |
| setDataType | このパラメーターが返すオブジェクトの型です。 より詳細な情報は、付録のデータ型を参照してください。 |
| setAcceptsFieldType | フィールド選択（TYPE_FIELD DISPLAY_SELECT）パラメーターで選択できるフィールドの型を制限します。 より詳細な情報は、付録のデータ型を参照してください。 |
| setDisplayType | 入力パラメーターの型を表示します。 より詳細な情報は、付録の表示型を参照してください。 |
| setDefaultValue | このパラメーターのデフォルト値を設定します。「setDataType」で指定された型である必要があります。 |
| addOption | 可能な値を、「DISPLAY_SELECT」、と「DISPLAY_RADIO」パラメーターに追加します。 |
例
以下のコードは2つのパラメーターを作成します。「Column」は、レポートから任意の数値フィールドを選択するフィールド選択ドロップダウンです。演算子は、基礎的な数式演算を表す4つの値を持つドロップダウンメニューです。
protected void setupParameters()
{
Parameter p = new Parameter();
p.setUniqueKey("FIELD_SELECTION");
p.setDisplayName("Column");
p.setDescription("Compare this numeric field to the selected field");
p.setDataType(100);
p.setAcceptsFieldType(TYPE_NUMERIC, true);
p.setDisplayType(6);
addParameter(p);
p = new Parameter();
p.setUniqueKey("OPERATOR");
p.setDisplayName("Operator");
p.setDescription("Select which Operator to apply");
p.setDataType(2);
p.setDisplayType(6);
p.addOption("Add");
p.addOption("Subtract");
p.addOption("Divide");
p.addOption("Multiply");
addParameter(p);
}