メソッドの概要

返却値の型 メソッド名
ResultObject checkError (Object dataViewObject) static
データ参照の設定にエラーが無いかチェックをします。
Object createNewDataView (Object jsObject, Number patternObject) static
新しいデータ参照オブジェクトを生成します。
ResultObject createReportFile (Object sourceFileObject, Object storageObject, Object existImageFlagObject) static
帳票ファイルを作成します。
ResultObject createRichTextHtmlString (String formulaObject, Object dataviewObject) static
式文字列を解析して、式を構成する要素単位でXML形式のタグ文字列として返却します。
Boolean enabledCreateReport () static
帳票ファイルを作成可能かどうかを判定します。
Object execFormula (Object paramsObject, Object dataviewObject, VCQuery queryObject, String formulaObject) static
式を実行して結果を取得します。
ResultObject exportData (File destObject, Object paramsObject, Object dataviewObject, VCQuery queryObject, Boolean zipFlagObject) static
リスト集計の表示データをファイルにエクスポートします。
ResultObject generateSql4List (Object paramsObject, Object dataviewObject, VCQuery queryObject, Boolean orderbyObject) static
リスト集計用のデータ取得SQLを生成します。
ResultObject generateViewSouceCode (String dataViewCodeObject) static非推奨
データ参照表示画面のソースコードを生成します。
ResultObject generateViewSourceCode (String dataViewCodeObject) static
データ参照表示画面のソースコードを生成します。
ResultObject getACLList () static
登録されている全てのデータ参照のアクセス権一覧を取得します。
ResultObject getACL (String dataCodeObject) static
データ参照に設定されたアクセス権を取得します。
Array getAllFunctionInfos () static
計算式で使用可能な関数に関する情報の一覧を取得します。
ResultObject getCrossResult (Object dataviewObject, VCQuery queryObject, Boolean jsComplexStruct, Object paramsObject) static
クロス集計結果データを取得します。
ResultObject getEditableDataViewCodes () static
カレントユーザが編集可能なデータ参照コードの配列を返します。
Object getGraphBodyJsspPath () static
グラフコンテンツを生成するJSSPのパスを返します。
ResultObject getGraphResultWithError (Object dataviewObject, VCQuery queryObject) static
グラフ表示用のデータを取得します。(エラー発生時にはエラー情報を返却します)
Array getGraphResult (Object dataviewObject, VCQuery queryObject) static
グラフ表示用のデータを取得します。
ResultObject getListResult (Object paramsObject, Object dataviewObject, VCQuery queryObject, Number startRowObject, Number lengthObject) static
リスト集計用の結果データセットを取得します。
String getReplacementNullValue () static
Null値に対する代替表示文字列を取得します。
String getReportFileSuffix () static
帳票ファイルの拡張子を取得します。
Object getTotalCalcResult4List (Object paramsObject, Object dataviewObject, VCQuery queryObject) static
全レコードの計算結果をフィールドごとに取得します。(リスト集計用)
Object getView (String jsdataCode) static
データ参照オブジェクトを取得します。
Boolean isShowDataExportConfirm4Zip () static
リスト(サマリ)集計でデータをエクスポートする場合に、
ResultObject registAsCSVExportJob (Object dataviewObject) static非推奨
データ参照で得られたデータをCSVファイルに出力するジョブを登録します。
ResultObject regist (Object dataViewObject) static非推奨
データ参照を登録します。
ResultObject registerAsCSVExportJob (Object dataviewObject) static
データ参照で得られたデータをCSVファイルに出力するジョブを登録します。
ResultObject register (Object dataViewObject) static
データ参照を登録します。
ResultObject remove (String dataCodeObject) static
データ参照を削除します。
ResultObject resolveExportFileName (データ参照オブジェクト(リスト集計) dataviewObject, ファイル名設定 fileNameSettingObject) static
リスト集計のデータ参照をファイルにエクスポートした時のファイル名を作成します。
Array searchByQueryCode (String queryCodeObject) static
指定されたクエリコードから作成されたデータ参照を検索します。
Array search (String dataViewNameObject, String sortFieldNameObject, Boolean descFlagObject) static
データ参照を検索します。
ResultObject setACL (Object aclobject) static
データ参照にアクセス権限を付与します。
ResultObject toJavaScriptObject (String xmlString) static
XMLデータをデータ参照オブジェクトに変換します。
ResultObject toXmlString (Object dataviewObject) static
データ参照オブジェクトをXMLデータに変換します。

