Prompt構造体

PromptsObjectModel構造体

PromptsObjectModel構造体を使用して、プロンプトのオブジェクト・モデルを指定します。

PromptsObjectModel構造体は、getPromptElements()メソッドで使用します。

PromptsObjectModel構造体のフィールド

フィールド	説明
String name	プロンプトの名前を指定します。
String description	プロンプトの説明を指定します。
String scope	プロンプトのスコープを指定します。
String subjectArea	プロンプトのサブジェクト・エリアを指定します。
String layout	プロンプトのレイアウトを指定します。
PromptCollectionRunTimeInfo runTimeInfo	プロンプト・コレクションの実行時間情報を指定します。
PromptStepObjectModel promptStepObj	プロンプト状態のオブジェクト・モデルを指定します。

PromptCollectionRunTimeInfo構造体

PromptCollectionRunTimeInfo構造体を使用して、プロンプト・コレクションの実行時間情報を指定します。

PromptCollectionRunTimeInfo構造体は、getPromptElements()メソッドで使用します。

PromptCollectionRunTimeInfo構造体のフィールド

フィールド	説明
String collectionID	プロンプトのコレクションIDを指定します。
String viewStatePath	プロンプトのビュー状態パスを指定します。
Int currentStep	プロンプトの現在のステップを指定します。
Boolean reloadInline	プロンプトをインラインで再ロードするか(true)、否か(false)を指定します。
Boolean supportAutoComplete	プロンプトを自動的に完了するか(true)、否か(false)を指定します。
Boolean showReturnLink	プロンプトでReturnリンクを表示するか(true)、否か(false)を指定します。
String currentAction	プロンプトの現在のアクションを指定します。

PromptStepObjectModel構造体

PromptStepObjectModel構造体を使用して、プロンプトのステップ・オブジェクト・モデルを指定します。

PromptStepObjectModel構造体は、getPromptElements()メソッドで使用します。

PromptStepObjectModel構造体のフィールド

フィールド	説明
String title	プロンプトのタイトルを指定します。
String instruction	プロンプトの指示を指定します。
String buttonsPosition	プロンプトのボタンの位置を指定します。
String labelPosition	プロンプトのラベルの位置を指定します。
String wrapLabelText	プロンプトのラップ・ラベル・テキストを指定します。
String customWidthUsage	プロンプトのカスタム幅の使用方法を指定します。
String customWidthWidth	プロンプトのカスタム幅を指定します。
String setWidthToAllPrompts	幅をすべてのプロンプトに適用するかどうかを指定します。
Boolean autoApplyPrompt	プロンプトを自動的に適用するか(true)、否か(false)を指定します。
Boolean showResetButton	プロンプトが「リセット」ボタンを表示するか(true)、否か(false)を指定します。
PromptStepRunTimeInfo runTimeInfo (nillable)	プロンプト・ステップの実行時間情報を指定します。nullを指定できる。
IndividualPromptObjectModel[] promptObj	プロンプト・オブジェクト・モデルの配列を指定します。

PromptStepRunTimeInfo構造体

PromptStepRunTimeInfo構造体を使用して、プロンプトのステップ実行時間情報を指定します。

PromptStepRunTimeInfo構造体は、getPromptElements()メソッドで使用します。

PromptStepRunTimeInfo構造体のフィールド

フィールド	説明
Boolean applyToAllSteps	プロンプトをすべてのステップに適用するか(true)、否か(false)を指定します。
Boolean autoApplyPrompt	プロンプトを自動的に適用するか(true)、否か(false)を指定します。
Boolean showResetButton	プロンプトで「リセット」ボタンを表示するか(true)、否か(false)を指定します。
Int remaininglRequiredPromptsOnSubsequentSteps	後続のステップに必要なプロンプトを指定します。
Int firstPromptStartIndex	最初のプロンプトの索引を指定します。

IndividualPromptObjectModel構造体

IndividualPromptObjectModel構造体を使用して、プロンプトのプロンプト・オブジェクト・モデルを指定します。

IndividualPromptObjectModel構造体は、getPromptElements()メソッドで使用します。

IndividualPromptObjectModel構造体のフィールド

