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

MyMenuItemManagerオブジェクト

コンポーネント情報
version8.0
since8.0
コンポーネント概要
マイメニューアイテムマネージャクラスです。

マイメニューアイテム情報の操作を行います。

コンストラクタの概要

MyMenuItemManager ()
コンストラクタ。

メソッドの概要

返却値の型 メソッド名
ResultObject addMyMenuCategory (String userCd, String clientTypeId)
マイメニューアイテム情報を登録するためのカテゴリを新規作成します。
ResultObject addMyMenuItem (String userCd, String parentMenuId, MyMenuItem myMenuItem)
マイメニューアイテム情報を新規作成します。
ResultObject copy2MyMenu (String userCd, String menuId, String parentMenuId)
メニューアイテムをマイメニューアイテムにコピーします。
ResultObject copyMyMenuTree (String userCd, String menuId, String parentMenuId)
マイメニューアイテムをコピーします。
ResultObject deleteMyMenuItem (String userCd, String menuId)
マイメニューアイテム情報を削除します。
ResultObject deleteMyMenu (String userCd)
指定されたユーザに登録されているすべてのマイメニューを削除します。
ResultObject getChildMenuIds (String userCd, String menuId)
子ノードのマイメニューIDリストを取得します。
ResultObject getChildren (String userCd, String menuId)
子ノードのマイメニューアイテム情報のリストを取得します。
ResultObject getMyMenuItem (String userCd, String menuId)
マイメニューアイテム情報を取得します。
ResultObject getMyMenuItemsByUrl (String userCd, String url)
指定されたURLに紐づくマイメニューアイテム情報のリストを取得します。
ResultObject getMyMenuNode (String userCd, String menuId)
指定されたマイメニューIDに紐づくマイメニュー構成情報を取得します。
ResultObject getRootMyMenuItem (String userCd, String clientTypeId)
ルートのマイメニューアイテム情報を取得します。
ResultObject getRootMyMenuTree (String userCd, String clientTypeId)
ルートのマイメニュー構成情報を取得します。
ResultObject hasMyMenuItemsByUrl (String userCd, String url)
指定されたURLに紐づくマイメニューアイテム情報が存在するかどうか取得します。
ResultObject moveMyMenuNode (String userCd, String menuId, String parentMenuId)
マイメニューアイテムを移動します。
ResultObject updateMyMenuItemId (String userCd, String from, String to)
マイメニューIDを変更します。
ResultObject updateMyMenuItem (String userCd, MyMenuItem myMenuItem)
マイメニューアイテム情報を更新します。

コンストラクタの詳細

MyMenuItemManager ()
コンストラクタ。

メソッドの詳細

ResultObject addMyMenuCategory (String userCd, String clientTypeId)
マイメニューアイテム情報を登録するためのカテゴリを新規作成します。
パラメータ
userCd : String
ユーザコード
clientTypeId : String
クライアントタイプID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには マイメニューアイテム情報 が設定されます。
ResultObject addMyMenuItem (String userCd, String parentMenuId, MyMenuItem myMenuItem)
マイメニューアイテム情報を新規作成します。
パラメータ
userCd : String
ユーザコード
parentMenuId : String
親マイメニューID
myMenuItem : MyMenuItem
追加するマイメニューアイテム情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。
ResultObject copy2MyMenu (String userCd, String menuId, String parentMenuId)
メニューアイテムをマイメニューアイテムにコピーします。

指定されたマイメニューIDのメニュー構成を、指定された親のマイメニューIDの配下にコピーします。
コピー後の各マイメニューIDは自動的に新しいものが採番されます。

この API はサイトマップなどテナントのメニューからのコピー専用です。
マイメニューをコピーする場合は copyMyMenuTree を使用してください。
パラメータ
userCd : String
ユーザコード
menuId : String
コピーするマイメニューID
parentMenuId : String
コピー先の親マイメニューID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティにはコピーされた マイメニュー構成情報 が設定されます。
ResultObject copyMyMenuTree (String userCd, String menuId, String parentMenuId)
マイメニューアイテムをコピーします。

