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