フィールド	説明
String label	プロンプトのラベルを指定します。
String description	プロンプトの説明を指定します。
String type	プロンプトのタイプを指定します。
String subjectArea	プロンプトのサブジェクト・エリアを指定します。
Boolean placedOnNewColumn	プロンプトが新しい列に適用されるか(true)、否か(false)を指定します。
Boolean required	プロンプトが必要か(true)、否か(false)を指定します。
String formulaExprString	プロンプトの算式を指定します。
String promptUIControlType	プロンプトのユーザー・インタフェース・コントロール・タイプを指定します。
String promptOperator	プロンプト演算子を指定します。
String customWidthUsage	プロンプトのカスタム幅の使用方法を指定します。
String customWidthWidth	プロンプトのカスタム幅を指定します。
String setPromptVariableType	プロンプトのプロンプト変数タイプを指定します。
String setVariableName	プロンプトの変数名を指定します。
IndividualPromptRunTimeInfoLimitedByInfo limitedByInfo	プロンプトの制限情報を指定します。
IndividualPromptRunTimeInfo runTimeInfo	プロンプトの実行時間情報を指定します。

IndividualPromptRunTimeInfoLimitedByInfo構造体

IndividualPromptRunTimeInfoLimitedByInfo構造体を使用して、プロンプトの実行時間制限情報を指定します。

IndividualPromptRunTimeInfoLimitedByInfo構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoLimitedByInfo構造体のフィールド

フィールド	説明
String limitedByType	プロンプトがnone、allPromptsおよびspecificPromptsなどの他のプロンプト・タイプで制限されるかどうかを指定します。
Boolean isLimitedByNotApplied	制約がプロンプトに適用されるか(true)、否か(false)を指定します。
IndividualPromptRunTimeInfoLimitedByPromptRefGroups specificPrompts	このプロンプトを制限するプロンプトを指定します。

IndividualPromptRunTimeInfo構造体

IndividualPromptRunTimeInfo構造体を使用して、プロンプトの実行時間情報を指定します。

IndividualPromptRunTimeInfo構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfo構造体のフィールド

フィールド	説明
Int promptID	プロンプトIDを指定します。
Boolean allowUserTypeValues	ユーザーにプロンプトの値の入力を許可するか(true)、否か(false)を指定します。
Boolean allowAutoComplete	プロンプトを自動的に完了するか(true)、否か(false)を指定します。
Boolean multiSelect	プロンプトで複数の選択を許可するか(true)、否か(false)を指定します。
String showSearch	プロンプトの検索を表示することを指定します。
IndividualPromptRunTimeInfoDataType dataType	プロンプトのデータ型情報を指定します。詳細は、「IndividualPromptRunTimeInfoDataType構造体」を参照してください。
IndividualPromptRunTimeInfoCurrentValues currentValues	プロンプトの現在値を指定します。詳細は、「IndividualPromptRunTimeInfoCurrentValues構造体」を参照してください。
IndividualPromptRunTimeInfoAvailableOptions availableOptions	プロンプトに使用できるオプションを指定します。詳細は、「IndividualPromptRunTimeInfoAvailableOptions構造体」を参照してください。
IndividualPromptRunTimeInfoAdditionalAttributes attributes	プロンプトの追加属性を指定します。詳細は、「IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体」を参照してください。

IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo構造体

IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo構造体を使用して、プロンプトの表示列の階層レベルのSQL情報を指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo構造体のフィールド

フィールド	説明
String displayFormula	プロンプトの表示式を指定します。
String sqlFormula	プロンプトのSQL式を指定します。
String dataType	プロンプトのデータ型を指定します。
String category	プロンプトのカテゴリを指定します。
String primaryType	プロンプトのプライマリ・タイプを指定します。
Boolean nullable	プロンプトでNull値可能値を表示するか(true)、否か(false)を指定します。
Boolean isMeasure	TRUEに設定されている場合、プロンプトはメジャーを表示します。FALSEに設定されている場合、プロンプトは属性を表示します。
String aggType	プロンプトの集計タイプを指定します。
String aggRule	プロンプトの集計ルールを指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo構造体

IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo構造体を使用して、階層列に基づいてプロンプトのレベル情報を指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo構造体のフィールド

フィールド	説明
String levelID	プロンプトのレベルIDを指定します。
String displayName	プロンプトの表示名を指定します。
String displayFormula	プロンプトの表示式を指定します。
String sqlFormula	プロンプトのSQL式を指定します。
Boolean isDoubleColumn	プロンプトで二重列を表示するか(true)、否か(false)を指定します。
IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo keyColumnInfo	プロンプト列が階層レベルである場合にプロンプトのキー列の階層レベルのSQL情報を指定します。
IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo displayColumnInfo	プロンプト列が階層レベルである場合にプロンプトの表示列の階層レベルのSQL情報を指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyLevels構造体

