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.service.ServiceContext; 019 020 import com.liferay.portlet.expando.model.ExpandoBridge; 021 022 import java.io.Serializable; 023 024 /** 025 * The base model interface for the UserGroup service. Represents a row in the "UserGroup" database table, with each column mapped to a property of this class. 026 * 027 * <p> 028 * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.UserGroupModelImpl} 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.UserGroupImpl}. 029 * </p> 030 * 031 * <p> 032 * Never modify or reference this interface directly. All methods that expect a user group model instance should use the {@link UserGroup} interface instead. 033 * </p> 034 * 035 * @author Brian Wing Shun Chan 036 * @see UserGroup 037 * @see com.liferay.portal.model.impl.UserGroupImpl 038 * @see com.liferay.portal.model.impl.UserGroupModelImpl 039 * @generated 040 */ 041 public interface UserGroupModel extends BaseModel<UserGroup> { 042 /** 043 * Gets the primary key of this user group. 044 * 045 * @return the primary key of this user group 046 */ 047 public long getPrimaryKey(); 048 049 /** 050 * Sets the primary key of this user group 051 * 052 * @param pk the primary key of this user group 053 */ 054 public void setPrimaryKey(long pk); 055 056 /** 057 * Gets the user group id of this user group. 058 * 059 * @return the user group id of this user group 060 */ 061 public long getUserGroupId(); 062 063 /** 064 * Sets the user group id of this user group. 065 * 066 * @param userGroupId the user group id of this user group 067 */ 068 public void setUserGroupId(long userGroupId); 069 070 /** 071 * Gets the company id of this user group. 072 * 073 * @return the company id of this user group 074 */ 075 public long getCompanyId(); 076 077 /** 078 * Sets the company id of this user group. 079 * 080 * @param companyId the company id of this user group 081 */ 082 public void setCompanyId(long companyId); 083 084 /** 085 * Gets the parent user group id of this user group. 086 * 087 * @return the parent user group id of this user group 088 */ 089 public long getParentUserGroupId(); 090 091 /** 092 * Sets the parent user group id of this user group. 093 * 094 * @param parentUserGroupId the parent user group id of this user group 095 */ 096 public void setParentUserGroupId(long parentUserGroupId); 097 098 /** 099 * Gets the name of this user group. 100 * 101 * @return the name of this user group 102 */ 103 @AutoEscape 104 public String getName(); 105 106 /** 107 * Sets the name of this user group. 108 * 109 * @param name the name of this user group 110 */ 111 public void setName(String name); 112 113 /** 114 * Gets the description of this user group. 115 * 116 * @return the description of this user group 117 */ 118 @AutoEscape 119 public String getDescription(); 120 121 /** 122 * Sets the description of this user group. 123 * 124 * @param description the description of this user group 125 */ 126 public void setDescription(String description); 127 128 /** 129 * Gets a copy of this user group as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}. 130 * 131 * @return the escaped model instance 132 * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler 133 */ 134 public UserGroup toEscapedModel(); 135 136 public boolean isNew(); 137 138 public void setNew(boolean n); 139 140 public boolean isCachedModel(); 141 142 public void setCachedModel(boolean cachedModel); 143 144 public boolean isEscapedModel(); 145 146 public void setEscapedModel(boolean escapedModel); 147 148 public Serializable getPrimaryKeyObj(); 149 150 public ExpandoBridge getExpandoBridge(); 151 152 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 153 154 public Object clone(); 155 156 public int compareTo(UserGroup userGroup); 157 158 public int hashCode(); 159 160 public String toString(); 161 162 public String toXmlString(); 163 }