ecomp-portal-BE-common/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.domain.FunctionalMenuItemWithAppID;
  26 import org.openecomp.portalapp.portal.transport.BusinessCardApplicationRole;
  27 import org.openecomp.portalapp.portal.transport.FavoritesFunctionalMenuItem;
  28 import org.openecomp.portalapp.portal.transport.FavoritesFunctionalMenuItemJson;
  29 import org.openecomp.portalapp.portal.transport.FieldsValidator;
  30 import org.openecomp.portalapp.portal.transport.FunctionalMenuItem;
  31 import org.openecomp.portalapp.portal.transport.FunctionalMenuItemWithRoles;
  32 import org.openecomp.portalapp.portal.transport.FunctionalMenuRole;
  33
  34 public interface FunctionalMenuService {
  35         List<FunctionalMenuItem> getFunctionalMenuItems (EPUser user);
  36         // return all active menu items
  37         List<FunctionalMenuItem> getFunctionalMenuItems ();
  38         // return all active menu items. If all is true, return all active and inactive menu items.
  39         List<FunctionalMenuItem> getFunctionalMenuItems(Boolean all);
  40         // return all active Functional menu items for Notification Tree in User Notification . If all is true, return all active menu items.
  41         List<FunctionalMenuItem> getFunctionalMenuItemsForNotificationTree(Boolean all);
  42         List<FunctionalMenuItem> getFunctionalMenuItemsForApp (Integer appId);
  43         List<FunctionalMenuItem> getFunctionalMenuItemsForUser (String orgUserId);
  44         FunctionalMenuItem getFunctionalMenuItemDetails (Integer menuid);
  45         FieldsValidator createFunctionalMenuItem (FunctionalMenuItemWithRoles menuItemJson);
  46         FieldsValidator editFunctionalMenuItem (FunctionalMenuItemWithRoles menuItemJson);
  47         FieldsValidator deleteFunctionalMenuItem (Long menuId);
  48         FieldsValidator regenerateAncestorTable ();
  49         //Methods relevant to favorites
  50         FieldsValidator setFavoriteItem(FavoritesFunctionalMenuItem menuItemJson);
  51         List<FavoritesFunctionalMenuItemJson> getFavoriteItems(Long userId);
  52         FieldsValidator removeFavoriteItem (Long userId, Long menuId);
  53         List<FunctionalMenuItem> transformFunctionalMenuItemWithAppIDToFunctionalMenuItem(List<FunctionalMenuItemWithAppID> functionalMenuItemWithAppIDList);
  54         List<FunctionalMenuRole> getFunctionalMenuRole();
  55         //Assign URLs under Help Menu
  56         void assignHelpURLs(List<FunctionalMenuItem> menuItems);
  57         List<BusinessCardApplicationRole> getUserAppRolesList(String userId);
  58 }