001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.model;
016    
017    import com.liferay.portal.kernel.bean.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.service.ServiceContext;
020    
021    import com.liferay.portlet.expando.model.ExpandoBridge;
022    
023    import java.io.Serializable;
024    
025    /**
026     * The base model interface for the UserIdMapper service. Represents a row in the "UserIdMapper" database table, with each column mapped to a property of this class.
027     *
028     * <p>
029     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.UserIdMapperModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portal.model.impl.UserIdMapperImpl}.
030     * </p>
031     *
032     * @author Brian Wing Shun Chan
033     * @see UserIdMapper
034     * @see com.liferay.portal.model.impl.UserIdMapperImpl
035     * @see com.liferay.portal.model.impl.UserIdMapperModelImpl
036     * @generated
037     */
038    public interface UserIdMapperModel extends BaseModel<UserIdMapper> {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * Never modify or reference this interface directly. All methods that expect a user ID mapper model instance should use the {@link UserIdMapper} interface instead.
043             */
044    
045            /**
046             * Returns the primary key of this user ID mapper.
047             *
048             * @return the primary key of this user ID mapper
049             */
050            public long getPrimaryKey();
051    
052            /**
053             * Sets the primary key of this user ID mapper.
054             *
055             * @param primaryKey the primary key of this user ID mapper
056             */
057            public void setPrimaryKey(long primaryKey);
058    
059            /**
060             * Returns the user ID mapper ID of this user ID mapper.
061             *
062             * @return the user ID mapper ID of this user ID mapper
063             */
064            public long getUserIdMapperId();
065    
066            /**
067             * Sets the user ID mapper ID of this user ID mapper.
068             *
069             * @param userIdMapperId the user ID mapper ID of this user ID mapper
070             */
071            public void setUserIdMapperId(long userIdMapperId);
072    
073            /**
074             * Returns the user ID of this user ID mapper.
075             *
076             * @return the user ID of this user ID mapper
077             */
078            public long getUserId();
079    
080            /**
081             * Sets the user ID of this user ID mapper.
082             *
083             * @param userId the user ID of this user ID mapper
084             */
085            public void setUserId(long userId);
086    
087            /**
088             * Returns the user uuid of this user ID mapper.
089             *
090             * @return the user uuid of this user ID mapper
091             * @throws SystemException if a system exception occurred
092             */
093            public String getUserUuid() throws SystemException;
094    
095            /**
096             * Sets the user uuid of this user ID mapper.
097             *
098             * @param userUuid the user uuid of this user ID mapper
099             */
100            public void setUserUuid(String userUuid);
101    
102            /**
103             * Returns the type of this user ID mapper.
104             *
105             * @return the type of this user ID mapper
106             */
107            @AutoEscape
108            public String getType();
109    
110            /**
111             * Sets the type of this user ID mapper.
112             *
113             * @param type the type of this user ID mapper
114             */
115            public void setType(String type);
116    
117            /**
118             * Returns the description of this user ID mapper.
119             *
120             * @return the description of this user ID mapper
121             */
122            @AutoEscape
123            public String getDescription();
124    
125            /**
126             * Sets the description of this user ID mapper.
127             *
128             * @param description the description of this user ID mapper
129             */
130            public void setDescription(String description);
131    
132            /**
133             * Returns the external user ID of this user ID mapper.
134             *
135             * @return the external user ID of this user ID mapper
136             */
137            @AutoEscape
138            public String getExternalUserId();
139    
140            /**
141             * Sets the external user ID of this user ID mapper.
142             *
143             * @param externalUserId the external user ID of this user ID mapper
144             */
145            public void setExternalUserId(String externalUserId);
146    
147            public boolean isNew();
148    
149            public void setNew(boolean n);
150    
151            public boolean isCachedModel();
152    
153            public void setCachedModel(boolean cachedModel);
154    
155            public boolean isEscapedModel();
156    
157            public Serializable getPrimaryKeyObj();
158    
159            public void setPrimaryKeyObj(Serializable primaryKeyObj);
160    
161            public ExpandoBridge getExpandoBridge();
162    
163            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
164    
165            public Object clone();
166    
167            public int compareTo(UserIdMapper userIdMapper);
168    
169            public int hashCode();
170    
171            public CacheModel<UserIdMapper> toCacheModel();
172    
173            public UserIdMapper toEscapedModel();
174    
175            public UserIdMapper toUnescapedModel();
176    
177            public String toString();
178    
179            public String toXmlString();
180    }