MenuItemManagerオブジェクト

コンポーネント情報
version	8.0.19
since	8.0.0

コンポーネント概要

メニューアイテムマネージャのクラスです。

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

コンストラクタの概要

MenuItemManager () コンストラクタ。

メソッドの概要

返却値の型	メソッド名
ResultObject	addMenuItem (String `parentMenuId`, MenuItem `menuItem`) メニューアイテム情報を新規作成します。
ResultObject	copyMenuTree (String `menuId`, String `parentMenuId`) メニューアイテムをコピーします。
ResultObject	deleteMenuItem (String `menuId`) メニューアイテム情報を削除します。
ResultObject	getChildMenuIds (String `menuId`) 子ノードのメニュー`ID`リストを取得します。
ResultObject	getChildren (String `menuId`) 子ノードのメニューアイテム情報のリストを取得します。
ResultObject	getMenuItem (String `menuId`) メニューアイテム情報を取得します。
ResultObject	getMenuItemsByUrl (String `url`) 指定された`URL`に紐づくメニューアイテム情報のリストを取得します。
ResultObject	getMenuNode (String `menuId`) 指定されたメニュー`ID`に紐づくメニュー構成情報を取得します。
ResultObject	moveMenuNode (String `menuId`, String `parentMenuId`) メニューアイテムを移動します。
ResultObject	updateMenuItemId (String `from`, String `to`) メニューアイテムのIDを変更します。
ResultObject	updateMenuItem (MenuItem `menuItem`) メニューアイテム情報を更新します。

コンストラクタの詳細

MenuItemManager ()

コンストラクタ。

メソッドの詳細

ResultObject addMenuItem (String parentMenuId, MenuItem menuItem)

メニューアイテム情報を新規作成します。

パラメータ

parentMenuId : String: 親メニューID

menuItem : MenuItem: メニューアイテム情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject copyMenuTree (String menuId, String parentMenuId)

メニューアイテムをコピーします。

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

パラメータ

menuId : String: コピーするメニューID

parentMenuId : String: コピー先の親メニューID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはコピーされたメニュー構成情報が設定されます。

ResultObject deleteMenuItem (String menuId)

メニューアイテム情報を削除します。

パラメータ

menuId : String: メニューID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject getChildMenuIds (String menuId)

子ノードのメニューIDリストを取得します。

パラメータ

menuId : String: 親のメニューID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはメニューIDのリストが設定されます。

ResultObject getChildren (String menuId)

子ノードのメニューアイテム情報のリストを取得します。

パラメータ

menuId : String: メニューID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはメニューアイテム情報のリストが設定されます。

ResultObject getMenuItem (String menuId)

メニューアイテム情報を取得します。

パラメータ

menuId : String: メニューID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはメニューアイテム情報が設定されます。

ResultObject getMenuItemsByUrl (String url)

指定されたURLに紐づくメニューアイテム情報のリストを取得します。

パラメータ

url : String: URL

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはメニューアイテム情報のリストが設定されます。

ResultObject getMenuNode (String menuId)

指定されたメニューIDに紐づくメニュー構成情報を取得します。

パラメータ

menuId : String: メニューID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはメニュー構成情報が設定されます。

ResultObject moveMenuNode (String menuId, String parentMenuId)

メニューアイテムを移動します。

指定されたメニューIDのメニュー構成を、指定された親のメニューIDの配下に移動します。
移動後の各メニューIDとコピー元メニューアイテムIDは更新されません。

パラメータ

menuId : String: 移動するメニューID

parentMenuId : String: 移動先の親メニューID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject updateMenuItemId (String from, String to)

メニューアイテムのIDを変更します。

パラメータ

from : String: 変更元のメニューID

to : String: 変更後のメニューID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject updateMenuItem (MenuItem menuItem)

メニューアイテム情報を更新します。

パラメータ

menuItem : MenuItem: メニューアイテム情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。