com.liferay.portal.model.GroupModel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.model;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.bean.AutoEscape;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.service.ServiceContext;
import com.liferay.portlet.expando.model.ExpandoBridge;
import java.io.Serializable;
/**
* The base model interface for the Group service. Represents a row in the "Group_" database table, with each column mapped to a property of this class.
*
*
* This interface and its corresponding implementation {@link com.liferay.portal.model.impl.GroupModelImpl} 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.GroupImpl}.
*
*
* @author Brian Wing Shun Chan
* @see Group
* @see com.liferay.portal.model.impl.GroupImpl
* @see com.liferay.portal.model.impl.GroupModelImpl
* @generated
*/
@ProviderType
public interface GroupModel extends AttachedModel, BaseModel {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. All methods that expect a group model instance should use the {@link Group} interface instead.
*/
/**
* Returns the primary key of this group.
*
* @return the primary key of this group
*/
public long getPrimaryKey();
/**
* Sets the primary key of this group.
*
* @param primaryKey the primary key of this group
*/
public void setPrimaryKey(long primaryKey);
/**
* Returns the uuid of this group.
*
* @return the uuid of this group
*/
@AutoEscape
public String getUuid();
/**
* Sets the uuid of this group.
*
* @param uuid the uuid of this group
*/
public void setUuid(String uuid);
/**
* Returns the group ID of this group.
*
* @return the group ID of this group
*/
public long getGroupId();
/**
* Sets the group ID of this group.
*
* @param groupId the group ID of this group
*/
public void setGroupId(long groupId);
/**
* Returns the company ID of this group.
*
* @return the company ID of this group
*/
public long getCompanyId();
/**
* Sets the company ID of this group.
*
* @param companyId the company ID of this group
*/
public void setCompanyId(long companyId);
/**
* Returns the creator user ID of this group.
*
* @return the creator user ID of this group
*/
public long getCreatorUserId();
/**
* Sets the creator user ID of this group.
*
* @param creatorUserId the creator user ID of this group
*/
public void setCreatorUserId(long creatorUserId);
/**
* Returns the creator user uuid of this group.
*
* @return the creator user uuid of this group
* @throws SystemException if a system exception occurred
*/
public String getCreatorUserUuid() throws SystemException;
/**
* Sets the creator user uuid of this group.
*
* @param creatorUserUuid the creator user uuid of this group
*/
public void setCreatorUserUuid(String creatorUserUuid);
/**
* Returns the fully qualified class name of this group.
*
* @return the fully qualified class name of this group
*/
@Override
public String getClassName();
public void setClassName(String className);
/**
* Returns the class name ID of this group.
*
* @return the class name ID of this group
*/
@Override
public long getClassNameId();
/**
* Sets the class name ID of this group.
*
* @param classNameId the class name ID of this group
*/
@Override
public void setClassNameId(long classNameId);
/**
* Returns the class p k of this group.
*
* @return the class p k of this group
*/
@Override
public long getClassPK();
/**
* Sets the class p k of this group.
*
* @param classPK the class p k of this group
*/
@Override
public void setClassPK(long classPK);
/**
* Returns the parent group ID of this group.
*
* @return the parent group ID of this group
*/
public long getParentGroupId();
/**
* Sets the parent group ID of this group.
*
* @param parentGroupId the parent group ID of this group
*/
public void setParentGroupId(long parentGroupId);
/**
* Returns the live group ID of this group.
*
* @return the live group ID of this group
*/
public long getLiveGroupId();
/**
* Sets the live group ID of this group.
*
* @param liveGroupId the live group ID of this group
*/
public void setLiveGroupId(long liveGroupId);
/**
* Returns the tree path of this group.
*
* @return the tree path of this group
*/
@AutoEscape
public String getTreePath();
/**
* Sets the tree path of this group.
*
* @param treePath the tree path of this group
*/
public void setTreePath(String treePath);
/**
* Returns the name of this group.
*
* @return the name of this group
*/
@AutoEscape
public String getName();
/**
* Sets the name of this group.
*
* @param name the name of this group
*/
public void setName(String name);
/**
* Returns the description of this group.
*
* @return the description of this group
*/
@AutoEscape
public String getDescription();
/**
* Sets the description of this group.
*
* @param description the description of this group
*/
public void setDescription(String description);
/**
* Returns the type of this group.
*
* @return the type of this group
*/
public int getType();
/**
* Sets the type of this group.
*
* @param type the type of this group
*/
public void setType(int type);
/**
* Returns the type settings of this group.
*
* @return the type settings of this group
*/
@AutoEscape
public String getTypeSettings();
/**
* Sets the type settings of this group.
*
* @param typeSettings the type settings of this group
*/
public void setTypeSettings(String typeSettings);
/**
* Returns the manual membership of this group.
*
* @return the manual membership of this group
*/
public boolean getManualMembership();
/**
* Returns true if this group is manual membership.
*
* @return true if this group is manual membership; false otherwise
*/
public boolean isManualMembership();
/**
* Sets whether this group is manual membership.
*
* @param manualMembership the manual membership of this group
*/
public void setManualMembership(boolean manualMembership);
/**
* Returns the membership restriction of this group.
*
* @return the membership restriction of this group
*/
public int getMembershipRestriction();
/**
* Sets the membership restriction of this group.
*
* @param membershipRestriction the membership restriction of this group
*/
public void setMembershipRestriction(int membershipRestriction);
/**
* Returns the friendly u r l of this group.
*
* @return the friendly u r l of this group
*/
@AutoEscape
public String getFriendlyURL();
/**
* Sets the friendly u r l of this group.
*
* @param friendlyURL the friendly u r l of this group
*/
public void setFriendlyURL(String friendlyURL);
/**
* Returns the site of this group.
*
* @return the site of this group
*/
public boolean getSite();
/**
* Returns true if this group is site.
*
* @return true if this group is site; false otherwise
*/
public boolean isSite();
/**
* Sets whether this group is site.
*
* @param site the site of this group
*/
public void setSite(boolean site);
/**
* Returns the remote staging group count of this group.
*
* @return the remote staging group count of this group
*/
public int getRemoteStagingGroupCount();
/**
* Sets the remote staging group count of this group.
*
* @param remoteStagingGroupCount the remote staging group count of this group
*/
public void setRemoteStagingGroupCount(int remoteStagingGroupCount);
/**
* Returns the active of this group.
*
* @return the active of this group
*/
public boolean getActive();
/**
* Returns true if this group is active.
*
* @return true if this group is active; false otherwise
*/
public boolean isActive();
/**
* Sets whether this group is active.
*
* @param active the active of this group
*/
public void setActive(boolean active);
@Override
public boolean isNew();
@Override
public void setNew(boolean n);
@Override
public boolean isCachedModel();
@Override
public void setCachedModel(boolean cachedModel);
@Override
public boolean isEscapedModel();
@Override
public Serializable getPrimaryKeyObj();
@Override
public void setPrimaryKeyObj(Serializable primaryKeyObj);
@Override
public ExpandoBridge getExpandoBridge();
@Override
public void setExpandoBridgeAttributes(BaseModel baseModel);
@Override
public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
@Override
public void setExpandoBridgeAttributes(ServiceContext serviceContext);
@Override
public Object clone();
@Override
public int compareTo(Group group);
@Override
public int hashCode();
@Override
public CacheModel toCacheModel();
@Override
public Group toEscapedModel();
@Override
public Group toUnescapedModel();
@Override
public String toString();
@Override
public String toXmlString();
}