ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/domain/FunctionalMenuItemWithAppID.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  *
  37  */
  38 package org.onap.portalapp.portal.domain;
  39
  40 import java.util.List;
  41 import javax.persistence.Column;
  42 import javax.persistence.Entity;
  43 import javax.persistence.GeneratedValue;
  44 import javax.persistence.GenerationType;
  45 import javax.persistence.Id;
  46 import javax.persistence.Transient;
  47 import javax.validation.constraints.DecimalMax;
  48 import javax.validation.constraints.Digits;
  49 import javax.validation.constraints.Max;
  50 import javax.validation.constraints.NotNull;
  51 import lombok.AllArgsConstructor;
  52 import lombok.NoArgsConstructor;
  53 import org.hibernate.validator.constraints.SafeHtml;
  54
  55 /***
  56  *
  57  * This class is almost identical to org.onap.portalapp.portal.transport.FunctionalMenuItem
  58  * The only difference is the appId field. In FunctionMenuItem, we used @Transient as an attribute, and we are using @Column in this class.
  59  * In some sql queries, we need to have appId, but it's not a field in fn_menu_functional table.
  60  *
  61  * @author robertlo
  62  *
  63  */
  64 @Entity
  65 @NoArgsConstructor
  66 @AllArgsConstructor
  67 public class FunctionalMenuItemWithAppID{
  68         private static final long serialVersionUID = 1L;
  69
  70         @Id
  71     @GeneratedValue(strategy=GenerationType.IDENTITY)
  72         @Column(name = "MENU_ID")
  73         @Digits(integer = 11, fraction = 0)
  74         public Long menuId;
  75
  76         @Column(name = "COLUMN_NUM")
  77         @Digits(integer = 2, fraction = 0)
  78         @NotNull
  79         public Integer column;
  80
  81         @Column(name = "TEXT")
  82         @Max(value = 100)
  83         @SafeHtml
  84         @NotNull
  85         public String text;
  86
  87         @Column(name = "PARENT_MENU_ID")
  88         @Digits(integer = 11, fraction = 0)
  89         public Integer parentMenuId;
  90
  91         @Column(name = "URL")
  92         @Max(value = 128)
  93         @SafeHtml
  94         @NotNull
  95         public String url;
  96
  97         @Column(name="ACTIVE_YN")
  98         @Max(value = 1)
  99         @SafeHtml
 100         @NotNull
 101         public String active_yn;
 102
 103         @Column(name="APP_ID")
 104         public Integer appid;
 105
 106         @Transient
 107         public List<Integer> roles;
 108
 109         @Transient
 110         public Boolean restrictedApp;
 111
 112         public void normalize() {
 113                 if (this.column == null)
 114                         this.column = 1;
 115                 this.text = (this.text == null) ? "" : this.text.trim();
 116                 if (this.parentMenuId == null)
 117                         this.parentMenuId = -1;
 118                 this.url = (this.url == null) ? "" : this.url.trim();
 119         }
 120
 121         @Override
 122         public String toString() {
 123                 return "FunctionalMenuItem [menuId=" + menuId + ", column=" + column + ", text=" + text + ", parentMenuId="
 124                                 + parentMenuId + ", url=" + url + ", active_yn=" + active_yn + ", appid=" + appid + ", roles=" + roles
 125                                 + ", restrictedApp=" + restrictedApp + "]";
 126         }
 127
 128         public void setUrl(String url) {
 129                 this.url = url;
 130         }
 131
 132         public void setRestrictedApp(Boolean restrictedApp) {
 133                 this.restrictedApp = restrictedApp;
 134         }
 135 }
 136