View Javadoc
1   /*
2    * Copyright (c) 2002-2022, City of Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.portal.business.style;
35  
36  /**
37   * This class represents style business objects
38   */
39  public class Style
40  {
41      private static final String EMPTY_STRING = "";
42      private int _nId;
43      private int _nPortalComponentId;
44      private String _strPortletTypeId;
45      private String _strDescription;
46      private String _strPortletTypeName;
47      private String _strPortalComponentName;
48  
49      /**
50       * Returns the identifier of this style
51       *
52       * @return the identifier of the style
53       */
54      public int getId( )
55      {
56          return _nId;
57      }
58  
59      /**
60       * Sets the identifier of this style with the int value specified in parameter
61       *
62       * @param nId
63       *            the new identifier
64       */
65      public void setId( int nId )
66      {
67          _nId = nId;
68      }
69  
70      /**
71       * Returns the identifier of the portlet type of this style
72       *
73       * @return the identifier of the portlet type style
74       */
75      public String getPortletTypeId( )
76      {
77          return _strPortletTypeId;
78      }
79  
80      /**
81       * Sets the identifier of the portlet type of this style with the int value specified in parameter
82       *
83       * @param strPortletTypeId
84       *            the identifier of portlet type of the style
85       */
86      public void setPortletTypeId( String strPortletTypeId )
87      {
88          _strPortletTypeId = strPortletTypeId;
89      }
90  
91      /**
92       * Returns the identifier of the portal component of this style
93       *
94       * @return the identifier of the portal component's style
95       */
96      public int getPortalComponentId( )
97      {
98          return _nPortalComponentId;
99      }
100 
101     /**
102      * Sets the identifier of the portal component of this style with the int value specified in parameter
103      *
104      * @param nPortalComponentId
105      *            the identifier of portal component of the style
106      */
107     public void setPortalComponentId( int nPortalComponentId )
108     {
109         _nPortalComponentId = nPortalComponentId;
110     }
111 
112     /**
113      * Returns the description of this style
114      *
115      * @return the description of this style
116      */
117     public String getDescription( )
118     {
119         return _strDescription;
120     }
121 
122     /**
123      * Sets the description of this style with the String value specified in parameter or "" otherwise
124      *
125      * @param strDescription
126      *            the identifier of portlet type of the style
127      */
128     public void setDescription( String strDescription )
129     {
130         _strDescription = ( strDescription == null ) ? EMPTY_STRING : strDescription;
131     }
132 
133     /**
134      * Returns the portlet type name of this style
135      *
136      * @return the portlet type name of this style
137      */
138     public String getPortletTypeName( )
139     {
140         return _strPortletTypeName;
141     }
142 
143     /**
144      * Sets the portlet type name of this style with the String value specified in parameter
145      *
146      * @param strPortletTypeName
147      *            the new portlet type name
148      */
149     public void setPortletTypeName( String strPortletTypeName )
150     {
151         _strPortletTypeName = ( strPortletTypeName == null ) ? EMPTY_STRING : strPortletTypeName;
152     }
153 
154     /**
155      * Returns the portal component name of this style
156      *
157      * @return the portal component name of this style
158      */
159     public String getPortalComponentName( )
160     {
161         return _strPortalComponentName;
162     }
163 
164     /**
165      * Sets the portlet type name of this style with the String value specified in parameter
166      *
167      * @param strPortalComponentName
168      *            the new portlet type name
169      */
170     public void setPortalComponentName( String strPortalComponentName )
171     {
172         _strPortalComponentName = ( strPortalComponentName == null ) ? EMPTY_STRING : strPortalComponentName;
173     }
174 }