メソッドの詳細

ResultObject checkError (Object dataViewObject) static
データ参照の設定にエラーが無いかチェックをします。
パラメータ
dataViewObject : Object
チェックを行う対象のデータ参照オブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
Object createNewDataView (Object jsObject, Number patternObject) static
新しいデータ参照オブジェクトを生成します。
パラメータ
jsObject : Object
クエリオブジェクト/作成元データ参照コード
patternObject : Number
データ参照パターン 1:リスト集計 2:サマリ集計 3:クロス集計 4:グラフ集計
返却値
Object
Object データ参照オブジェクト
ResultObject createReportFile (Object sourceFileObject, Object storageObject, Object existImageFlagObject) static
帳票ファイルを作成します。
パラメータ
sourceFileObject : Object
変換元HTMLファイル
storageObject : Object
出力先ストレージ
existImageFlagObject : Object
chartタグによるグラフイメージを含む場合は true、含まない場合は false
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
ResultObject createRichTextHtmlString (String formulaObject, Object dataviewObject) static
式文字列を解析して、式を構成する要素単位でXML形式のタグ文字列として返却します。
パラメータ
formulaObject : String
式文字列
dataviewObject : Object
データ参照オブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、タグつきの式文字列が設定されます。
Boolean enabledCreateReport () static
帳票ファイルを作成可能かどうかを判定します。
返却値
Boolean
boolean 作成可能判定
作成可能の場合は true、作成不可能の場合は false を返却します。
Object execFormula (Object paramsObject, Object dataviewObject, VCQuery queryObject, String formulaObject) static
式を実行して結果を取得します。
戻り値の型は実行される式の内容に依存します。
パラメータ
paramsObject : Object
ユーザ入力データ
dataviewObject : Object
データ参照オブジェクト
queryObject : VCQuery
クエリオブジェクト
formulaObject : String
式を表す文字列
返却値
Object
Object 計算結果
ResultObject exportData (File destObject, Object paramsObject, Object dataviewObject, VCQuery queryObject, Boolean zipFlagObject) static
リスト集計の表示データをファイルにエクスポートします。
パラメータ
destObject : File
エクスポート先ファイル
paramsObject : Object
ユーザ入力データ
dataviewObject : Object
データ参照オブジェクト
queryObject : VCQuery
クエリオブジェクト
zipFlagObject : Boolean
エクスポートデータを圧縮する場合は true、圧縮しない場合は false
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
ResultObject generateSql4List (Object paramsObject, Object dataviewObject, VCQuery queryObject, Boolean orderbyObject) static
リスト集計用のデータ取得SQLを生成します。
パラメータ
paramsObject : Object
ユーザ入力データ
dataviewObject : Object
データ参照オブジェクト
queryObject : VCQuery
クエリオブジェクト
orderbyObject : Boolean
ORDER BY句を付ける場合は true、付けない場合は false
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、生成されたSQL文字列が設定されます。
ResultObject generateViewSouceCode (String dataViewCodeObject) static 非推奨
データ参照表示画面のソースコードを生成します。
パラメータ
dataViewCodeObject : String
データ参照コード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
ResultObject generateViewSourceCode (String dataViewCodeObject) static
データ参照表示画面のソースコードを生成します。
パラメータ
dataViewCodeObject : String
データ参照コード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
ResultObject getACLList () static
登録されている全てのデータ参照のアクセス権一覧を取得します。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、アクセス権のマップ配列 <データ参照コード, ACLインスタンス> が設定されます。
ResultObject getACL (String dataCodeObject) static
データ参照に設定されたアクセス権を取得します。
パラメータ
dataCodeObject : String
データ参照コード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、アクセス権情報が設定されます。
Array getAllFunctionInfos () static
計算式で使用可能な関数に関する情報の一覧を取得します。
返却値
Array
Array 関数情報の配列 {name:関数名(String), rdb:RDB向けの関数かどうか(Boolean)}
ResultObject getCrossResult (Object dataviewObject, VCQuery queryObject, Boolean jsComplexStruct, Object paramsObject) static
クロス集計結果データを取得します。
パラメータ
dataviewObject : Object
データ参照オブジェクト
queryObject : VCQuery
クエリオブジェクト
jsComplexStruct : Boolean
取得するデータの構造を2015年Summer以降の新しいデータ構造で取得したい場合は true、それ以外の場合は false
paramsObject : Object
ユーザ入力データ ※省略可
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、クロス集計データが設定されます。
ResultObject getEditableDataViewCodes () static
カレントユーザが編集可能なデータ参照コードの配列を返します。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、編集可能なデータ参照コードの配列が設定されます。
Object getGraphBodyJsspPath () static
グラフコンテンツを生成するJSSPのパスを返します。
返却値
Object
Object 処理結果オブジェクト
ResultObject getGraphResultWithError (Object dataviewObject, VCQuery queryObject) static
グラフ表示用のデータを取得します。(エラー発生時にはエラー情報を返却します)
パラメータ
dataviewObject : Object
データ参照オブジェクト
queryObject : VCQuery
クエリオブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、グラフ表示用結果データが格納されます。
Array getGraphResult (Object dataviewObject, VCQuery queryObject) static
グラフ表示用のデータを取得します。
パラメータ
dataviewObject : Object
データ参照オブジェクト
queryObject : VCQuery
クエリオブジェクト
返却値
Array
Array グラフ表示用結果データ
ResultObject getListResult (Object paramsObject, Object dataviewObject, VCQuery queryObject, Number startRowObject, Number lengthObject) static
リスト集計用の結果データセットを取得します。
結果セットに含まれる総レコード数は、取得開始位置および取得件数の設定値を無視した値がセットされます。
取得レコード長の指定は、0をセットすることで制限なしでデータを取得しますが 物理メモリ領域を圧迫する可能性がありますので注意してください。
パラメータ
paramsObject : Object
ユーザ入力データ
dataviewObject : Object
データ参照オブジェクト
queryObject : VCQuery
クエリオブジェクト
startRowObject : Number
取得開始レコード位置
lengthObject : Number
取得レコード長
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、リスト集計用の結果データセットが設定されます。
String getReplacementNullValue () static
Null値に対する代替表示文字列を取得します。
返却値
String
String 代替表示文字列
String getReportFileSuffix () static
帳票ファイルの拡張子を取得します。
返却値
String
String 帳票ファイルの拡張子
Object getTotalCalcResult4List (Object paramsObject, Object dataviewObject, VCQuery queryObject) static
全レコードの計算結果をフィールドごとに取得します。(リスト集計用)
パラメータ
paramsObject : Object
ユーザ入力データ
dataviewObject : Object
データ参照オブジェクト
queryObject : VCQuery
クエリオブジェクト
返却値
Object
Object 計算結果<フィールド名, 計算結果値>
Object getView (String jsdataCode) static
データ参照オブジェクトを取得します。
指定されたコードに対するデータ参照が見つからなかった場合はnullを返却します。
このメソッドはカレントユーザが少なくとも参照権を持っているデータ参照のみを返します。
参照権を持つユーザとは、管理者ユーザ、データ参照の作成者ユーザ、参照権を付与されているユーザのいずれかです。
参照権が無いデータ参照を取得しようとした場合においてもnullが返却されます。
パラメータ
jsdataCode : String
データ参照コード
返却値
Object
Object データ参照オブジェクト
Boolean isShowDataExportConfirm4Zip () static
リスト(サマリ)集計でデータをエクスポートする場合に、
zip圧縮を行うか選択するためのダイアログの表示可否を取得します。
返却値
Boolean
boolean ダイアログ表示可否
ダイアログを表示する場合は true、それ以外は false を返却します。
ResultObject registAsCSVExportJob (Object dataviewObject) static 非推奨
データ参照で得られたデータをCSVファイルに出力するジョブを登録します。
パラメータ
dataviewObject : Object
データ参照オブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
ResultObject regist (Object dataViewObject) static 非推奨
データ参照を登録します。
このメソッドを使用して既存のデータ参照を更新するには、
カレントユーザが管理者か、そのデータ参照の作成者である必要があります。
パラメータ
dataViewObject : Object
データ参照オブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
ResultObject registerAsCSVExportJob (Object dataviewObject) static
データ参照で得られたデータをCSVファイルに出力するジョブを登録します。
パラメータ
dataviewObject : Object
データ参照オブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
ResultObject register (Object dataViewObject) static
データ参照を登録します。
このメソッドを使用して既存のデータ参照を更新するには、
カレントユーザが管理者か、そのデータ参照の作成者である必要があります。
パラメータ
dataViewObject : Object
データ参照オブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
ResultObject remove (String dataCodeObject) static
データ参照を削除します。
このメソッドを使用して既存のデータ参照を削除するには、カレントユーザが
管理者かあるいは、そのデータ参照の作成者である必要があります。
パラメータ
dataCodeObject : String
データ参照コード、またはデータ参照コードの配列(Array)
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
ResultObject resolveExportFileName (データ参照オブジェクト(リスト集計) dataviewObject, ファイル名設定 fileNameSettingObject) static
リスト集計のデータ参照をファイルにエクスポートした時のファイル名を作成します。
jsFileNameSettingに [[..]] で括られているところを関数として解釈し、ファイル名を返却します。
パラメータ
dataviewObject : データ参照オブジェクト(リスト集計)
データ参照オブジェクト(リスト集計)
fileNameSettingObject : ファイル名設定
ファイル名設定
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ファイル名が設定されます。
Array searchByQueryCode (String queryCodeObject) static
指定されたクエリコードから作成されたデータ参照を検索します。
このメソッドはカレントユーザが少なくとも参照権を持っているデータ参照のみを返します。
参照権を持つユーザとは、管理者ユーザ、データ参照の作成者ユーザ、参照権を付与されているユーザのいずれかです。
パラメータ
queryCodeObject : String
クエリコード
返却値
Array
Array データ参照オブジェクトの配列
Array search (String dataViewNameObject, String sortFieldNameObject, Boolean descFlagObject) static
データ参照を検索します。
指定された検索キーを使用してデータ参照名を部分一致で検索します。
検索キーが省略された場合は登録されている全データ参照を検索します。
このメソッドはカレントユーザが少なくとも参照権を持っているデータ参照のみを返します。
参照権を持つユーザとは、管理者ユーザ、データ参照の作成者ユーザ、参照権を付与されているユーザのいずれかです。
パラメータ
dataViewNameObject : String
検索キー・データ参照名
sortFieldNameObject : String
配列のソート順を決めるフィールド名
descFlagObject : Boolean
降順の場合は true、昇順の場合は false
返却値
Array
Array データ参照オブジェクトの配列
ResultObject setACL (Object aclobject) static
データ参照にアクセス権限を付与します。
パラメータ
aclobject : Object
ACLデータオブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
ResultObject toJavaScriptObject (String xmlString) static
XMLデータをデータ参照オブジェクトに変換します。
パラメータ
xmlString : String
データ参照オブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。
ResultObject toXmlString (Object dataviewObject) static
データ参照オブジェクトをXMLデータに変換します。
パラメータ
dataviewObject : Object
データ参照オブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理結果が設定されます。