ecomp-portal-BE/src/main/java/org/openecomp/portalapp/portal/service/FunctionalMenuService.java

   1 /*-
   2  * ================================================================================
   3  * eCOMP Portal
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ================================================================================
  19  */
  20 package org.openecomp.portalapp.portal.service;
  21
  22 import java.util.List;
  23
  24 import org.openecomp.portalapp.portal.domain.EPUser;
  25 import org.openecomp.portalapp.portal.transport.FavoritesFunctionalMenuItem;
  26 import org.openecomp.portalapp.portal.transport.FavoritesFunctionalMenuItemJson;
  27 import org.openecomp.portalapp.portal.transport.FieldsValidator;
  28 import org.openecomp.portalapp.portal.transport.FunctionalMenuItem;
  29 import org.openecomp.portalapp.portal.transport.FunctionalMenuItemJson;
  30
  31 public interface FunctionalMenuService {
  32         List<FunctionalMenuItem> getFunctionalMenuItems (EPUser user);
  33         // return all active menu items
  34         List<FunctionalMenuItem> getFunctionalMenuItems ();
  35         // return all active menu items. If all is true, return all active and inactive menu items.
  36         List<FunctionalMenuItem> getFunctionalMenuItems(Boolean all);
  37         List<FunctionalMenuItem> getFunctionalMenuItemsForApp (Integer appId);
  38         List<FunctionalMenuItem> getFunctionalMenuItemsForUser (String userId);
  39         FunctionalMenuItem getFunctionalMenuItemDetails (Integer menuid);
  40         FieldsValidator createFunctionalMenuItem (FunctionalMenuItemJson menuItemJson);
  41         FieldsValidator editFunctionalMenuItem (FunctionalMenuItemJson menuItemJson);
  42         FieldsValidator deleteFunctionalMenuItem (Long menuId);
  43         FieldsValidator regenerateAncestorTable ();
  44         //Methods relevant to favorites
  45         FieldsValidator setFavoriteItem(FavoritesFunctionalMenuItem menuItemJson);
  46         List<FavoritesFunctionalMenuItemJson> getFavoriteItems(Long userId);
  47         FieldsValidator removeFavoriteItem (Long userId, Long menuId);
  48         //Assign URLs under Help Menu
  49         void assignHelpURLs(List<FunctionalMenuItem> menuItems);
  50 }