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

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