指定されたマイメニューIDのマイメニュー構成を、指定された親のマイメニューIDの配下にコピーします。
コピー後の各マイメニューIDは自動的に新しいものが採番されます。

この API はマイメニュー内でのコピー専用です。
サイトマップなどテナントのメニューからコピーする場合は copy2MyMenu を使用してください。
パラメータ
userCd : String
ユーザコード
menuId : String
コピーするマイメニューID
parentMenuId : String
コピー先の親マイメニューID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティにはコピーされた マイメニュー構成情報 が設定されます。
ResultObject deleteMyMenuItem (String userCd, String menuId)
マイメニューアイテム情報を削除します。
パラメータ
userCd : String
ユーザコード
menuId : String
マイメニューID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。
ResultObject deleteMyMenu (String userCd)
指定されたユーザに登録されているすべてのマイメニューを削除します。
パラメータ
userCd : String
ユーザコード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。
ResultObject getChildMenuIds (String userCd, String menuId)
子ノードのマイメニューIDリストを取得します。
パラメータ
userCd : String
ユーザコード
menuId : String
親のマイメニューID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティにはマイメニューIDのリストが設定されます。
ResultObject getChildren (String userCd, String menuId)
子ノードのマイメニューアイテム情報のリストを取得します。
パラメータ
userCd : String
ユーザコード
menuId : String
マイメニューID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには マイメニューアイテム情報 のリストが設定されます。
ResultObject getMyMenuItem (String userCd, String menuId)
マイメニューアイテム情報を取得します。
パラメータ
userCd : String
ユーザコード
menuId : String
マイメニューID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには マイメニューアイテム情報 が設定されます。
ResultObject getMyMenuItemsByUrl (String userCd, String url)
指定されたURLに紐づくマイメニューアイテム情報のリストを取得します。
パラメータ
userCd : String
ユーザコード
url : String
URL
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには マイメニューアイテム情報 のリストが設定されます。
ResultObject getMyMenuNode (String userCd, String menuId)
指定されたマイメニューIDに紐づくマイメニュー構成情報を取得します。
パラメータ
userCd : String
ユーザコード
menuId : String
マイメニューID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには マイメニュー構成情報 が設定されます。
ResultObject getRootMyMenuItem (String userCd, String clientTypeId)
ルートのマイメニューアイテム情報を取得します。
パラメータ
userCd : String
ユーザコード
clientTypeId : String
クライアントタイプID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには マイメニューアイテム情報 が設定されます。
ResultObject getRootMyMenuTree (String userCd, String clientTypeId)
ルートのマイメニュー構成情報を取得します。
パラメータ
userCd : String
ユーザコード
clientTypeId : String
クライアントタイプID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには マイメニュー構成情報 が設定されます。
ResultObject hasMyMenuItemsByUrl (String userCd, String url)
指定されたURLに紐づくマイメニューアイテム情報が存在するかどうか取得します。
パラメータ
userCd : String
ユーザコード
url : String
URL
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、該当するマイメニューアイテムが存在する場合は true、それ以外は false が設定されます。
ResultObject moveMyMenuNode (String userCd, String menuId, String parentMenuId)
マイメニューアイテムを移動します。

指定されたマイメニューIDのマイメニュー構成を、指定された親のマイメニューIDの配下に移動します。
移動後の各マイメニューIDとコピー元メニューアイテムIDは更新されません。
パラメータ
userCd : String
ユーザコード
menuId : String
移動するマイメニューID
parentMenuId : String
移動先の親マイメニューID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。
ResultObject updateMyMenuItemId (String userCd, String from, String to)
マイメニューIDを変更します。
パラメータ
userCd : String
ユーザコード
from : String
変更元のマイメニューID
to : String
変更後のマイメニューID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。
ResultObject updateMyMenuItem (String userCd, MyMenuItem myMenuItem)
マイメニューアイテム情報を更新します。
パラメータ
userCd : String
ユーザコード
myMenuItem : MyMenuItem
マイメニューアイテム情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

Copyright © 2012 NTT DATA INTRAMART CORPORATION