6.5.1.2 アクションのスクリプト（UIバージョン1.1）
Scriptのマニフェストファイル内のキー"file"で指定するスクリプトをあらかじめ作成する必要があります。スクリプトはJavaScriptで記述してください。以下に各コンポーネントでアクションが実行されるタイミングおよび呼び出される関数名の一覧を示します。お客様はスクリプト内に該当する関数名を定義し、アクションの内容を記述してください。
（表）各コンポーネントでの実行タイミングおよび関数名一覧（UIバージョン1.1）
| コンポーネント | アクションが実行される タイミング |
スクリプト内で 呼び出される関数名 |
関数の引数 | ||
|---|---|---|---|---|---|
| データ形式 | 変数名 | 設定する値 | |||
| Grid | 画面の表示時 | handleLoad | － | － | － |
| Button | ボタンのクリック時 | handleClick※1 | string | name | クリックしたボタンの名前 |
| ボタンクリック直後 | handleBeforeAction※2 | － | － | － | |
| データ保存前 | handleBeforeSave※2 | － | － | － | |
| データ保存後 | handleAfterSave※2 | － | － | － | |
| ワークフローを次のステップにすすめる処理の前 | handleBeforeRequestWorkflow※2 | － | － | － | |
| handleBeforeResumeStep※2 | － | － | － | ||
| Form | 画面の表示時 | handleLoad | － | － | － |
| Formの初期表示データ取得時 | handleAfterLoadData | － | － | － | |
| Formフィールドの変更時 | handleChange | string | fieldName | 変更されたフィールドの名前 | |
| any | fieldValue | 変更されたフィールドの値 | |||
| Object | fieldExtension | 変更されたフィールドの値 | |||
| boolean | fieldExtension.checked | チェックボックスのチェック状態（properties.checkbox: true時） | |||
| string | fieldExtension.operator | 演算子 （properties.operator: true時） | |||
| any | fieldExtension.firstOperand | 第1オペランド（properties.operator: true時、演算子によってはなし） | |||
| any | fieldExtension.secondOperand | 第2オペランド（properties.operator: true時、演算子によってはなし） | |||
| フォーカスを外した時 | handleBlur | string | fieldName | 変更されたフィールドの名前 | |
| any | fieldValue | 変更されたフィールドの値 | |||
| Object | fieldExtension | 変更されたフィールドの値 | |||
| boolean | fieldExtension.checked | チェックボックスのチェック状態（properties.checkbox: true時） | |||
| string | fieldExtension.operator | 演算子 （properties.operator: true時） | |||
| any | fieldExtension.firstOperand | 第1オペランド（properties.operator: true時、演算子によってはなし） | |||
| any | fieldExtension.secondOperand | 第2オペランド（properties.operator: true時、演算子によってはなし） | |||
| Table | 画面の表示時 | handleLoad | － | － | － |
| Tableの行選択変更 | handleSelectionModelChange | GridRowId[]またはGridRowId | selectModel | Tableコンポーネントのproperties.selection:が"checkbox" の場合は選択行のIDの配列、"radio" の場合は選択行のID | |
| セルクリック時 | handleCellClick | string | field | クリックされた列の列名 | |
| object | row | クリックされた行の行データ | |||
| セル値の変更時 | handleCellValueChange | any | value | 入力された値 | |
| セルのアイコンクリック時 | handleIconClick | Object | row | クリックされた行の行データ | |
| Tabs | タブ選択の変更時 | handleChange | string | name | 選択されたタブの名前 |
| object | activeTab | 選択されたタブの情報 | |||
| タブ活性時 | handleActivate | string | name | 活性になったタブの名前 | |
| object | activeTab | 活性になったタブの情報 | |||
| タブ非活性時 | handleDeactivate | string | name | 非活性になったタブの名前 | |
| object | activeTab | 非活性になったタブの情報 | |||
| タブの追加ボタンクリック時 | handleAddButtonClick | Array.<object> | － | 表示しているタブ情報の一覧 | |
| Card | Cardのクリック時 | handleClick※3 | string | name | クリックしたCardの名前 |
| 画面の表示時 | handleLoad | － | － | － | |
| Label | 画面の表示時 | handleLoad | － | － | － |
| Icon | アイコンのクリック時 | handleClick | string | name | 選択されたアイコンのname |
| value | switchへ指定したデータソースのフィールドの値 | ||||
| ItemList | 画面の表示時 | handleLoad | － | － | － |
| アイテムのクリック時 | handleItemClick | string | name | ItemListコンポーネントのname | |
| Object | data | アイテムに対応する行データ | |||
| アイテム選択の変更時 | handleItemSelectionChange | OIItem[] | items | 選択されているアイテム | |
Formのアクションの実行タイミングについて以下の図に示します。Formの初期表示データを更新する場合は、「handleAfterLoadData」で行ってください。
注意事項
Formの初期表示データ取得前にFormフィールドを更新しないでください。Formの初期表示データ取得前に更新しても、Formの初期表示データで上書きされます。
以下に、アクションの内容を記述する際に使用可能なクラス名と関数名の一覧を示します。
【インスタンスを作成せずに使用できるクラス】
- OIWindow
- OIData
- OIWorkflow
- OIApi
- OICommon
- OIUi
- OIItemList
【インスタンスを作成して使用するクラス】
- OIActionButton（アクションボタンの内部名）
- OIButton（Buttonコンポーネントの内部名）
- OITableDataSource（データソースのユーザー定義名）
- OIViewDataSource（データソースのユーザー定義名）
- OIForm（Formコンポーネントの内部名）
- OITable（Tableコンポーネントの内部名）
- OITabs（Tabsコンポーネントの内部名）
- OITab（Tabコンポーネントの内部名）
- OIArticle（Articleコンポーネントの内部名）
- OIAttachment（Attachmentコンポーネントの内部名）
- OICard（Cardコンポーネントの内部名）
- OIPaper（Paperコンポーネントの内部名）
- OILabel（Labelコンポーネントの内部名）
- OIIcon（Iconコンポーネントの内部名）
- OIItemList（ItemListコンポーネントの内部名）
- OIItem（params）
- OIStore（options）
アクションボタンの内部名はbuttonsのname、コンポーネントの内部名はcomponentsのname、データソースのユーザー定義名はdataSource.tablesのnameに設定する値です。内部名、ユーザー定義名の詳細は「（表）UI定義（UIバージョン1.1）」を参照してください。
（表）アクションの内容を記述する際に使用可能である関数名一覧（UIバージョン1.1）
| クラス名 | 関数名 | 説明 |
|---|---|---|
| OIWindow | open | ページ、またはUIを開く。 |
| showMessage | スナックバー、またはメッセージダイアログを表示する。 | |
| resetScroll | コンテンツ領域のスクロール位置をリセットする。 | |
| openDialog | ダイアログを開く。 | |
| closeDialog | ダイアログを閉じる。 | |
| OIData | insertCurrentRecord | Ops I REST API graphqlを使用して、データベースの任意のテーブルにレコードを挿入する。 |
| getRecords | Ops I REST API graphqlを使用して、データベースの任意のテーブルのレコードを取得する。 | |
| updateCurrentRecord | Ops I REST API graphqlを使用して、データベースのテーブルの任意のレコードを更新する。 | |
| deleteCurrentRecord | Ops I REST API graphqlを使用して、データベースのテーブルの任意のレコードを削除する。 | |
| query | Ops I REST API graphqlを使用して、任意のGraphQLクエリを実行する。 | |
| OIWorkflow | respond | ワークフローに応答する。 |
| start | 指定されたコンテキストIDに関連するワークフローを実行する。 | |
| save | ワークフローを保存する。 | |
| getActivity | 現在表示されているワークフローのアクティビティのオブジェクトを取得する。 | |
| getParams | ワークフロー実行時に設定したパラメータを取得する。 | |
| OIApi | call | REST APIを実行する。 |
| OICommon | getUserProfile | ログインユーザーのユーザー情報を取得する。 |
| getUserTimezone | ログインユーザーのタイムゾーンを取得する。 | |
| getDateWithUserTimezone | 現在日時をログインユーザーのタイムゾーンで取得する。 | |
| formatWithUserTimeZone | 指定した日付をログインユーザーのタイムゾーンで表示する。 | |
| getUTCOffset | ブラウザーのタイムゾーンを取得する。 | |
| translate | ユーザーの言語設定に合わせた文字列を取得する。 | |
| showLoadingScreen | ロックスクリーンを表示する。 | |
| hideLoadingScreen | ロックスクリーンの表示を解除する。 | |
| copyClipboard | クリップボードに指定した文字列を貼り付ける。 | |
| getLocation | 現在の文書の現在位置情報をWindow.locationで取得する。 | |
| download | 指定したファイルをブラウザーからダウンロードする。 | |
| OIStore | get | keyに対応する値を取得する。 |
| set | keyに対応する値を設定する。 | |
| delete | keyに対応する値を削除する。 | |
| hasKey | keyに対応する値の有無を取得する。 | |
| OIUi | getContext | コンテキストの情報を取得する。 |
| getName | UI名を取得する。 | |
| OIActionButton | setVisible | ボタンの表示、非表示を設定する。 |
| setEnable | ボタンの活性、非活性を設定する。 | |
| OIButton | setVisible | ボタンの表示、非表示を設定する。 |
| setEnable | ボタンの活性、非活性を設定する。 | |
| OITableDataSource | refresh | データの再取得、およびデータソース使用箇所への取得データを反映する。 |
| setAutorefreshSeconds | 自動リフレッシュ間隔を設定する。 | |
| getParameter | 指定されたデータソース名のパラメータの設定を取得する。 | |
| setParameter | 指定されたデータソース名のパラメータを設定する。 | |
| deleteParameter | 指定されたデータソース名のパラメータの構成を削除する。 | |
| update | Tableデータソースによって参照されるリソースの更新を実行する。 | |
| create | Tableデータソースによって参照されるリソースの作成を実行する。 | |
| delete | Tableデータソースによって参照されるリソースの削除を実行する。 | |
| OIViewDataSource | refresh | データの再取得、およびデータソース使用箇所への取得データを反映する。 |
| setAutorefreshSeconds | 自動リフレッシュ間隔を設定する。 | |
| getParameter | 指定されたデータソース名のパラメータの設定を取得する。 | |
| setParameter | 指定されたデータソース名のパラメータを設定する。 | |
| deleteParameter | 指定されたデータソース名のパラメータの構成を削除する。 | |
| OIForm | setStatus | フォームのフィールドのステータスを設定する。 |
| setHelperText | フォームのフィールドのヘルパーテキストを設定する。 | |
| removeHelperText | フォームのフィールドのヘルパーテキストを削除する。 | |
| getFieldValue | フィールドの値を取得する。 | |
| getFieldValues | すべてのフィールドの値を取得する。 | |
| getFieldExtension | フィールドの各種情報を取得する。 | |
| getFieldExtensions | すべてのフィールドの各種情報を取得する。 | |
| setFieldValue | フィールドの値を設定する。 | |
| setFieldExtensions | フィールドの各種情報を設定する。 | |
| setFieldVisible | フィールドの表示または非表示を設定する。 | |
| validate | Formのバリデーション結果を取得する。 | |
| setLookupLabelQuery | 対象のルックアップフィールドのlabelQueryを設定する。 | |
| getLookupLabelQuery | 対象フィールドに設定されたlabelQueryを取得する。 | |
| setEnable | 対象のフォームが活性または非活性かを設定する。 | |
| setFieldEnable | 対象のフィールドが活性または非活性かを設定する。 | |
| setReadOnly | 対象のフォームが読み取り専用または書き込み可能を設定する。 | |
| setFieldReadOnly | 対象のフィールドが読み取り専用または書き込み可能を設定する。 | |
| getEnumValues | Enum型のフィールドに設定されている選択肢を取得する。 | |
| setEnumValues | Enum型のフィールドに対し、任意の選択肢を設定する。 | |
| OITable | setRows | 対象のテーブルに表示されている行を置き換える。 |
| addRows | 対象のテーブルに表示する行を追加する。 | |
| deleteRows | 対象のテーブルに表示されている行を削除する。 | |
| getRows | 行データを取得する。 | |
| getSelectedIds | 選択されている行のIDを取得する。 | |
| setSelectedIds | 対象のテーブルの選択状態を変更する。 | |
| getSelectedRows | テーブルの選択した行の全データを取得する。 | |
| OITabs | getTabs | インスタンスに属する全タブ情報の配列を取得する。 |
| addTab | 指定したタブを追加する。 | |
| activateTab | 指定したタブをアクティブにする。 | |
| getActiveTab | アクティブなタブを取得する。 | |
| OITab | getForm | タブに対応するコンテンツに含まれるOIFormのインスタンスを取得する。 |
| getTable | タブに対応するコンテンツに含まれるOITableのインスタンスを取得する。 | |
| getTabs | タブに対応するコンテンツに含まれるOITabsのインスタンスを取得する。 | |
| getArticle | タブに対応するコンテンツに含まれるOIArticleのインスタンスを取得する。 | |
| getButton | タブに対応するコンテンツに含まれるOIButtonのインスタンスを取得する。 | |
| getAttachment | タブに対応するコンテンツに含まれるOIAttachmentのインスタンスを取得する。 | |
| getCard | タブに対応するコンテンツに含まれるOICardのインスタンスを取得する。 | |
| getTableDataSource | タブに対応するコンテンツに含まれるOITableDataSourceのインスタンスを取得する。 | |
| getLabel | タブに対応するコンテンツに含まれるOILabelのインスタンスを取得する。 | |
| OIViewDataSource | タブに対応するコンテンツに含まれるOIViewDataSourceのインスタンスを取得する。 | |
| OIArticle | setAutorefreshSeconds | 自動リフレッシュ間隔を設定する。 |
| OIAttachment | saveFiles | 添付ファイルを保存する。 |
| OICard | setContent | 表示内容を設定する。 |
| setLink | リンク先を設定する。 | |
| OIPaper | setVisible | Paperの表示または非表示を指定する。 |
| OILabel | setContent | ラベルの値を設定する。 |
| getContent | ラベルの値を取得する。 | |
| OIIcon | setVisible | アイコンの表示、非表示を設定する。 |
| OIItemList | getItems | アイテムリストに表示されているアイテムを取得する。 |
| setItemsData | アイテムリストのデータを設定する。 | |
| addItemsData | アイテムリストにデータを追加する。 | |
| reload | アイテムリストのデータを再読み込みする。 | |
| setSelectedItemIds | 対象のアイテムの選択状態を変更する。 | |
| getSelectedItemIds | 選択されているアイテムのIDを取得する。 | |
| getSelectedItems | 選択されているアイテムを取得する。 | |
| getCurrentItem | 対象のコンポーネントを含んでいるアイテムを取得する。 | |
| OIItem | getButton | アイテム内に存在する、指定されたnameのOIButtonインスタンスを取得する。 |
| getCard | アイテム内に存在する、指定されたnameのOICardインスタンスを取得する。 | |
| getPaper | アイテム内に存在する、指定されたnameのOIPaperインスタンスを取得する。 | |
| getLabel | アイテム内に存在する、指定されたnameのOILabelインスタンスを取得する。 | |
| getIcon | アイテム内に存在する、指定されたnameのOIIconインスタンスを取得する。 |
（1）OIWindow
OIWindowクラスの関数の詳細は以下の通りです。
（a）OIWindow.open
ページ、またはUIを開きます。
引数は下表の通りです。
（表）OIWindow.openの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | type | "move"、"new_window"、"new_tab"のいずれかを指定する。
|
|
| Object | options | － | |
| string | url | urlに表示するページのURLを指定する。 例）{url:'/sys_task'} |
|
＜戻り値＞
戻り値はありません。
（b）OIWindow.showMessage
スナックバー、またはメッセージダイアログを表示します。
引数は下表の通りです。
（表）OIWindow.showMessageの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | type | メッセージをスナックバーで表示する場合は"snackbar"、ダイアログで表示する場合は"modal"を指定する。 | |
| Object | options | － | |
| string | typeMess | typeが"snackbar"の場合、"error"、"warning"、"info"、"success"のいずれかを指定する。 typeが"modal"の場合は、任意の数のボタンを表示でき、クリックされたボタンを戻り値で受け取ることができる。 |
|
| string | content | 表示するメッセージを指定する。 | |
| string | title | typeが"modal"の場合、タイトルを指定する。 | |
| [Array<Object>] | buttons | typeが"modal"の場合、ボタンのラベルと値（クリック時に返却される）を以下のように設定する。
- [Array<Object>] buttons - {string} name - {string} value |
|
| Object | btnOk | typeが"modal"の場合、第1ボタンのラベルに表示する内容を設定する。 | |
| string | btnCancel | typeが"modal"の場合、最終ボタンのラベルに表示する内容を設定する。 btnOk、btnCancelをどちらも省略した場合は[OK]ボタンが表示される。 |
|
| string | subContent | typeが"modal"の場合、contentのメッセージの下に表示される追加のメッセージを設定する。 省略可能である。 |
|
| boolean | useConfirm | typeが"modal"の場合、"true"を指定すると、[OK]ボタンをクリックするための確認用チェックボックスが追加される。 省略した場合は"false"となる。 |
|
| string | subContentType | typeが"modal"の場合、subContentのメッセージが表示される領域のスタイルを設定する。 "plain"または"contained"を指定できる。省略した場合は"plain"となる。
|
|
＜戻り値＞
Typeに"modal"を指定した場合、第1ボタンがクリックされたときは"ok"、最終ボタンがクリックされたときは"cancel"を戻り値にPromise<string>型で設定します。
（c）OIWindow.resetScroll
コンテンツ領域のスクロール位置をリセットします。
引数はありません。
＜戻り値＞
戻り値はありません。
（d）OIWindow.openDialog
ダイアログを開きます。
引数は下表の通りです。
（表）OIWindow.openDialogの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | ui | ダイアログのコンテンツ部分に表示するUIのマニフェストファイルを指定する。 | |
| Object | options | ダイアログに関するオプションを指定する。 | |
| string | title | ダイアログの中身に表示するUIのマニフェストファイルを指定する。 省略可能である。 |
|
| string | titleIcon | ダイアログのタイトルの先頭に表示するアイコンを指定する。 Material UIで用意されているアイコンを指定する。 詳細はhttps://v7.mui.com/material-ui/material-icons/を参照。 省略可能である。 |
|
| object | dialogSx | ダイアログの外枠全体のスタイルをMaterial-UIのsxプロパティに基づいて指定する。 詳細はhttps://v7.mui.com/system/getting-started/the-sx-prop/を参照。 省略可能である。 |
|
| object | contentSx | ダイアログの中身のスタイルをMaterial-UIのsxプロパティに基づいて指定する。 詳細はhttps://v7.mui.com/system/getting-started/the-sx-prop/を参照。 省略可能である。 |
|
＜戻り値＞
closeDialogによってダイアログが閉じられるまで待機します。Promiseが解決されると、closeDialogのresultにPromise<any>型で渡した値を返却します。
（e）OIWindow.closeDialog
ダイアログを閉じます。
引数は下表の通りです。
（表）OIWindow.closeDialogの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| any | result | openDialogの戻り値とする値を指定する。 | |
＜戻り値＞
完了するまで待機するPromise<undefined>を返却します。
（2）OIData
OIDataクラスの関数の詳細は以下の通りです。
（a）OIData.insertCurrentRecord
Ops I REST API graphqlを使用して、データベースの任意のテーブルにレコードを挿入します。
引数は下表の通りです。
（表）OIData.insertCurrentRecordの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| Object | currentRecord | － | |
| string | table | レコードを挿入するテーブル名を指定する。 設定は必須である。 |
|
| Object | 挿入レコードのフィールド名 | 挿入レコードのフィールドに設定する値を指定する。 任意の数を指定できるが、挿入先テーブルのフィールド名と対応している必要がある。フィールドが文字列型の場合はstring、数値型の場合はnumberなど、設定する値はフィールドの型に合わせる。 |
|
| string | ctxId | 挿入するレコードと関連付けるコンテキストIDを指定する。 設定は必須である。 |
|
＜戻り値＞
Response BodyをPromise<Object>型で設定します。
（b）OIData.getRecords
Ops I REST API graphqlを使用して、データベースの任意のテーブルのレコードを取得します。
引数は下表の通りです。
（表）OIData.getRecordsの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | tableName | 取得するレコードのテーブル名を指定する。 | |
| string | obj | レコード取得条件のGraphQLクエリを指定する。 例1）取得するフィールドを指定する場合：'{field1 field2}' 例2）指定したレコードIDと同じレコードのfield1, field2を取得する場合：'( where: { id: {_eq: "レコードID" } }){field1 field2}' |
|
＜戻り値＞
Response BodyをPromise<Object>型で設定します。
（c）OIData.updateCurrentRecord
Ops I REST API graphqlを使用して、データベースのテーブルの任意のレコードを更新します。
引数は下表の通りです。
（表）OIData.updateCurrentRecordの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| Object | currentRecord | － | |
| string | table | 更新するレコードのテーブル名を指定する。 設定は必須である。 |
|
| string | id | 更新するレコードのIDを指定する。 設定は必須である。 |
|
| Object | 更新レコードのフィールド名 | 更新するレコードのフィールドに設定する値を指定する。 任意の数を指定できるが、更新先テーブルのフィールド名と対応している必要がある。フィールドが文字列型の場合はstring、数値型の場合はnumberなど、設定する値をフィールドの型に合わせる。 |
|
＜戻り値＞
Response BodyをPromise<Object>型で設定します。
（d）OIData.deleteCurrentRecord
Ops I REST API graphqlを使用して、データベースのテーブルの任意のレコードを削除します。
引数は下表の通りです。
（表）OIData.deleteCurrentRecordの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | tableName | 削除するレコードのテーブル名を指定する。 | |
| string | currentId | 削除するレコードのIDを指定する。 | |
＜戻り値＞
Response BodyをPromise<Object>型で設定します。
（e）OIData.query
Ops I REST API graphqlを使用して、任意のGraphQLクエリを実行します。
引数は下表の通りです。
（表）OIData.queryの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| Object | query | － | |
| string | query | 実行するGraphQLクエリを文字列で指定する。 | |
| Object | variables | GraphQLクエリに埋め込まれる変数を指定する。 | |
＜戻り値＞
Response BodyをPromise<Object>型で設定します。
（3）OIWorkflow
OIWorkflowクラスの関数の詳細は以下の通りです。
（a）OIWorkflow.respond
ワークフローに応答します。
引数は下表の通りです。
（表）OIWorkflow.respondの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | contextID | コンテキストID | |
| string | activityName | 返答するactivityName（ワークフロー定義中のtasksで指定されているタスク名） | |
| Object | params | 返答するアクションの内容として、"accept"、"reject"、"pull_back"、"cancel"のいずれかを指定する。 例） { "oi_response": "accept" } |
|
＜戻り値＞
実行結果をPromise<Object>型で戻り値に設定します。
（b）OIWorkflow.start
指定されたコンテキストIDに関連するワークフローを実行します。
引数は下表の通りです。
（表）OIWorkflow.startの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | contextID | コンテキストID | |
| Object | body | ワークフローに設定するパラメータの内容を指定する。 例） { "params": { "param1": "string", "param2": "string", "param3": "string" } } |
|
＜戻り値＞
実行結果をPromise<Object>型で戻り値に設定します。
（c）OIWorkflow.save
ワークフローを保存します。
保存時にエラーが発生した場合、エラーメッセージが表示されます。
引数は下表の通りです。
（表）OIWorkflow.saveの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | options | 以下を指定する。
|
|
＜戻り値＞
保存処理が完了するまで待機するPromiseを返却します。
（d）OIWorkflow.getActivity
現在表示されているワークフローのアクティビティのオブジェクト（StackStormのステップオブジェクト）を取得します。
引数はありません。
＜戻り値＞
取得した情報をPromise<Object>型で返却します。
取得まで待機するPromiseを返却します。
（e）OIWorkflow.getParams
ワークフロー実行時に設定したパラメータを取得します。
引数はありません。
＜戻り値＞
取得した情報をPromise<Object>型で返却します。
設定したパラメータがない場合、Promise<Undefined>を返却します。
（4）OIApi
OIApiクラスの関数の詳細は以下の通りです。
（a）OIApi.call
REST APIを実行します。
引数は下表の通りです。
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | url | 実行するREST APIのURLを指定する。 指定するREST APIはResponse Bodyがjson形式である必要がある。 |
|
| Object | option | パラメータを指定する。 省略時は波括弧（{}）が設定される。 例）{method: 'GET', headers: {'Content-Type': 'application/json'}} |
|
| boolean | showError | REST APIでエラーが発生した場合、エラー内容を画面に表示するか否かを指定する。 省略した場合、"true"が設定される。 |
|
＜戻り値＞
Response BodyをPromise<Object>型で設定します。
（5）OICommon
OICommonクラスの関数の詳細は以下の通りです。
（a）OICommon.getUserProfile
ログインユーザーのユーザー情報を取得します。
引数はありません。
＜戻り値＞
Promise<Object>型で設定します。
詳細は下表の通りです。
（表）OICommon.getUserProfileの戻り値（UIバージョン1.1）
| プロパティ | データ形式 | 説明 |
|---|---|---|
| id | string | ユーザーID |
| username | string | ユーザー名 |
| displayName | string | ユーザーの表示名 |
| firstName | string | ユーザーの名前（名） |
| lastName | string | ユーザーの苗字（性） |
| string | ユーザーのe-mailアドレス | |
| enabled | boolean | ユーザーの有効/無効状態
|
| emailVerified | boolean | メール認証の認証状態
|
| locked | boolean | ユーザーのロックの有効/無効状態
|
| otpConfigured | boolean | ワンタイムコード設定の有効/無効状態
|
| company | string | ユーザーの所属会社名 |
| department | string | ユーザーの所属部署名 |
| address | string | ユーザーの住所 |
| phoneNumber1 | string | ユーザーの電話番号1 |
| phoneNumber2 | string | ユーザーの電話番号2 |
| memo | string | ユーザーの備考 |
| customer | {id: string, name: string} | ユーザーの顧客 |
| roles | stringの配列 | ユーザーに割り当てられているロール名の一覧 Ops Iのv02-90以降は、代わりにeffectiveRolesの使用を推奨。 |
| effectiveRoles | {id: string, name: string, roleType: string, description: string} | ユーザーに割り当てられているロールの配列 |
| groups | stringの配列 | ユーザーが所属しているグループ名の一覧 Ops Iのv02-90以降は、代わりにassignedGroupsの使用を推奨。 |
| assignedGroups | {id: string, name: string, path: string, gitGroupPath: string, displayName: string, displayPath: string, email: string, description: string } | ユーザーが所属しているグループの配列 |
| userLang | string | Ops Iに設定されているユーザーの言語 |
| acls | stringの配列 | ロールを介してユーザーに割り当てられているACL名の一覧 |
（b）OICommon.getUserTimezone
ログインユーザーのタイムゾーンを取得します。
例）UTC+09:00
引数はありません。
＜戻り値＞
ログインユーザーのタイムゾーンをstring型で設定します。
（c）OICommon.getDateWithUserTimezone
現在日時（YYYY-MM-DDTHH:mm:ssZ形式）をログインユーザーのタイムゾーンで取得します。
例）2022-09-21T15:36:20+09:00
引数はありません。
＜戻り値＞
取得した現在日時をstring型で設定します。
（d）OICommon.formatWithUserTimeZone
指定した日付をログインユーザーのタイムゾーンで表示します。
例）変更後日付
2022-09-21T15:36:20+09:00
引数は下表の通りです。
（表）OICommon.formatWithUserTimeZoneの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | val | 日付 例）2022-09-21T06:36:20 |
|
| string | format | 書式 例）YYYY-MM-DDTHH:mm:ssZ |
|
＜戻り値＞
表示した日付をstring型で設定します。
（e）OICommon.getUTCOffset
ブラウザーのタイムゾーンを取得します。
例）UTC+09:00
引数はありません。
＜戻り値＞
取得したタイムゾーンをstring型で設定します。
（f）OICommon.translate
ユーザーの言語設定に合わせた文字列を取得します。
引数は下表の通りです。
（表）OICommon.translateの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| Object | dictionary | 言語ごとの文字列を定義する。 | |
| string | key | dictionaryから取得するkeyを指定する。 | |
＜戻り値＞
取得した文字列をstring型で設定します。
（g）OICommon.showLoadingScreen
ロックスクリーンを表示します。
実行回数分だけカウンターがインクリメントされます。
ボタンなどのユーザーによる操作の処理でOIWorkflow.respond、OIWorkflow.startなどワークフローの処理を行う場合は、showLoadingScreenを実行して多重実行を防ぐ必要があります。
引数はありません。
＜戻り値＞
戻り値はありません。
（h）OICommon.hideLoadingScreen
ロックスクリーンの表示を解除します。
実行回数分だけカウンターがデクリメントされ、カウンターが0で表示解除となります。
ロックスクリーンのまま画面操作ができなくなることを避けるため、try-finally節など使用して、エラー時でもhideLoadingScreenが必ず呼ばれる設定にします。
このメソッドを呼び出した際ロックスクリーンが表示されていない場合、このメソッドは画面に影響を与えず正常に終了します。
引数はありません。
＜戻り値＞
戻り値はありません。
（i）OICommon.copyClipboard
クリップボードに指定した文字列を貼り付けます。
引数は下表の通りです。
（表）OICommon.copyClipboardの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | data | クリップボードに貼り付ける文字列を指定する。 | |
＜戻り値＞
戻り値はありません。
（j）OICommon.getLocation
現在の文書の現在位置についての情報をWindow.location（ブラウザー組み込みのWeb API）で取得します。
引数はありません。
＜戻り値＞
Window.locationで取得した情報をPromise<Object>型で設定します。
戻り値には以下の情報を設定します。戻り値の詳細はWindow.locationの仕様を確認してください。
- hash
- host
- hostname
- href
- origin
- pathname
- port
- protocol
- search
（k）OICommon.download
指定したファイルをブラウザーからダウンロードします。
contentに文字列を指定する場合、指定する文字列はダウンロードするファイルまでのURLを指定する必要があります。また、指定するURLはOps Iと同一ドメインである必要があります。
ファイルのダウンロード中、ブラウザーによる進捗の表示は行われません。
ダウンロードするファイルは一度ブラウザー上に保持されます。ダウンロードするファイルのサイズは100MB程度までを推奨します。
引数は下表の通りです。
（表）OICommon.downloadの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | Blob | content | 次のいずれかを指定する。
|
|
| string | filename | 保存時のファイル名 | |
＜戻り値＞
ダウンロードが完了するまで待機するPromise<undefined>を返却します。
（6）OIStore
OIStoreはブラウザーにデータを保存する際に使用します。保存されたデータは、ブラウザーのタブやウィンドウを閉じても削除されませんが、ブラウザーのサイトデータやキャッシュをクリアすると削除されます。
OIStoreの引数「options」は以下の2つのプロパティを持つオブジェクトです。
- namespace：データを保存する名前空間（string型）を指定
名前空間ごとのデータ管理ができます。同じ名前空間でkeyが重複するとデータは上書きされます。異なる名前空間ではkeyが重複しても異なるデータとして保存されます。省略するとデフォルトの名前空間にデータが保存されます。 - scope：データにアクセスできるユーザーとしてallまたはuserを指定
- all：すべてのユーザーがアクセス可能
- user：ログインユーザー固有のデータのみアクセス可能
allで保存されたデータにはアクセスできません。
＜指定例＞
new OIStore({ namespace: 'sample', scope: 'user' });
OIStoreクラスの関数の詳細は以下の通りです。
（a）OIStore.get
keyに対応する値を取得します。
keyがstring型ではない場合、TypeErrorになります。
引数は下表の通りです。
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | key | keyを指定する。 | |
＜戻り値＞
取得した情報をPromise<any>で返却します。値が設定されていない場合はPromise<undefined>を返却します。
（b）OIStore.set
keyに対応する値を設定します。
既に値が設定されている場合は上書きします。
keyがstring型ではない場合、TypeErrorになります。
引数は下表の通りです。
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | key | keyを指定する。 | |
| any | value | 設定する値を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（c）OIStore.delete
keyに対応する値を削除します。
値が設定されていない場合はなにもしません。
keyがstring型ではない場合、TypeErrorになります。
引数は下表の通りです。
（表）OIStore.deleteの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | key | keyを指定する。 | |
＜戻り値＞
削除が完了するまで待機するPromiseを返却します。
値が削除された場合はtrueを、削除されなかった場合はfalseをPromise<boolean>型で返却します。
（d）OIStore.hasKey
keyに対応する値の有無を取得します。
keyがstring型ではない場合、TypeErrorになります。
引数は下表の通りです。
（表）OIStore.hasKeyの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | key | keyを指定する。 | |
＜戻り値＞
値の有無の取得が完了するまで待機するPromiseを返却します。
値が設定されていればtrueを、設定されていなければfalseをPromise<boolean>型で返却します。
（7）OIUi
OIUiクラスの関数の詳細は以下の通りです。
（a）OIUi.getContext
コンテキストの情報を取得します。
引数はありません。
＜戻り値＞
以下をPromise<Object>型で設定します。
- data：API「GET /api/v1/practice-contexts/{id}」で取得されるdtos.ContextDtoと同じ値
- relatedData.schedule：API「GET /api/v1/schedules/{id}」で取得されるdtos.ScheduleDTOと同じ値
- relatedData.workflow：Workflowのマニフェストファイルで定義した値
APIの詳細については「JP1 Cloud Service 運用統合 APIリファレンス」の「APIリファレンス詳細＞標準提供API」、Workflowのマニフェストの詳細は「（表）Workflow定義」を参照してください。
（b）OIUi.getName
UI名を取得します。
引数はありません。
＜戻り値＞
Promiseが解決されると、Promise<string>型でUI名を返却します。
（8）OIActionButton
OIActionButtonクラスの関数の詳細は以下の通りです。
（a）OIActionButton.setVisible
ボタンの表示、非表示を設定します。
引数は下表の通りです。
（表）OIActionButton.setVisibleの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | isVisible | "true"（表示）または"false"（非表示）を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（b）OIActionButton.setEnable
ボタンの活性、非活性を設定します。
引数は下表の通りです。
（表）OIActionButton.setEnableの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | isEnable | "true"（活性）または"false"（非活性）を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（9）OIButton
OIButtonクラスの関数の詳細は以下の通りです。
（a）OIButton.setVisible
ボタンの表示、非表示を設定します。
引数は下表の通りです。
（表）OIButton.setVisibleの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | buttonName | ボタン一覧内の対象のボタン名 | |
| boolean | isVisible | "true"（表示）または"false"（非表示）を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（b）OIButton.setEnable
ボタンの活性、非活性を設定します。
引数は下表の通りです。
（表）OIButton.setEnableの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | buttonName | ボタン一覧内の対象のボタン名 | |
| boolean | isEnable | "true"（活性）または"false"（非活性）を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（10）OITableDataSource
OITableDataSourceクラスの関数の詳細は以下の通りです。
（a）OITableDataSource.refresh
データの再取得、およびデータソース使用箇所への取得データを反映します。
引数は下表の通りです。
（表）OITableDataSource.refreshの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | loading | ローディングアイコンの表示有無（省略時：表示なし） | |
＜戻り値＞
完了するまで待機するPromise<undefined>を返却します。
（b）OITableDataSource.setAutorefreshSeconds
自動リフレッシュ間隔を設定します。
引数は下表の通りです。
（表）OITableDataSource.setAutorefreshSecondsの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| number | secondsValue | 自動リフレッシュ間隔（秒）を整数で指定する。 | |
＜戻り値＞
完了するまで待機するPromise<undefined>を返却します。
（c）OITableDataSource.getParameter
指定されたデータソース名のパラメータの設定を取得します。
引数は下表の通りです。
（表）OITableDataSource.getParameterの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | paramName | 指定されたデータソース名のパラメータ名を指定する。 | |
＜戻り値＞
取得した情報をPromise<DataSourceParameter>型またはPromise<undefined>で返却します。
指定されたparamNameに一致しない場合はPromise<undefined>を返却します。
（d）OITableDataSource.setParameter
指定されたデータソース名のパラメータを設定します（指定されたパラメータが存在する場合は上書き、しない場合は作成します）。
引数は下表の通りです。
（表）OITableDataSource.setParameterの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | paramName | 指定されたデータソース名のパラメータ名を指定する。 | |
| TableDataSourceParameter | parameter | 更新するパラメータオブジェクトを指定する。 例： { type: ' fixed' , value: ' true' , } typeは' fixed' 、' query' 、' uipath' から指定、valueは文字列を指定する。またnull、undefinedも指定できる。 |
|
＜戻り値＞
完了するまで待機するPromise<undefined>を返却します。
（e）OITableDataSource.deleteParameter
指定されたデータソース名のパラメータの構成を削除します。
引数は下表の通りです。
（表）OITableDataSource.deleteParameterの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | paramName | 指定されたデータソース名のパラメータ名を指定する。 | |
＜戻り値＞
完了するまで待機するPromise<undefined>を返却します。
（f）OITableDataSource.update
Tableデータソースによって参照されるリソースの更新を実行します。
引数は下表の通りです。
（表）OITableDataSource.updateの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | options | 以下を指定する。
|
|
＜戻り値＞
完了するまで待機するPromiseを返却します。
（g）OITableDataSource.create
Tableデータソースによって参照されるリソースの作成を実行します。
引数は下表の通りです。
（表）OITableDataSource.createの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | options | 以下を指定する。
|
|
＜戻り値＞
完了するまで待機するPromiseを返却します。
（h）OITableDataSource.delete
Tableデータソースによって参照されるリソースの削除を実行します。
引数は下表の通りです。
（表）OITableDataSource.deleteの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | options | 以下を指定する。
|
|
＜戻り値＞
完了するまで待機するPromiseを返却します。
（11）OIViewDataSource
OIViewDataSourceクラスの関数の詳細は以下の通りです。
（a）OIViewDataSource.refresh
データの再取得、およびデータソース使用箇所への取得データを反映します。
引数は下表の通りです。
（表）OIViewDataSource.refreshの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | loading | ローディングアイコンの表示有無（省略時：表示なし） | |
＜戻り値＞
完了するまで待機するPromise<undefined>を返却します。
（b）OIViewDataSource.setAutorefreshSeconds
自動リフレッシュ間隔を設定します。
引数は下表の通りです。
（表）OIViewDataSource.setAutorefreshSecondsの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| number | secondsValue | 自動リフレッシュ間隔（秒）を整数で指定する。 | |
＜戻り値＞
完了するまで待機するPromise<undefined>を返却します。
（c）OIViewDataSource.getParameter
指定されたデータソース名のパラメータの設定を取得します。
引数は下表の通りです。
（表）OIViewDataSource.getParameterの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | paramName | 指定されたデータソース名のパラメータ名を指定する。 | |
＜戻り値＞
取得した情報をPromise<ViewDataSourceParameter>型またはPromise<undefined>で返却します。
指定されたparamNameに一致しない場合はPromise<undefined>を返却します。
（d）OIViewDataSource.setParameter
指定されたデータソース名のパラメータを設定します（指定されたパラメータが存在する場合は上書き、しない場合は作成します）。
引数は下表の通りです。
（表）OIViewDataSource.setParameterの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | paramName | 指定されたデータソース名のパラメータ名を指定する。 | |
| ViewDataSourceParameter | parameter | 更新するパラメータオブジェクトを指定する。 例： { type: ' fixed' , value: ' true' , } typeは' fixed' 、' query' 、' uipath' から指定、valueは文字列を指定する。またnull、undefinedも指定できる。 |
|
＜戻り値＞
完了するまで待機するPromise<undefined>を返却します。
（e）OIViewDataSource.deleteParameter
指定されたデータソース名のパラメータの構成を削除します。
引数は下表の通りです。
（表）OIViewDataSource.deleteParameterの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | paramName | 指定されたデータソース名のパラメータ名を指定する。 | |
＜戻り値＞
完了するまで待機するPromise<undefined>を返却します。
（12）OIForm
OIFormクラスの関数の詳細は以下の通りです。
（a）OIForm.setStatus
フォームのフィールドのステータスを設定します。
バリデーションエラーを出す機能があるフィールドタイプのみ対応します。
引数は下表の通りです。
（表）OIForm.setStatusの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | field | ステータスを設定する対象のフィールド名を指定する。 | |
| string | status | ステータスを設定する。 "error"を設定するとエラー状態となり、それ以外はエラー状態が解除される。 |
|
＜戻り値＞
対象のフィールドに引数statusの値が反映されるまで待機するPromise<undefined>を返却します。
（b）OIForm.setHelperText
フォームのフィールドのヘルパーテキストを設定します。
バリデーションエラーメッセージを出す機能があるフィールドタイプのみ対応します。
引数は下表の通りです。
（表）OIForm.setHelperTextの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | field | ヘルパーテキストを設定する対象のフィールド名を指定する。 | |
| string | helperText | ヘルパーテキストを設定する。 | |
＜戻り値＞
対象のフィールドに引数helperTextの値が反映されるまで待機するPromise<undefined>を返却します。
（c）OIForm.removeHelperText
フォームのフィールドのヘルパーテキストを削除します。
バリデーションエラーメッセージを出す機能があるフィールドタイプのみ対応します。
引数は下表の通りです。
（表）OIForm.removeHelperTextの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | field | ヘルパーテキストを削除するフィールドの名前を指定する。 | |
＜戻り値＞
対象のフィールドからhelperTextの値が削除されるまで待機するPromise<undefined>を返却します。
（d）OIForm.getFieldValue
フィールドの値を取得します。
引数は下表の通りです。
（表）OIForm.getFieldValueの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | fieldName | フィールドの名前を指定する。 | |
＜戻り値＞
フィールドの値をPromise<object>型で返却します。
（e）OIForm.getFieldValues
すべてのフィールドの値を取得します。
引数はありません。
＜戻り値＞
すべてのフィールドの値をPromise<object>型で返却します。
（f）OIForm.getFieldExtension
フィールドの各種情報を取得します。
引数は下表の通りです。
（表）OIForm.getFieldExtensionの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | fieldName | フィールドの名前を指定する。 | |
＜戻り値＞
フィールドの各種情報をPromise<object>型で返却します。
（g）OIForm.getFieldExtensions
すべてのフィールドの各種情報を取得します。
引数はありません。
＜戻り値＞
すべてのフィールドの各種情報をPromise<object>型で返却します。
（h）OIForm.setFieldValue
フィールドの値を設定します。
引数は下表の通りです。
（表）OIForm.setFieldValueの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | fieldName | フィールドの名前を指定する。 | |
| any | fieldValue | フィールドの値を指定する。 | |
＜戻り値＞
対象のフィールドに引数fieldValueの値が反映されるまで待機するPromise<undefined>を返却します。
（i）OIForm.setFieldExtensions
フィールドの各種情報を設定します。
引数は下表の通りです。
（表）OIForm.setFieldExtensionsの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | fieldName | フィールドの名前を指定する。 | |
| object | extensions | フィールドの各種情報を指定する。 | |
＜戻り値＞
対象のフィールドに引数extensionsの値が反映されるまで待機するPromise<undefined>を返却します。
（j）OIForm.setFieldVisible
フィールドの表示または非表示を設定します。
引数は下表の通りです。
（表）OIForm.setFieldVisibleの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | fieldName | フィールドの名前を指定する。 | |
| boolean | visibility | フィールドの表示または非表示を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（k）OIForm.validate
Formのバリデーション結果を取得します。
引数はありません。
＜戻り値＞
Formのバリデーション結果をPromise<boolean>型で返却します。
- true：エラーなし
- false：エラーあり
（l）OIForm.setLookupLabelQuery
対象のルックアップフィールドのlabelQueryを設定します。
引数は下表の通りです。
（表）OIForm.setLookupLabelQueryの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | fieldName | 対象のフィールドの名前を指定する。 | |
| string | value | ルックアップフィールドのlabelQueryの値を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（m）OIForm.getLookupLabelQuery
対象フィールドに設定されたlabelQueryを取得します。
引数は下表の通りです。
（表）OIForm.getLookupLabelQueryの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | fieldName | 対象のフィールドの名前を指定する。 | |
＜戻り値＞
対象のフィールドがルックアップフィールドではない場合、またはlabelQueryプロパティが省略されている場合はPromise<undefined>を返却します。
（n）OIForm.setEnable
対象のフォームが活性または非活性かを設定します。
Ops Iのv02-90以降は、代わりにsetReadOnlyの使用を推奨します。
引数は下表の通りです。
（表）OIForm.setEnableの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | isEnable | "true"（活性）または"false"（非活性）を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（o）OIForm.setFieldEnable
対象のフィールドが活性または非活性かを設定します。
Ops Iのv02-90以降は、代わりにsetFieldReadOnlyの使用を推奨します。
引数は下表の通りです。
（表）OIForm.setFieldEnableの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | fieldName | 対象のフィールドの名前を指定する。 | |
| boolean | isEnable | "true"（活性）または"false"（非活性）を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（p）OIForm.setReadOnly
対象のフォームが読み取り専用または書き込み可能かを設定します。
引数は下表の通りです。
（表）OIForm.setReadOnlyの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | isReadOnly | "true"（読み取り専用）または"false"（書き込み可能）を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（q）OIForm.setFieldReadOnly
対象のフィールドが読み取り専用または書き込み可能かを設定します。
引数は下表の通りです。
（表）OIForm.setFieldReadOnlyの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | fieldName | 対象のフィールドの名前を指定する。 | |
| boolean | isReadOnly | "true"（読み取り専用）または"false"（書き込み可能）を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（r）OIForm.getEnumValues
Enum型のフィールドに設定されている選択肢を取得します。
引数は下表の通りです。
（表）OIForm.getEnumValuesの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | fieldName | 対象のフィールドの名前を指定する。 | |
＜戻り値＞
Enum型のフィールドが保持するオプションをPromise<EnumValue[]>型で返却します。
EnumValue型：string | { name: string, label?: string }
フィールドがEnum型ではない場合は、Promise
（s）OIForm.setEnumValues
Enum型のフィールドに対し、任意の選択肢を設定します。
フィールドがEnum型ではない場合は、何も設定されません。
引数は下表の通りです。
（表）OIForm.setEnumValuesの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | fieldName | 対象のフィールドの名前を指定する。 | |
| EnumValue[] | values | Enum型のフィールドに対し、任意の選択肢を設定する。 EnumValue型：string | { name: string, label?: string } |
|
＜戻り値＞
設定されるまで待機するPromise<undefined>型を返却します。
（13）OITable
OITableクラスの関数の詳細は以下の通りです。
（a）OITable.setRows
対象のテーブルに表示している行を置き換えます。
modeに指定された値によって、置き換えることができるレコードの対象が異なります。
- client：表示されていないページを含めたすべてのレコードが対象
- server：表示されているページのすべてのレコードが対象
引数は下表の通りです。
（表）OITable.setRowsの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| object[] | rows | 行データを指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（b）OITable.addRows
対象のテーブルに表示する行を追加します。
modeに"server"が指定されている場合、表示しているページに追加されます。ページネーション時に再度レコードが取得されるため、データソースのリソースが更新されないと追加した行がリセットされます。
引数は下表の通りです。
（表）OITable.addRowsの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| object[] | rows | 末尾に追加する行データを指定する。 | |
＜戻り値＞
追加が完了するまで待機するPromise<undefined>を返却します。
（c）OITable.deleteRows
対象のテーブルに表示されている行を削除します。
modeに"server"が指定されている場合、表示しているページからのみ削除されます。ページネーション時に再度レコードが取得されるため、データソースのリソースから削除されないと削除した行が再表示されます。
引数は下表の通りです。
（表）OITable.deleteRowsの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string[] | number[] | rowIds | 削除する行のIDの配列を指定する。 | |
＜戻り値＞
削除された行のデータをPromise<object[]>型の配列で返却します。1件削除された場合は要素数1の配列、0件の場合は空配列を返却します。
（d）OITable.getRows
行データを取得します。
modeに指定された値によって、取得するレコードに差異が生じます。
- client：表示されていないページを含めたすべてのレコードを取得
- server：表示されているページのすべてのレコードを取得
引数はありません。
＜戻り値＞
テーブルの行データをPromise<object[]>型で返却します。
（e）OITable.getSelectedIds
選択されている行のIDを取得します。
引数はありません。
＜戻り値＞
選択されている行のIDをPromise<(string | number)[]>型で返却します。
（f）OITable.setSelectedIds
対象のテーブルの選択状態を変更します。
指定されなかった行はすべて非選択状態になります。空配列が指定されたときはすべて選択を解除します。Tableコンポーネントのproperties.selection:が"radio"の場合は、配列の先頭のIDのみ反映します。
この関数を実行すると、対象のテーブルに設定されているhandleSelectionModelChange関数が続いて呼び出されます。
引数は下表の通りです。
（表）OITable.setSelectedIdsの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string[] | number[] | rowIds | 選択行のIDを配列で指定する。 | |
＜戻り値＞
設定が完了するまでPromise<undefined>を返却します。
（g）OITable.getSelectedRows
テーブルの選択した行の全データを取得します。
引数はありません。
＜戻り値＞
テーブルの選択した行の全データをPromise<object>型で返却します。
（14）OITabs
OITabsクラスの関数の詳細は以下の通りです。
（a）OITabs.getTabs
インスタンスに属する全タブ情報の配列を取得します。
UIのマニフェストファイルの"type: tab"コンポーネントでvisibleプロパティがfalseのタブは配列に含まれません。
引数はありません。
＜戻り値＞
インスタンスに属する全タブ情報の配列をOITabs.addTab関数の引数と同じ型で設定します。OITabs.addTab関数の引数は、「（表）OITabs.addTabの引数（UIバージョン1.1）」を参照してください。
（b）OITabs.addTab
指定したタブを追加します。
以下の場合TypeErrorとなります。
- paramsがプレーンオブジェクトやOITabのインスタンスのいずれでもない場合
- params.nameが文字列ではない場合
引数は下表の通りです。
（表）OITabs.addTabの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| object | params | 追加するタブのパラメータを指定する。 | |
| string | params.name | 追加するタブの名前を指定する。 この名前はUIのマニフェストファイルのTabコンポーネントの名前を指定する。 |
|
| string | params.id | タブの内部IDを指定する。 タブ内で一意の必要がある。省略すると自動的にIDが割り当てられる。 |
|
| string | params.label | タブのラベルを指定する。 省略すると自動的にラベルが割り当てられる。 |
|
| boolean | params.visible | "true"（表示）または"false"（非表示）を指定する。 デフォルトはtrueである。 |
|
| string | params.queryParameter | タブがアクティブになったときに現在のURLに追加するクエリパラメータを"key=value"の形式で指定する。 | |
| object | params.state | タブの状態を設定する。 | |
＜戻り値＞
追加が完了するまで待機するPromise<undefined>を返却します。
（c）OITabs.activateTab
指定したタブをアクティブにします。
indexが整数ではない場合、TypeErrorとなります。
引数は下表の通りです。
（表）OITabs.activateTabの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| number | index | アクティブにするタブのインデックスを指定する。 デフォルトは0である。 |
|
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（d）OITabs.getActiveTab
アクティブなタブを取得します。
引数はありません。
＜戻り値＞
アクティブなタブが0の場合、Promise<undefined>を返却します。
（15）OITab
OITabクラスの関数の詳細は以下の通りです。
（a）OITab.getForm
タブに対応するコンテンツに含まれるOIFormのインスタンスを取得します。
nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OITab.getFormの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | タブ上のフォームの名前を指定する。 | |
＜戻り値＞
タブに対応するコンテンツに含まれるOIFormのインスタンスを返却します。
（b）OITab.getTable
タブに対応するコンテンツに含まれるOITableのインスタンスを取得します。
nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OITab.getTableの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | タブ上のテーブルの名前を指定する。 | |
＜戻り値＞
タブに対応するコンテンツに含まれるOITableのインスタンスを返却します。
（c）OITab.getTabs
タブに対応するコンテンツに含まれるOITabsのインスタンスを取得します。
nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OITab.getTabsの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | タブ上のタブの名前を指定する。 | |
＜戻り値＞
タブに対応するコンテンツに含まれるOITabsのインスタンスを返却します。
（d）OITab.getArticle
タブに対応するコンテンツに含まれるOIArticleのインスタンスを取得します。
nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OITab.getArticleの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | タブ上のアーティクルの名前を指定する。 | |
＜戻り値＞
タブに対応するコンテンツに含まれるOIArticleのインスタンスを返却します。
（e）OITab.getButton
タブに対応するコンテンツに含まれるOIButtonのインスタンスを取得します。
nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OITab.getButtonの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | タブ上のボタンの名前を指定する。 | |
＜戻り値＞
タブに対応するコンテンツに含まれるOIButtonのインスタンスを返却します。
（f）OITab.getAttachment
タブに対応するコンテンツに含まれるOIAttachmentのインスタンスを取得します。
nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OITab.getAttachmentの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | タブ上の添付ファイルの名前を指定する。 | |
＜戻り値＞
タブに対応するコンテンツに含まれるOIAttachmentのインスタンスを返却します。
（g）OITab.getCard
タブに対応するコンテンツに含まれるOICardのインスタンスを取得します。
nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OITab.getCardの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | タブ上のCardの名前を指定する。 | |
＜戻り値＞
タブに対応するコンテンツに含まれるOICardのインスタンスを返却します。
（h）OITab.getTableDataSource
タブに対応するコンテンツに含まれるOITableDataSourceのインスタンスを取得します。
nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OITab.getTableDataSourceの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | タブ上のデータソースの名前を指定する。 | |
＜戻り値＞
タブに対応するコンテンツに含まれるOITableDataSourceのインスタンスを返却します。
（i）OITab.getLabel
タブに対応するコンテンツに含まれるOILabelのインスタンスを取得します。
nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OITab.getLabelの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | タブ上のラベルの名前を指定する。 | |
＜戻り値＞
タブに対応するコンテンツに含まれるOILabelのインスタンスを返却します。
（j）OITab.OIViewDataSource
タブに対応するコンテンツに含まれるOIViewDataSourceのインスタンスを取得します。
nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OITab.OIViewDataSourceの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | タブ上のデータソースの名前を指定する。 | |
＜戻り値＞
タブに対応するコンテンツに含まれるOIViewDataSourceのインスタンスを返却します。
（16）OIArticle
OIArticleクラスの関数の詳細は以下の通りです。
（a）OIArticle.setAutorefreshSeconds
自動リフレッシュ間隔を設定します。
secondsValueが整数でない場合、TypeErrorになります。
引数は下表の通りです。
（表）OIArticle.setAutorefreshSecondsの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| number | secondsValue | 自動リフレッシュ間隔（秒） | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（17）OIAttachment
OIAttachmentクラスの関数の詳細は以下の通りです。
（a）OIAttachment.saveFiles
添付ファイルを保存します。
secondsValueが整数でない場合、TypeErrorになります。
引数はありません。
＜戻り値＞
保存が完了するまで待機するPromise<undefined>を返却します。
（18）OICard
OICardクラスの関数の詳細は以下の通りです。
（a）OICard.setContent
表示内容を設定します。
secondsValueが整数でない場合、TypeErrorになります。nameが存在しない場合も、TypeErrorになります。
引数は下表の通りです。
（表）OICard.setContentの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | content | 表示内容を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（b）OICard.setLink
リンク先を設定します。
secondsValueが整数でない場合、TypeErrorになります。nameが存在しない場合も、TypeErrorになります。
引数は下表の通りです。
（表）OICard.setLinkの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | link | リンク先を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（19）OIPaper
OIPaperクラスの関数の詳細は以下の通りです。
（a）OIPaper.setVisible
Paperの表示または非表示を指定します。
引数は下表の通りです。
（表）OIPaper.setVisibleの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | visibility | "true"（表示）または"false"（非表示）を指定する。 | |
＜戻り値＞
戻り値はありません。
（20）OILabel
OILabelクラスの関数の詳細は以下の通りです。
（a）OILabel.setContent
ラベルの値を設定します。
引数は下表の通りです。
（表）OILabel.setContentの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | content | ラベルの値を設定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（b）OILabel.getContent
ラベルの値を取得します。
引数はありません。
＜戻り値＞
ラベルの値をPromise<string>型で返却します。
（21）OIIcon
OIIconクラスの関数の詳細は以下の通りです。
（a）OIIcon.setVisible
アイコンの表示、非表示を設定します。
引数は下表の通りです。
（表）OIIcon.setVisibleの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| boolean | isVisible | "true"（表示）または"false"（非表示）を指定する。 | |
＜戻り値＞
設定が完了するまで待機するPromise<undefined>型を返却します。
（22）OIItemList
OIItemListクラスの関数の詳細は以下の通りです。
（a）OIItemList.getItems
アイテムリストに表示されているアイテムを取得します。
引数はありません。
＜戻り値＞
取得した情報をPromise<OIItem[]>型で返却します。
（b）OIItemList.setItemsData
アイテムリストのデータを設定します。
既に設定されているデータは、指定されたデータで上書きされます。
引数は下表の通りです。
（表）OIItemList.setItemsDataの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| Object[] | data | アイテムリストに表示するデータを指定する。 | |
＜戻り値＞
データの設定が完了するまで待機するPromise<undefined>を返却します。
（c）OIItemList.addItemsData
アイテムリストにデータを追加します。
指定したデータは、既に設定されているデータの末尾に追加されます。
引数は下表の通りです。
（表）OIItemList.addItemsDataの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| Object[] | data | アイテムリストに表示するデータを指定する。 | |
＜戻り値＞
データの追加が完了するまで待機するPromise<undefined>を返却します。
（d）OIItemList.reload
アイテムリストのデータを再読み込みします。
「さらに表示」ボタンによる追加読み込みの状態はリセットされます。
引数は下表の通りです。
（表）OIItemList.reloadの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| Object | options | － | |
| boolean | loading | ローディングアイコンの表示有無（省略時：表示なし） | |
＜戻り値＞
再読み込みが完了するまで待機するPromise<undefined>を返却します。
（e）OIItemList.setSelectedItemIds
対象のアイテムの選択状態を変更します。
引数は下表の通りです。
（表）OIItemList.setSelectedItemIdsの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string[] | number[] | itemIDs | 選択アイテムのIDを配列で指定する。 空配列が指定された場合は、選択状態をすべて解除する。 マニフェストでselectionModeに"single"が設定されている場合は、配列の先頭のアイテムIDのみ選択状態にする。 |
|
＜戻り値＞
設定が完了するまで待機するPromise<undefined>を返却します。
（f）OIItemList.getSelectedItemIds
選択されているアイテムのIDを取得します。
引数はありません。
＜戻り値＞
取得した情報をPromise<(string | number)[]>型で返却します。
（g）OIItemList.getSelectedItems
選択されているアイテムを取得します。
引数はありません。
＜戻り値＞
選択されているアイテムをPromise<OIItem[]>型で返却する。
（h）OIItemList.getCurrentItem
対象のコンポーネント（button, iconなど）を含んでいるアイテムを取得するstatic関数です。
例えば、アイテム内にbuttonコンポーネントがあり、そのbuttonのaction内の関数（handleClickなど）でgetCurrentItem()を実行すると、そのbuttonが属するアイテムのOIItemインスタンスが取得されます。
引数はありません。
＜戻り値＞
取得したアイテムをPromise<OIItem | null>型で返却します。対象のコンポーネントがアイテムに含まれていない場合は、Promise解決後にnullが返却されます。
（23）OIItem
OIItemインスタンスは、OIItemListインスタンスのメソッドの戻り値として受け取ります。OIItemクラスから直接インスタンスを生成することは想定されていません。
OIItemのプロパティには読み取り専用の「data」があり、アイテムに対応する行データを参照できます。
OIItemクラスの関数の詳細は以下の通りです。
（a）OIItem.getButton
アイテム内に存在する、指定されたnameのOIButtonインスタンスを取得します。nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OIItem.getButtonの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | アイテム内のButtonコンポーネントのnameを指定する。 | |
＜戻り値＞
OIButtonのインスタンスを返却します。
（b）OIItem.getCard
アイテム内に存在する、指定されたnameのOICardインスタンスを取得します。nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OIItem.getCardの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | アイテム内のCardコンポーネントのnameを指定する。 | |
＜戻り値＞
OICardのインスタンスを返却します。
（c）OIItem.getPaper
アイテム内に存在する、指定されたnameのOIPaperインスタンスを取得します。nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OIItem.getPaperの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | アイテム内のPaperコンポーネントのnameを指定する。 | |
＜戻り値＞
OIPaperのインスタンスを返却します。
（d）OIItem.getLabel
アイテム内に存在する、指定されたnameのOILabelインスタンスを取得します。nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OIItem.getLabelの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | アイテム内のLabelコンポーネントのnameを指定する。 | |
＜戻り値＞
OILabelのインスタンスを返却します。
（e）OIItem.getIcon
アイテム内に存在する、指定されたnameのOIIconインスタンスを取得します。nameが存在しない場合、TypeErrorになります。
引数は下表の通りです。
（表）OIItem.getIconの引数（UIバージョン1.1）
| データ形式 | 変数名 | 設定する値 | |
|---|---|---|---|
| string | name | アイテム内のIconコンポーネントのnameを指定する。 | |
＜戻り値＞
OIIconのインスタンスを返却します。
＜定義例＞
async function handleCellClick(_, row) {
const ticketID = row.id;
const tabs = new OITabs('ticket_tabs');
const tabDetails = await tabs.getTabs();
const existingTicketTabIndex = tabDetails.findIndex(
(detail) => detail.id === ticketID,
);
if (existingTicketTabIndex !== -1) {
tabs.activateTab(existingTicketTabIndex);
} else {
tabs.addTab({
name: 'ticket_detail_tab',
id: ticketID,
label: row.number,
queryParameter: 'id=${ticketID}',
});
}
}