MenuItemManager (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.menu.MenuItemManager

```
public final class MenuItemManager
extends Object
```
メニューアイテムマネージャクラス。

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

導入されたバージョン:

8.0.0

バージョン:

8.0.7

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

MenuItemManager()
コンストラクタ。

コンストラクタ
コンストラクタと説明
`MenuItemManager()` コンストラクタ。

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addMenuItem(String parentMenuId, MenuItem menuItem)` メニューアイテム情報を新規作成します。
`void`	`clearCache()` キャッシュをクリアします。
`static void`	`clearInstance()` メニューアイテムマネージャのインスタンスを初期化します。
`MenuTree`	`copyMenuTree(String menuId, String parentMenuId)` メニューアイテムをコピーします。
`void`	`deleteMenuItem(String... menuId)` メニューアイテム情報を削除します。
`List<String>`	`getChildMenuIds(String menuId)` 子ノードのメニュー`ID`リストを取得します。
`List<MenuItem>`	`getChildren(String menuId)` 子ノードのメニューアイテム情報のリストを取得します。
`MenuItem`	`getMenuItem(String menuId)` メニューアイテム情報を取得します。
`List<MenuItem>`	`getMenuItemsByUrl(String url)` 指定された`URL`に紐づくメニューアイテム情報のリストを取得します。
`MenuTree`	`getMenuNode(String menuId)` 指定されたメニュー`ID`に紐づくメニュー構成情報を取得します。
`void`	`moveMenuNode(String menuId, String parentMenuId)` メニューアイテムを移動します。
`void`	`updateMenuItem(MenuItem menuItem)` メニューアイテム情報を更新します。
`void`	`updateMenuItemId(String from, String to)` メニュー`ID`を変更します。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - MenuItemManager
```
public MenuItemManager()
                throws MenuException
```
    コンストラクタ。
    
    メニューアイテムを操作するマネージャーを作成します。
    
    例外:
    
    MenuException - 初期化に失敗した場合に発生します。
- メソッドの詳細
  - clearInstance
```
public static void clearInstance()
```
    メニューアイテムマネージャのインスタンスを初期化します。
    
    通常、このメソッドを使用する必要はありません。
  - addMenuItem
```
public void addMenuItem(String parentMenuId,
                        MenuItem menuItem)
                 throws MenuException
```
    メニューアイテム情報を新規作成します。
    
    パラメータ:
    
    parentMenuId - 親メニューID
    
    menuItem - メニューアイテム情報
    
    例外:
    
    MenuException - 書き込み処理に失敗した場合、または引数が不正だった場合にスローされます。
  - clearCache
```
public void clearCache()
                throws MenuException
```
    キャッシュをクリアします。
    
    例外:
    
    MenuException - キャッシュのクリアに失敗した場合にスローされます。
  - copyMenuTree
```
public MenuTree copyMenuTree(String menuId,
                             String parentMenuId)
                      throws MenuException
```
    メニューアイテムをコピーします。
    
    指定されたメニューIDのメニュー構成を、指定された親のメニューIDの配下にコピーします。
    コピー後の各メニューIDは自動的に新しいものが採番され、コピー元メニューアイテムIDに元となったメニューIDが設定されます。
    
    パラメータ:
    
    menuId - コピーするメニューID
    
    parentMenuId - コピー先の親メニューID
    
    戻り値:
    
    コピーされたのメニュー構成情報
    
    例外:
    
    MenuException - 複製処理に失敗した場合
  - deleteMenuItem
```
public void deleteMenuItem(String... menuId)
                    throws MenuException
```
    メニューアイテム情報を削除します。
    
    パラメータ:
    
    menuId - メニューID
    
    例外:
    
    MenuException - 削除処理に失敗した場合、または引数が不正だった場合にスローされます。
  - getChildMenuIds
```
public List<String> getChildMenuIds(String menuId)
                             throws MenuException
```
    子ノードのメニューIDリストを取得します。
    
    パラメータ:
    
    menuId - 親のメニューID
    
    戻り値:
    
    メニューIDのリスト
    
    例外:
    
    MenuException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。
  - getChildren
```
public List<MenuItem> getChildren(String menuId)
                           throws MenuException
```
    子ノードのメニューアイテム情報のリストを取得します。
    
    パラメータ:
    
    menuId - メニューID
    
    戻り値:
    
    メニューアイテム情報のリスト
    
    例外:
    
    MenuException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。
  - getMenuItem
```
public MenuItem getMenuItem(String menuId)
                     throws MenuException
```
    メニューアイテム情報を取得します。
    
    パラメータ:
    
    menuId - メニューID
    
    戻り値:
    
    メニューアイテム情報
    
    例外:
    
    MenuException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。
  - getMenuItemsByUrl
```
public List<MenuItem> getMenuItemsByUrl(String url)
```
    指定されたURLに紐づくメニューアイテム情報のリストを取得します。
    
    パラメータ:
    
    url - URL
    
    戻り値:
    
    メニューアイテム情報のリスト
  - getMenuNode
```
public MenuTree getMenuNode(String menuId)
                     throws MenuException
```
    指定されたメニューIDに紐づくメニュー構成情報を取得します。
    
    パラメータ:
    
    menuId - メニューID
    
    戻り値:
    
    メニュー構成情報
    
    例外:
    
    MenuException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。
  - moveMenuNode
```
public void moveMenuNode(String menuId,
                         String parentMenuId)
                  throws MenuException
```
    メニューアイテムを移動します。
    
    指定されたメニューIDのメニュー構成を、指定された親のメニューIDの配下に移動します。
    移動後の各メニューIDとコピー元メニューアイテムIDは更新されません。
    
    パラメータ:
    
    menuId - 移動するメニューID
    
    parentMenuId - 移動先の親メニューID
    
    例外:
    
    MenuException - 移動処理に失敗した場合
  - updateMenuItem
```
public void updateMenuItem(MenuItem menuItem)
                    throws MenuException
```
    メニューアイテム情報を更新します。
    
    パラメータ:
    
    menuItem - メニューアイテム情報
    
    例外:
    
    MenuException - 書き込み処理に失敗した場合、または引数が不正だった場合にスローされます。
  - updateMenuItemId
```
public void updateMenuItemId(String from,
                             String to)
                      throws MenuException
```
    メニューIDを変更します。
    
    パラメータ:
    
    from - 変更元のメニューID
    
    to - 変更後のメニューID
    
    例外:
    
    MenuException - 更新に失敗した場合

クラス MenuItemManager

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

MenuItemManager

メソッドの詳細

clearInstance

addMenuItem

clearCache

copyMenuTree

deleteMenuItem

getChildMenuIds

getChildren

getMenuItem

getMenuItemsByUrl

getMenuNode

moveMenuNode

updateMenuItem

updateMenuItemId