View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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.plugins.document.business;
35  
36  
37  /**
38   * This class represents business objects DocumentPageTemplate
39   */
40  public class DocumentPageTemplate
41  {
42      private int _nId;
43      private String _strDescription;
44      private String _strFile;
45      private String _strPicture;
46  
47      /**
48       * Returns the page template identifier
49       *
50       * @return the page template identifier
51       */
52      public int getId(  )
53      {
54          return _nId;
55      }
56  
57      /**
58       * Sets the page template identifier
59       *
60       * @param nId the page template identifier
61       */
62      public void setId( int nId )
63      {
64          _nId = nId;
65      }
66  
67      /**
68       * Returns the description of the page template
69       *
70       * @return page template description
71       */
72      public String getDescription(  )
73      {
74          return _strDescription;
75      }
76  
77      /**
78       * Sets the description of the page template
79       *
80       * @param strDescription the page template description
81       */
82      public void setDescription( String strDescription )
83      {
84          _strDescription = strDescription;
85      }
86  
87      /**
88       * Returns the name of the html page which manages this type of page template
89       *
90       * @return the name of the html page
91       */
92      public String getFile(  )
93      {
94          return _strFile;
95      }
96  
97      /**
98       * Sets the name of the html page which manages this type of page template
99       *
100      * @param strFile The file name
101      */
102     public void setFile( String strFile )
103     {
104         _strFile = strFile;
105     }
106 
107     /**
108      * Returns the name of the picture associated to the page template type in the administration unit
109      *
110      * @return The name of the picture as a string
111      */
112     public String getPicture(  )
113     {
114         return _strPicture;
115     }
116 
117     /**
118      * Sets the name of the picture associated to the page template type in the administration unit
119      *
120      * @param strPicture The picture name
121      */
122     public void setPicture( String strPicture )
123     {
124         _strPicture = strPicture;
125     }
126 }