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

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