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