IndividualPromptRunTimeInfoDataTypeHierarchyLevels構造体を使用して、階層列に基づいてプロンプトのレベルを指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyLevels構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoDataTypeHierarchyLevels構造体のフィールド

フィールド	説明
IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo [] levelInfo	階層列に基づいてプロンプトのレベル情報の配列を指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels構造体

IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels構造体を使用して、階層列に基づいてプロンプトのメタデータ/式情報を指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels構造体のフィールド

フィールド	説明
String subjectArea	プロンプトのサブジェクト・エリアを指定します。
String dimensionID	プロンプトのディメンションを指定します。
String tableName	プロンプトの表名を指定します。
String hierarchyID	プロンプトの階層IDを指定します。
String displayName	プロンプトの表示名を指定します。
String tableDisplayName	プロンプトの表の表示名を指定します。
String hierarchyDisplayName	プロンプトの階層表示名を指定します。
String sqlFormulaIn2Parts	プロンプトの2つの部分のSQL式を指定します。
String sqlFormulaDisplaySubjectAreaPart	SQL式のサブジェクト・エリア部分を指定します。
IndividualPromptRunTimeInfoDataTypeHierarchyLevelsレベル	階層列に基づいてプロンプトのレベルを指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体

IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体を使用して、階層列に基づいてプロンプトの階層情報を指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体のフィールド

フィールド	説明
String hierarchyID	プロンプトの階層IDを指定します。
String dimensionID	プロンプトのディメンションIDを指定します。
String tableName	プロンプトの表名を指定します。
IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels formulaLevels	階層列に基づいてプロンプトのメタデータ/式情報を指定します。

IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo構造体

IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo構造体を使用して、二重列に基づいてプロンプトの情報を指定します。

IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo構造体のフィールド

フィールド	説明
String codeColumnFormula	プロンプトのコード列式を指定します。
String codeColumnCategory	プロンプトのコード列カテゴリを指定します。
String codeColumnPrimaryType	プロンプトの列プライマリ・タイプのコードを指定します。
String codeColumnDBPrimaryType	プロンプトのデータベース・プライマリ・タイプのコードを指定します。
Boolean enableDoubleColumnInput	プロンプトで二重列の入力を有効にするか(true)、否か(false)を指定します。
String codeColumnLabel (nillable)	プロンプトのコード列のラベルを指定します。
Boolean selectedByCodeValue	プロンプト入力がコード値であるか(true)、否か(false)を指定します。

IndividualPromptRunTimeInfoDataType構造体

IndividualPromptRunTimeInfoDataType構造体を使用して、プロンプトのデータ型情報を指定します。

IndividualPromptRunTimeInfoDataType構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoDataType構造体のフィールド

フィールド	説明
String subjectArea	プロンプトのサブジェクト・エリアを指定します。
String displayColumnFormula	プロンプトの列式を指定します。
String displayColumnCategory	プロンプトの列カテゴリを指定します。
String displayColumnPrimaryType	プロンプトの列プライマリ・タイプを指定します。
String displayColumnDBPrimaryType	プロンプトの列データベース・プライマリ・タイプを指定します。
Boolean isMeasureColumn	TRUEに設定されている場合、レポート列はメジャーです。FALSEに設定されている場合、レポート列は属性です。
String displayTimeZone	プロンプトのタイム・ゾーンを指定します。
Int dataTimeZoneOffset	プロンプトのデータ・タイム・ゾーン・オフセットを指定します。
Int displayToDataOffset	プロンプトのデータ・オフセットを指定します。
String promptSourceDataType	プロンプト表示列のソース・データ型を指定します。
Boolean isHierarchy	プロンプト列が階層列であるか(true)、否か(false)を指定します。
IndividualPromptRunTimeInfoDataTypeHierarchyInfo hierarchyInfo (nillable)	階層列に基づいてプロンプトの階層情報を指定します。nullを指定することができます。
Boolean isDoubleColumnInput	プロンプト入力が二重列であるか(true)、否か(false)を指定します。
IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo codeColumnInfo (nillable)	二重列に基づいてプロンプトのコード列情報を指定します。nullを指定することができます。

