ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/service/EPLeftMenuService.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.Set;
  23
  24 import org.openecomp.portalsdk.core.domain.MenuData;
  25 import org.openecomp.portalapp.portal.domain.EPUser;
  26
  27 public interface EPLeftMenuService {
  28
  29         /**
  30          * Builds a JSON suitable for populating the front-end left menu from the supplied set of menu items.
  31          * @param user
  32          *
  33          * @param fullMenuSet
  34          * @param roleFunctionSet
  35          * @return JSON String of this form:
  36          * <PRE>
  37          * {"navItems":[
  38          *              {"name":"Home","imageSrc":"icon-location-pin","state":"root.applicationsHome"},
  39          *      ...
  40          * ] }
  41          * </PRE>
  42          */
  43         String getLeftMenuItems(EPUser user, Set<MenuData> fullMenuSet, Set<String> roleFunctionSet);
  44 }