1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.service.persistence;
24  
25  /**
26   * <a href="PortletPersistence.java.html"><b><i>View Source</i></b></a>
27   *
28   * @author Brian Wing Shun Chan
29   *
30   */
31  public interface PortletPersistence extends BasePersistence {
32      public void cacheResult(com.liferay.portal.model.Portlet portlet);
33  
34      public void cacheResult(
35          java.util.List<com.liferay.portal.model.Portlet> portlets);
36  
37      public void clearCache();
38  
39      public com.liferay.portal.model.Portlet create(long id);
40  
41      public com.liferay.portal.model.Portlet remove(long id)
42          throws com.liferay.portal.NoSuchPortletException,
43              com.liferay.portal.SystemException;
44  
45      public com.liferay.portal.model.Portlet remove(
46          com.liferay.portal.model.Portlet portlet)
47          throws com.liferay.portal.SystemException;
48  
49      /**
50       * @deprecated Use <code>update(Portlet portlet, boolean merge)</code>.
51       */
52      public com.liferay.portal.model.Portlet update(
53          com.liferay.portal.model.Portlet portlet)
54          throws com.liferay.portal.SystemException;
55  
56      /**
57       * Add, update, or merge, the entity. This method also calls the model
58       * listeners to trigger the proper events associated with adding, deleting,
59       * or updating an entity.
60       *
61       * @param        portlet the entity to add, update, or merge
62       * @param        merge boolean value for whether to merge the entity. The
63       *                default value is false. Setting merge to true is more
64       *                expensive and should only be true when portlet is
65       *                transient. See LEP-5473 for a detailed discussion of this
66       *                method.
67       * @return        true if the portlet can be displayed via Ajax
68       */
69      public com.liferay.portal.model.Portlet update(
70          com.liferay.portal.model.Portlet portlet, boolean merge)
71          throws com.liferay.portal.SystemException;
72  
73      public com.liferay.portal.model.Portlet updateImpl(
74          com.liferay.portal.model.Portlet portlet, boolean merge)
75          throws com.liferay.portal.SystemException;
76  
77      public com.liferay.portal.model.Portlet findByPrimaryKey(long id)
78          throws com.liferay.portal.NoSuchPortletException,
79              com.liferay.portal.SystemException;
80  
81      public com.liferay.portal.model.Portlet fetchByPrimaryKey(long id)
82          throws com.liferay.portal.SystemException;
83  
84      public java.util.List<com.liferay.portal.model.Portlet> findByCompanyId(
85          long companyId) throws com.liferay.portal.SystemException;
86  
87      public java.util.List<com.liferay.portal.model.Portlet> findByCompanyId(
88          long companyId, int start, int end)
89          throws com.liferay.portal.SystemException;
90  
91      public java.util.List<com.liferay.portal.model.Portlet> findByCompanyId(
92          long companyId, int start, int end,
93          com.liferay.portal.kernel.util.OrderByComparator obc)
94          throws com.liferay.portal.SystemException;
95  
96      public com.liferay.portal.model.Portlet findByCompanyId_First(
97          long companyId, com.liferay.portal.kernel.util.OrderByComparator obc)
98          throws com.liferay.portal.NoSuchPortletException,
99              com.liferay.portal.SystemException;
100 
101     public com.liferay.portal.model.Portlet findByCompanyId_Last(
102         long companyId, com.liferay.portal.kernel.util.OrderByComparator obc)
103         throws com.liferay.portal.NoSuchPortletException,
104             com.liferay.portal.SystemException;
105 
106     public com.liferay.portal.model.Portlet[] findByCompanyId_PrevAndNext(
107         long id, long companyId,
108         com.liferay.portal.kernel.util.OrderByComparator obc)
109         throws com.liferay.portal.NoSuchPortletException,
110             com.liferay.portal.SystemException;
111 
112     public com.liferay.portal.model.Portlet findByC_P(long companyId,
113         java.lang.String portletId)
114         throws com.liferay.portal.NoSuchPortletException,
115             com.liferay.portal.SystemException;
116 
117     public com.liferay.portal.model.Portlet fetchByC_P(long companyId,
118         java.lang.String portletId) throws com.liferay.portal.SystemException;
119 
120     public com.liferay.portal.model.Portlet fetchByC_P(long companyId,
121         java.lang.String portletId, boolean retrieveFromCache)
122         throws com.liferay.portal.SystemException;
123 
124     public java.util.List<Object> findWithDynamicQuery(
125         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
126         throws com.liferay.portal.SystemException;
127 
128     public java.util.List<Object> findWithDynamicQuery(
129         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130         int end) throws com.liferay.portal.SystemException;
131 
132     public java.util.List<com.liferay.portal.model.Portlet> findAll()
133         throws com.liferay.portal.SystemException;
134 
135     public java.util.List<com.liferay.portal.model.Portlet> findAll(int start,
136         int end) throws com.liferay.portal.SystemException;
137 
138     public java.util.List<com.liferay.portal.model.Portlet> findAll(int start,
139         int end, com.liferay.portal.kernel.util.OrderByComparator obc)
140         throws com.liferay.portal.SystemException;
141 
142     public void removeByCompanyId(long companyId)
143         throws com.liferay.portal.SystemException;
144 
145     public void removeByC_P(long companyId, java.lang.String portletId)
146         throws com.liferay.portal.NoSuchPortletException,
147             com.liferay.portal.SystemException;
148 
149     public void removeAll() throws com.liferay.portal.SystemException;
150 
151     public int countByCompanyId(long companyId)
152         throws com.liferay.portal.SystemException;
153 
154     public int countByC_P(long companyId, java.lang.String portletId)
155         throws com.liferay.portal.SystemException;
156 
157     public int countAll() throws com.liferay.portal.SystemException;
158 }