1   /**
2    * Copyright (c) 2000-2008 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="SubscriptionPersistence.java.html"><b><i>View Source</i></b></a>
27   *
28   * @author Brian Wing Shun Chan
29   *
30   */
31  public interface SubscriptionPersistence {
32      public com.liferay.portal.model.Subscription create(long subscriptionId);
33  
34      public com.liferay.portal.model.Subscription remove(long subscriptionId)
35          throws com.liferay.portal.SystemException,
36              com.liferay.portal.NoSuchSubscriptionException;
37  
38      public com.liferay.portal.model.Subscription remove(
39          com.liferay.portal.model.Subscription subscription)
40          throws com.liferay.portal.SystemException;
41  
42      /**
43       * @deprecated Use <code>update(Subscription subscription, boolean merge)</code>.
44       */
45      public com.liferay.portal.model.Subscription update(
46          com.liferay.portal.model.Subscription subscription)
47          throws com.liferay.portal.SystemException;
48  
49      /**
50       * Add, update, or merge, the entity. This method also calls the model
51       * listeners to trigger the proper events associated with adding, deleting,
52       * or updating an entity.
53       *
54       * @param        subscription the entity to add, update, or merge
55       * @param        merge boolean value for whether to merge the entity. The
56       *                default value is false. Setting merge to true is more
57       *                expensive and should only be true when subscription is
58       *                transient. See LEP-5473 for a detailed discussion of this
59       *                method.
60       * @return        true if the portlet can be displayed via Ajax
61       */
62      public com.liferay.portal.model.Subscription update(
63          com.liferay.portal.model.Subscription subscription, boolean merge)
64          throws com.liferay.portal.SystemException;
65  
66      public com.liferay.portal.model.Subscription updateImpl(
67          com.liferay.portal.model.Subscription subscription, boolean merge)
68          throws com.liferay.portal.SystemException;
69  
70      public com.liferay.portal.model.Subscription findByPrimaryKey(
71          long subscriptionId)
72          throws com.liferay.portal.SystemException,
73              com.liferay.portal.NoSuchSubscriptionException;
74  
75      public com.liferay.portal.model.Subscription fetchByPrimaryKey(
76          long subscriptionId) throws com.liferay.portal.SystemException;
77  
78      public java.util.List<com.liferay.portal.model.Subscription> findByUserId(
79          long userId) throws com.liferay.portal.SystemException;
80  
81      public java.util.List<com.liferay.portal.model.Subscription> findByUserId(
82          long userId, int begin, int end)
83          throws com.liferay.portal.SystemException;
84  
85      public java.util.List<com.liferay.portal.model.Subscription> findByUserId(
86          long userId, int begin, int end,
87          com.liferay.portal.kernel.util.OrderByComparator obc)
88          throws com.liferay.portal.SystemException;
89  
90      public com.liferay.portal.model.Subscription findByUserId_First(
91          long userId, com.liferay.portal.kernel.util.OrderByComparator obc)
92          throws com.liferay.portal.SystemException,
93              com.liferay.portal.NoSuchSubscriptionException;
94  
95      public com.liferay.portal.model.Subscription findByUserId_Last(
96          long userId, com.liferay.portal.kernel.util.OrderByComparator obc)
97          throws com.liferay.portal.SystemException,
98              com.liferay.portal.NoSuchSubscriptionException;
99  
100     public com.liferay.portal.model.Subscription[] findByUserId_PrevAndNext(
101         long subscriptionId, long userId,
102         com.liferay.portal.kernel.util.OrderByComparator obc)
103         throws com.liferay.portal.SystemException,
104             com.liferay.portal.NoSuchSubscriptionException;
105 
106     public java.util.List<com.liferay.portal.model.Subscription> findByC_C_C(
107         long companyId, long classNameId, long classPK)
108         throws com.liferay.portal.SystemException;
109 
110     public java.util.List<com.liferay.portal.model.Subscription> findByC_C_C(
111         long companyId, long classNameId, long classPK, int begin, int end)
112         throws com.liferay.portal.SystemException;
113 
114     public java.util.List<com.liferay.portal.model.Subscription> findByC_C_C(
115         long companyId, long classNameId, long classPK, int begin, int end,
116         com.liferay.portal.kernel.util.OrderByComparator obc)
117         throws com.liferay.portal.SystemException;
118 
119     public com.liferay.portal.model.Subscription findByC_C_C_First(
120         long companyId, long classNameId, long classPK,
121         com.liferay.portal.kernel.util.OrderByComparator obc)
122         throws com.liferay.portal.SystemException,
123             com.liferay.portal.NoSuchSubscriptionException;
124 
125     public com.liferay.portal.model.Subscription findByC_C_C_Last(
126         long companyId, long classNameId, long classPK,
127         com.liferay.portal.kernel.util.OrderByComparator obc)
128         throws com.liferay.portal.SystemException,
129             com.liferay.portal.NoSuchSubscriptionException;
130 
131     public com.liferay.portal.model.Subscription[] findByC_C_C_PrevAndNext(
132         long subscriptionId, long companyId, long classNameId, long classPK,
133         com.liferay.portal.kernel.util.OrderByComparator obc)
134         throws com.liferay.portal.SystemException,
135             com.liferay.portal.NoSuchSubscriptionException;
136 
137     public com.liferay.portal.model.Subscription findByC_U_C_C(long companyId,
138         long userId, long classNameId, long classPK)
139         throws com.liferay.portal.SystemException,
140             com.liferay.portal.NoSuchSubscriptionException;
141 
142     public com.liferay.portal.model.Subscription fetchByC_U_C_C(
143         long companyId, long userId, long classNameId, long classPK)
144         throws com.liferay.portal.SystemException;
145 
146     public java.util.List<com.liferay.portal.model.Subscription> findWithDynamicQuery(
147         com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
148         throws com.liferay.portal.SystemException;
149 
150     public java.util.List<com.liferay.portal.model.Subscription> findWithDynamicQuery(
151         com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
152         int begin, int end) throws com.liferay.portal.SystemException;
153 
154     public java.util.List<com.liferay.portal.model.Subscription> findAll()
155         throws com.liferay.portal.SystemException;
156 
157     public java.util.List<com.liferay.portal.model.Subscription> findAll(
158         int begin, int end) throws com.liferay.portal.SystemException;
159 
160     public java.util.List<com.liferay.portal.model.Subscription> findAll(
161         int begin, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
162         throws com.liferay.portal.SystemException;
163 
164     public void removeByUserId(long userId)
165         throws com.liferay.portal.SystemException;
166 
167     public void removeByC_C_C(long companyId, long classNameId, long classPK)
168         throws com.liferay.portal.SystemException;
169 
170     public void removeByC_U_C_C(long companyId, long userId, long classNameId,
171         long classPK)
172         throws com.liferay.portal.SystemException,
173             com.liferay.portal.NoSuchSubscriptionException;
174 
175     public void removeAll() throws com.liferay.portal.SystemException;
176 
177     public int countByUserId(long userId)
178         throws com.liferay.portal.SystemException;
179 
180     public int countByC_C_C(long companyId, long classNameId, long classPK)
181         throws com.liferay.portal.SystemException;
182 
183     public int countByC_U_C_C(long companyId, long userId, long classNameId,
184         long classPK) throws com.liferay.portal.SystemException;
185 
186     public int countAll() throws com.liferay.portal.SystemException;
187 }