001 /** 002 * Copyright (c) 2000-2010 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.annotation.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 * <p> 033 * Never modify or reference this interface directly. All methods that expect a user id mapper model instance should use the {@link UserIdMapper} interface instead. 034 * </p> 035 * 036 * @author Brian Wing Shun Chan 037 * @see UserIdMapper 038 * @see com.liferay.portal.model.impl.UserIdMapperImpl 039 * @see com.liferay.portal.model.impl.UserIdMapperModelImpl 040 * @generated 041 */ 042 public interface UserIdMapperModel extends BaseModel<UserIdMapper> { 043 /** 044 * Gets the primary key of this user id mapper. 045 * 046 * @return the primary key of this user id mapper 047 */ 048 public long getPrimaryKey(); 049 050 /** 051 * Sets the primary key of this user id mapper 052 * 053 * @param pk the primary key of this user id mapper 054 */ 055 public void setPrimaryKey(long pk); 056 057 /** 058 * Gets the user id mapper id of this user id mapper. 059 * 060 * @return the user id mapper id of this user id mapper 061 */ 062 public long getUserIdMapperId(); 063 064 /** 065 * Sets the user id mapper id of this user id mapper. 066 * 067 * @param userIdMapperId the user id mapper id of this user id mapper 068 */ 069 public void setUserIdMapperId(long userIdMapperId); 070 071 /** 072 * Gets the user id of this user id mapper. 073 * 074 * @return the user id of this user id mapper 075 */ 076 public long getUserId(); 077 078 /** 079 * Sets the user id of this user id mapper. 080 * 081 * @param userId the user id of this user id mapper 082 */ 083 public void setUserId(long userId); 084 085 /** 086 * Gets the user uuid of this user id mapper. 087 * 088 * @return the user uuid of this user id mapper 089 * @throws SystemException if a system exception occurred 090 */ 091 public String getUserUuid() throws SystemException; 092 093 /** 094 * Sets the user uuid of this user id mapper. 095 * 096 * @param userUuid the user uuid of this user id mapper 097 */ 098 public void setUserUuid(String userUuid); 099 100 /** 101 * Gets the type of this user id mapper. 102 * 103 * @return the type of this user id mapper 104 */ 105 @AutoEscape 106 public String getType(); 107 108 /** 109 * Sets the type of this user id mapper. 110 * 111 * @param type the type of this user id mapper 112 */ 113 public void setType(String type); 114 115 /** 116 * Gets the description of this user id mapper. 117 * 118 * @return the description of this user id mapper 119 */ 120 @AutoEscape 121 public String getDescription(); 122 123 /** 124 * Sets the description of this user id mapper. 125 * 126 * @param description the description of this user id mapper 127 */ 128 public void setDescription(String description); 129 130 /** 131 * Gets the external user id of this user id mapper. 132 * 133 * @return the external user id of this user id mapper 134 */ 135 @AutoEscape 136 public String getExternalUserId(); 137 138 /** 139 * Sets the external user id of this user id mapper. 140 * 141 * @param externalUserId the external user id of this user id mapper 142 */ 143 public void setExternalUserId(String externalUserId); 144 145 /** 146 * Gets a copy of this user id mapper as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}. 147 * 148 * @return the escaped model instance 149 * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler 150 */ 151 public UserIdMapper toEscapedModel(); 152 153 public boolean isNew(); 154 155 public void setNew(boolean n); 156 157 public boolean isCachedModel(); 158 159 public void setCachedModel(boolean cachedModel); 160 161 public boolean isEscapedModel(); 162 163 public void setEscapedModel(boolean escapedModel); 164 165 public Serializable getPrimaryKeyObj(); 166 167 public ExpandoBridge getExpandoBridge(); 168 169 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 170 171 public Object clone(); 172 173 public int compareTo(UserIdMapper userIdMapper); 174 175 public int hashCode(); 176 177 public String toString(); 178 179 public String toXmlString(); 180 }