スクリプト開発向けim-BizAPI

ExternalMenuManagerオブジェクト

コンポーネント情報
version8.0.7
コンポーネント概要
外部メニューマネージャクラスです。
外部サービスのメニュー情報にアクセスするためのマネージャクラスです。

コンストラクタの概要

ExternalMenuManager ()
コンストラクタ。

メソッドの概要

返却値の型 メソッド名
ResultObject createExternalMenuLinkId (String providerId, String menuId) static
既定の書式で外部メニューリンク情報をフォーマットします。
ResultObject getAvailableMenuTree (MenuProvider provider, String userCd, String clientTypeId, String category)
引数で指定したユーザの利用可能なメニュー構成情報を、指定のメニュープロバイダから取得します。
ResultObject getAvailableMenuTree (String userCd, String clientTypeId, String category)
引数で指定したユーザの利用可能なメニュー構成情報を、設定された全てのメニュープロバイダから取得します。
ResultObject getManagedMenuTree (MenuProvider provider, String userCd, String clientTypeId, String category)
引数で指定したユーザの管理可能なメニュー構成情報を、指定のメニュープロバイダから取得します。
ResultObject getManagedMenuTree (String userCd, String clientTypeId, String category)
引数で指定したユーザの管理可能なメニュー構成情報を、設定された全てのメニュープロバイダから取得します。
ResultObject getMenuProviders ()
有効な外部メニュープロバイダの一覧を取得します。
ResultObject getMenuProviders (Boolean editable)
外部メニュープロバイダの一覧を取得します。
ResultObject invalidate (String providerId)
メニュープロバイダを無効化します。
Boolean isEnable ()
外部連携が有効かどうかを取得します。
ResultObject parseExternalMenuLinkId (String string) static
既定の書式の文字列から、プロバイダIDとメニューIDを取得します。

コンストラクタの詳細

ExternalMenuManager ()
コンストラクタ。

メソッドの詳細

ResultObject createExternalMenuLinkId (String providerId, String menuId) static
既定の書式で外部メニューリンク情報をフォーマットします。
外部メニューリンクでは、URLプロパティに、以下の書式で設定されます。 
   im-external-link://(プロバイダID)/(メニューID)
パラメータ
providerId : String
プロバイダID
menuId : String
メニューID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには フォーマットされた文字列 が設定されます。
ResultObject getAvailableMenuTree (MenuProvider provider, String userCd, String clientTypeId, String category)
引数で指定したユーザの利用可能なメニュー構成情報を、指定のメニュープロバイダから取得します。
パラメータ
provider : MenuProvider
メニュー情報取得先のメニュープロバイダ
userCd : String
対象のユーザコード
clientTypeId : String
対象のクライアントタイプID
category : String
対象のメニューグループカテゴリ
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには 利用可能な メニュー構成情報 が設定されます。
ResultObject getAvailableMenuTree (String userCd, String clientTypeId, String category)
引数で指定したユーザの利用可能なメニュー構成情報を、設定された全てのメニュープロバイダから取得します。
パラメータ
userCd : String
対象のユーザコード
clientTypeId : String
対象のクライアントタイプID
category : String
対象のメニューグループカテゴリ
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには 利用可能な メニュー構成情報 が設定されます。
ResultObject getManagedMenuTree (MenuProvider provider, String userCd, String clientTypeId, String category)
引数で指定したユーザの管理可能なメニュー構成情報を、指定のメニュープロバイダから取得します。
パラメータ
provider : MenuProvider
メニュー情報取得先のメニュープロバイダ
userCd : String
対象のユーザコード
clientTypeId : String
対象のクライアントタイプID
category : String
対象のメニューグループカテゴリ
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには 管理可能な メニュー構成情報 が設定されます。
ResultObject getManagedMenuTree (String userCd, String clientTypeId, String category)
引数で指定したユーザの管理可能なメニュー構成情報を、設定された全てのメニュープロバイダから取得します。
パラメータ
userCd : String
対象のユーザコード
clientTypeId : String
対象のクライアントタイプID
category : String
対象のメニューグループカテゴリ
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには 管理可能な メニュー構成情報 が設定されます。
ResultObject getMenuProviders ()
有効な外部メニュープロバイダの一覧を取得します。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには 外部メニュープロバイダ の一覧 が設定されます。
ResultObject getMenuProviders (Boolean editable)
外部メニュープロバイダの一覧を取得します。
パラメータ
editable : Boolean

true の場合、管理画面で管理可能なメニュープロバイダのみ取得します。
false の場合、有効なすべてのメニュープロバイダを取得します。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには 外部メニュープロバイダ の一覧 が設定されます。
ResultObject invalidate (String providerId)
メニュープロバイダを無効化します。
パラメータ
providerId : String
無効化するメニュープロバイダID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。
Boolean isEnable ()
外部連携が有効かどうかを取得します。
返却値
Boolean
Boolean 外部連携が有効の場合 true、無効の場合 false を返却します。
ResultObject parseExternalMenuLinkId (String string) static
既定の書式の文字列から、プロバイダIDとメニューIDを取得します。
外部メニューリンクでは、URLプロパティに、以下の書式で設定されます。 
   im-external-link://(プロバイダID)/(メニューID)
パラメータ
string : String
プロバイダIDとメニューIDを表す文字列
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには ExternalMenuLinkId# オブジェクトが設定されます。

Copyright © 2012 NTT DATA INTRAMART CORPORATION