IndividualPromptRunTimeInfoSingleValueType構造体

IndividualPromptRunTimeInfoSingleValueType構造体を使用して、プロンプトに1つの値を指定します。

IndividualPromptRunTimeInfoSingleValueType構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoSingleValueType構造体のフィールド

フィールド	説明
String eType	構造体の値のタイプを指定します。たとえば、SQL、customGroup、hierarchyLevelsなどです。
String caption	プロンプトのキャプションを指定します。
String codeValue	プロンプトのコード値を指定します。

IndividualPromptRunTimeInfoValuesType構造体

IndividualPromptRunTimeInfoValuesType構造体を使用して、プロンプトで使用されるすべての値を指定します。

IndividualPromptRunTimeInfoValuesType構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoValuesType構造体のフィールド

フィールド	説明
IndividualPromptRunTimeInfoSingleValueType[] value	プロンプトの単一値の配列を指定します。

IndividualPromptRunTimeInfoCurrentValues構造体

IndividualPromptRunTimeInfoCurrentValues構造体を使用して、プロンプトの現在の値を指定します。

IndividualPromptRunTimeInfoCurrentValues構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoCurrentValues構造体のフィールド

フィールド	説明
String currentOperator	プロンプトの現在の演算子を指定します。
Boolean emptyAsAllChoices	空のプロンプトのデフォルト値をすべての選択にするか(true)、否か(false)を指定します。
IndividualPromptRunTimeInfoValuesType values	プロンプトの値を指定します。

IndividualPromptRunTimeInfoAvailableOptions構造体

IndividualPromptRunTimeInfoAvailableOptions構造体を使用して、プロンプトの使用可能なオプションを指定します。

IndividualPromptRunTimeInfoAvailableOptions構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoAvailableOptions構造体のフィールド

フィールド	説明
Int numOptionsPerPage	ページごとのオプション数を指定します。
Int currentPageInOptions	現行のページ数を指定します。
Boolean moreOptions	プロンプトを追加オプションで構成するか(true)、否か(false)を指定します。
Boolean includeAllChoices	プロンプトにすべての選択を含むか(true)、否か(false)を指定します。
Boolean needToPopulateDropDown	プロンプトがドロップ・ダウンの移入を要求するか(true)、否か(false)を指定します。
String valueTablePromptSourceType	プロンプトのソース・タイプを指定します。
String sql	プロンプトのSQLを指定します。
String runTimeCodeAndDisplayValueFormatStr	プロンプトの値の書式文字列を指定します。
String filterXmlString (nillable)	プロンプトのXMLフィルタを指定します。
IndividualPromptRunTimeInfoValuesType groupPaths (nillable)	プロンプトで使用されるグループの値を指定します。nullを指定することができます。
IndividualPromptRunTimeInfoValuesType populatedOptions (nillable)	プロンプトで使用される移入済の値を指定します。nullを指定することができます。

IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体

IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体を使用して、プロンプトの追加属性を指定します。

IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoDataTypeHierarchyInfo構造体のフィールド

フィールド	説明
Int opMinNumValues	プロンプト内の値の最小数を指定します。
Int opMaxNumValues	プロンプト内の値の最大数を指定します。

IndividualPromptRunTimeInfoLimitedByPromptReference構造体

IndividualPromptRunTimeInfoLimitedByPromptReference構造体を使用して、このプロンプトを制限するプロンプトを指定します。

IndividualPromptRunTimeInfoLimitedByPromptReference構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoLimitedByPromptReference構造体のフィールド

フィールド	説明
Int promptID	プロンプトの識別子を指定します。
String formulaExprString	プロンプトの算式を指定します。

IndividualPromptRunTimeInfoLimitedByPromptRefGroups構造体

IndividualPromptRunTimeInfoLimitedByPromptRefGroups構造体を使用して、このプロンプトのグループを制限するプロンプトを指定します。

IndividualPromptRunTimeInfoLimitedByPromptRefGroups structure構造体は、getPromptElements()メソッドで使用します。

IndividualPromptRunTimeInfoLimitedByPromptRefGroups構造体のフィールド

フィールド	説明
IndividualPromptRunTimeInfoLimitedByPromptReference[] limitByPrompt	このプロンプトを制限するプロンプトの配列を指定します。