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="UserIdMapperPersistence.java.html"><b><i>View Source</i></b></a>
27   *
28   * @author Brian Wing Shun Chan
29   *
30   */
31  public interface UserIdMapperPersistence extends BasePersistence {
32      public void cacheResult(com.liferay.portal.model.UserIdMapper userIdMapper);
33  
34      public void cacheResult(
35          java.util.List<com.liferay.portal.model.UserIdMapper> userIdMappers);
36  
37      public void clearCache();
38  
39      public com.liferay.portal.model.UserIdMapper create(long userIdMapperId);
40  
41      public com.liferay.portal.model.UserIdMapper remove(long userIdMapperId)
42          throws com.liferay.portal.NoSuchUserIdMapperException,
43              com.liferay.portal.SystemException;
44  
45      public com.liferay.portal.model.UserIdMapper remove(
46          com.liferay.portal.model.UserIdMapper userIdMapper)
47          throws com.liferay.portal.SystemException;
48  
49      /**
50       * @deprecated Use <code>update(UserIdMapper userIdMapper, boolean merge)</code>.
51       */
52      public com.liferay.portal.model.UserIdMapper update(
53          com.liferay.portal.model.UserIdMapper userIdMapper)
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        userIdMapper 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 userIdMapper 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.UserIdMapper update(
70          com.liferay.portal.model.UserIdMapper userIdMapper, boolean merge)
71          throws com.liferay.portal.SystemException;
72  
73      public com.liferay.portal.model.UserIdMapper updateImpl(
74          com.liferay.portal.model.UserIdMapper userIdMapper, boolean merge)
75          throws com.liferay.portal.SystemException;
76  
77      public com.liferay.portal.model.UserIdMapper findByPrimaryKey(
78          long userIdMapperId)
79          throws com.liferay.portal.NoSuchUserIdMapperException,
80              com.liferay.portal.SystemException;
81  
82      public com.liferay.portal.model.UserIdMapper fetchByPrimaryKey(
83          long userIdMapperId) throws com.liferay.portal.SystemException;
84  
85      public java.util.List<com.liferay.portal.model.UserIdMapper> findByUserId(
86          long userId) throws com.liferay.portal.SystemException;
87  
88      public java.util.List<com.liferay.portal.model.UserIdMapper> findByUserId(
89          long userId, int start, int end)
90          throws com.liferay.portal.SystemException;
91  
92      public java.util.List<com.liferay.portal.model.UserIdMapper> findByUserId(
93          long userId, int start, int end,
94          com.liferay.portal.kernel.util.OrderByComparator obc)
95          throws com.liferay.portal.SystemException;
96  
97      public com.liferay.portal.model.UserIdMapper findByUserId_First(
98          long userId, com.liferay.portal.kernel.util.OrderByComparator obc)
99          throws com.liferay.portal.NoSuchUserIdMapperException,
100             com.liferay.portal.SystemException;
101 
102     public com.liferay.portal.model.UserIdMapper findByUserId_Last(
103         long userId, com.liferay.portal.kernel.util.OrderByComparator obc)
104         throws com.liferay.portal.NoSuchUserIdMapperException,
105             com.liferay.portal.SystemException;
106 
107     public com.liferay.portal.model.UserIdMapper[] findByUserId_PrevAndNext(
108         long userIdMapperId, long userId,
109         com.liferay.portal.kernel.util.OrderByComparator obc)
110         throws com.liferay.portal.NoSuchUserIdMapperException,
111             com.liferay.portal.SystemException;
112 
113     public com.liferay.portal.model.UserIdMapper findByU_T(long userId,
114         java.lang.String type)
115         throws com.liferay.portal.NoSuchUserIdMapperException,
116             com.liferay.portal.SystemException;
117 
118     public com.liferay.portal.model.UserIdMapper fetchByU_T(long userId,
119         java.lang.String type) throws com.liferay.portal.SystemException;
120 
121     public com.liferay.portal.model.UserIdMapper fetchByU_T(long userId,
122         java.lang.String type, boolean retrieveFromCache)
123         throws com.liferay.portal.SystemException;
124 
125     public com.liferay.portal.model.UserIdMapper findByT_E(
126         java.lang.String type, java.lang.String externalUserId)
127         throws com.liferay.portal.NoSuchUserIdMapperException,
128             com.liferay.portal.SystemException;
129 
130     public com.liferay.portal.model.UserIdMapper fetchByT_E(
131         java.lang.String type, java.lang.String externalUserId)
132         throws com.liferay.portal.SystemException;
133 
134     public com.liferay.portal.model.UserIdMapper fetchByT_E(
135         java.lang.String type, java.lang.String externalUserId,
136         boolean retrieveFromCache) throws com.liferay.portal.SystemException;
137 
138     public java.util.List<Object> findWithDynamicQuery(
139         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
140         throws com.liferay.portal.SystemException;
141 
142     public java.util.List<Object> findWithDynamicQuery(
143         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
144         int end) throws com.liferay.portal.SystemException;
145 
146     public java.util.List<com.liferay.portal.model.UserIdMapper> findAll()
147         throws com.liferay.portal.SystemException;
148 
149     public java.util.List<com.liferay.portal.model.UserIdMapper> findAll(
150         int start, int end) throws com.liferay.portal.SystemException;
151 
152     public java.util.List<com.liferay.portal.model.UserIdMapper> findAll(
153         int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
154         throws com.liferay.portal.SystemException;
155 
156     public void removeByUserId(long userId)
157         throws com.liferay.portal.SystemException;
158 
159     public void removeByU_T(long userId, java.lang.String type)
160         throws com.liferay.portal.NoSuchUserIdMapperException,
161             com.liferay.portal.SystemException;
162 
163     public void removeByT_E(java.lang.String type,
164         java.lang.String externalUserId)
165         throws com.liferay.portal.NoSuchUserIdMapperException,
166             com.liferay.portal.SystemException;
167 
168     public void removeAll() throws com.liferay.portal.SystemException;
169 
170     public int countByUserId(long userId)
171         throws com.liferay.portal.SystemException;
172 
173     public int countByU_T(long userId, java.lang.String type)
174         throws com.liferay.portal.SystemException;
175 
176     public int countByT_E(java.lang.String type, java.lang.String externalUserId)
177         throws com.liferay.portal.SystemException;
178 
179     public int countAll() throws com.liferay.portal.SystemException;
180 }