Liferay 6.0.5

com.liferay.portal.model
Class GroupWrapper

java.lang.Object
  extended by com.liferay.portal.model.GroupWrapper
All Implemented Interfaces:
BaseModel<Group>, Group, GroupModel, Serializable, Cloneable, Comparable<Group>

public class GroupWrapper
extends Object
implements Group

This class is a wrapper for Group.

See Also:
Group, Serialized Form
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
GroupWrapper(Group group)
           
 
Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Group group)
           
 boolean getActive()
          Gets the active of this group.
 String getClassName()
          Gets the class name of the model instance this group is polymorphically associated with.
 long getClassNameId()
          Gets the class name id of this group.
 long getClassPK()
          Gets the class p k of this group.
 long getCompanyId()
          Gets the company id of this group.
 long getCreatorUserId()
          Gets the creator user id of this group.
 String getCreatorUserUuid()
          Gets the creator user uuid of this group.
 long getDefaultPrivatePlid()
           
 long getDefaultPublicPlid()
           
 String getDescription()
          Gets the description of this group.
 String getDescriptiveName()
           
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getFriendlyURL()
          Gets the friendly u r l of this group.
 long getGroupId()
          Gets the group id of this group.
 Group getLiveGroup()
           
 long getLiveGroupId()
          Gets the live group id of this group.
 String getName()
          Gets the name of this group.
 long getOrganizationId()
           
 long getParentGroupId()
          Gets the parent group id of this group.
 String getPathFriendlyURL(boolean privateLayout, ThemeDisplay themeDisplay)
           
 long getPrimaryKey()
          Gets the primary key of this group.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 LayoutSet getPrivateLayoutSet()
           
 int getPrivateLayoutsPageCount()
           
 LayoutSet getPublicLayoutSet()
           
 int getPublicLayoutsPageCount()
           
 Group getStagingGroup()
           
 int getType()
          Gets the type of this group.
 String getTypeLabel()
           
 String getTypeSettings()
          Gets the type settings of this group.
 UnicodeProperties getTypeSettingsProperties()
           
 String getTypeSettingsProperty(String key)
           
 String getWorkflowRoleNames()
           
 int getWorkflowStages()
           
 Group getWrappedGroup()
           
 int hashCode()
           
 boolean hasPrivateLayouts()
           
 boolean hasPublicLayouts()
           
 boolean hasStagingGroup()
           
 boolean isActive()
          Determines whether this group is active.
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isCommunity()
           
 boolean isCompany()
           
 boolean isControlPanel()
           
 boolean isEscapedModel()
          Determines if this model instance is escaped.
 boolean isLayout()
           
 boolean isLayoutPrototype()
           
 boolean isLayoutSetPrototype()
           
 boolean isNew()
          Determines if this model instance does not yet exist in the database.
 boolean isOrganization()
           
 boolean isStaged()
           
 boolean isStagedPortlet(String portletId)
           
 boolean isStagedRemotely()
           
 boolean isStagingGroup()
           
 boolean isUser()
           
 boolean isUserGroup()
           
 boolean isWorkflowEnabled()
           
 void setActive(boolean active)
          Sets whether this {$entity.humanName} is active.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setClassNameId(long classNameId)
          Sets the class name id of this group.
 void setClassPK(long classPK)
          Sets the class p k of this group.
 void setCompanyId(long companyId)
          Sets the company id of this group.
 void setCreatorUserId(long creatorUserId)
          Sets the creator user id of this group.
 void setCreatorUserUuid(String creatorUserUuid)
          Sets the creator user uuid of this group.
 void setDescription(String description)
          Sets the description of this group.
 void setEscapedModel(boolean escapedModel)
          Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setFriendlyURL(String friendlyURL)
          Sets the friendly u r l of this group.
 void setGroupId(long groupId)
          Sets the group id of this group.
 void setLiveGroupId(long liveGroupId)
          Sets the live group id of this group.
 void setName(String name)
          Sets the name of this group.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setParentGroupId(long parentGroupId)
          Sets the parent group id of this group.
 void setPrimaryKey(long pk)
          Sets the primary key of this group
 void setType(int type)
          Sets the type of this group.
 void setTypeSettings(String typeSettings)
          Sets the type settings of this group.
 void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
           
 Group toEscapedModel()
          Gets a copy of this group as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GroupWrapper

public GroupWrapper(Group group)
Method Detail

getPrimaryKey

public long getPrimaryKey()
Description copied from interface: GroupModel
Gets the primary key of this group.

Specified by:
getPrimaryKey in interface GroupModel
Returns:
the primary key of this group

setPrimaryKey

public void setPrimaryKey(long pk)
Description copied from interface: GroupModel
Sets the primary key of this group

Specified by:
setPrimaryKey in interface GroupModel
Parameters:
pk - the primary key of this group

getGroupId

public long getGroupId()
Description copied from interface: GroupModel
Gets the group id of this group.

Specified by:
getGroupId in interface GroupModel
Returns:
the group id of this group

setGroupId

public void setGroupId(long groupId)
Description copied from interface: GroupModel
Sets the group id of this group.

Specified by:
setGroupId in interface GroupModel
Parameters:
groupId - the group id of this group

getCompanyId

public long getCompanyId()
Description copied from interface: GroupModel
Gets the company id of this group.

Specified by:
getCompanyId in interface GroupModel
Returns:
the company id of this group

setCompanyId

public void setCompanyId(long companyId)
Description copied from interface: GroupModel
Sets the company id of this group.

Specified by:
setCompanyId in interface GroupModel
Parameters:
companyId - the company id of this group

getCreatorUserId

public long getCreatorUserId()
Description copied from interface: GroupModel
Gets the creator user id of this group.

Specified by:
getCreatorUserId in interface GroupModel
Returns:
the creator user id of this group

setCreatorUserId

public void setCreatorUserId(long creatorUserId)
Description copied from interface: GroupModel
Sets the creator user id of this group.

Specified by:
setCreatorUserId in interface GroupModel
Parameters:
creatorUserId - the creator user id of this group

getCreatorUserUuid

public String getCreatorUserUuid()
                          throws SystemException
Description copied from interface: GroupModel
Gets the creator user uuid of this group.

Specified by:
getCreatorUserUuid in interface GroupModel
Returns:
the creator user uuid of this group
Throws:
SystemException - if a system exception occurred

setCreatorUserUuid

public void setCreatorUserUuid(String creatorUserUuid)
Description copied from interface: GroupModel
Sets the creator user uuid of this group.

Specified by:
setCreatorUserUuid in interface GroupModel
Parameters:
creatorUserUuid - the creator user uuid of this group

getClassName

public String getClassName()
Description copied from interface: GroupModel
Gets the class name of the model instance this group is polymorphically associated with.

Specified by:
getClassName in interface GroupModel
Returns:
the class name of the model instance this group is polymorphically associated with

getClassNameId

public long getClassNameId()
Description copied from interface: GroupModel
Gets the class name id of this group.

Specified by:
getClassNameId in interface GroupModel
Returns:
the class name id of this group

setClassNameId

public void setClassNameId(long classNameId)
Description copied from interface: GroupModel
Sets the class name id of this group.

Specified by:
setClassNameId in interface GroupModel
Parameters:
classNameId - the class name id of this group

getClassPK

public long getClassPK()
Description copied from interface: GroupModel
Gets the class p k of this group.

Specified by:
getClassPK in interface GroupModel
Returns:
the class p k of this group

setClassPK

public void setClassPK(long classPK)
Description copied from interface: GroupModel
Sets the class p k of this group.

Specified by:
setClassPK in interface GroupModel
Parameters:
classPK - the class p k of this group

getParentGroupId

public long getParentGroupId()
Description copied from interface: GroupModel
Gets the parent group id of this group.

Specified by:
getParentGroupId in interface GroupModel
Returns:
the parent group id of this group

setParentGroupId

public void setParentGroupId(long parentGroupId)
Description copied from interface: GroupModel
Sets the parent group id of this group.

Specified by:
setParentGroupId in interface GroupModel
Parameters:
parentGroupId - the parent group id of this group

getLiveGroupId

public long getLiveGroupId()
Description copied from interface: GroupModel
Gets the live group id of this group.

Specified by:
getLiveGroupId in interface GroupModel
Returns:
the live group id of this group

setLiveGroupId

public void setLiveGroupId(long liveGroupId)
Description copied from interface: GroupModel
Sets the live group id of this group.

Specified by:
setLiveGroupId in interface GroupModel
Parameters:
liveGroupId - the live group id of this group

getName

public String getName()
Description copied from interface: GroupModel
Gets the name of this group.

Specified by:
getName in interface GroupModel
Returns:
the name of this group

setName

public void setName(String name)
Description copied from interface: GroupModel
Sets the name of this group.

Specified by:
setName in interface GroupModel
Parameters:
name - the name of this group

getDescription

public String getDescription()
Description copied from interface: GroupModel
Gets the description of this group.

Specified by:
getDescription in interface GroupModel
Returns:
the description of this group

setDescription

public void setDescription(String description)
Description copied from interface: GroupModel
Sets the description of this group.

Specified by:
setDescription in interface GroupModel
Parameters:
description - the description of this group

getType

public int getType()
Description copied from interface: GroupModel
Gets the type of this group.

Specified by:
getType in interface GroupModel
Returns:
the type of this group

setType

public void setType(int type)
Description copied from interface: GroupModel
Sets the type of this group.

Specified by:
setType in interface GroupModel
Parameters:
type - the type of this group

getTypeSettings

public String getTypeSettings()
Description copied from interface: GroupModel
Gets the type settings of this group.

Specified by:
getTypeSettings in interface Group
Specified by:
getTypeSettings in interface GroupModel
Returns:
the type settings of this group

setTypeSettings

public void setTypeSettings(String typeSettings)
Description copied from interface: GroupModel
Sets the type settings of this group.

Specified by:
setTypeSettings in interface Group
Specified by:
setTypeSettings in interface GroupModel
Parameters:
typeSettings - the type settings of this group

getFriendlyURL

public String getFriendlyURL()
Description copied from interface: GroupModel
Gets the friendly u r l of this group.

Specified by:
getFriendlyURL in interface GroupModel
Returns:
the friendly u r l of this group

setFriendlyURL

public void setFriendlyURL(String friendlyURL)
Description copied from interface: GroupModel
Sets the friendly u r l of this group.

Specified by:
setFriendlyURL in interface GroupModel
Parameters:
friendlyURL - the friendly u r l of this group

getActive

public boolean getActive()
Description copied from interface: GroupModel
Gets the active of this group.

Specified by:
getActive in interface GroupModel
Returns:
the active of this group

isActive

public boolean isActive()
Description copied from interface: GroupModel
Determines whether this group is active.

Specified by:
isActive in interface GroupModel
Returns:
whether this group is active

setActive

public void setActive(boolean active)
Description copied from interface: GroupModel
Sets whether this {$entity.humanName} is active.

Specified by:
setActive in interface GroupModel
Parameters:
active - the active of this group

toEscapedModel

public Group toEscapedModel()
Description copied from interface: GroupModel
Gets a copy of this group as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface GroupModel
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

isNew

public boolean isNew()
Description copied from interface: BaseModel
Determines if this model instance does not yet exist in the database.

Specified by:
isNew in interface BaseModel<Group>
Specified by:
isNew in interface GroupModel
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

public void setNew(boolean n)
Description copied from interface: BaseModel
Sets whether this model instance does not yet exist in the database.

Specified by:
setNew in interface BaseModel<Group>
Specified by:
setNew in interface GroupModel
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

public boolean isCachedModel()
Description copied from interface: BaseModel
Determines if this model instance was retrieved from the entity cache.

Specified by:
isCachedModel in interface BaseModel<Group>
Specified by:
isCachedModel in interface GroupModel
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

public void setCachedModel(boolean cachedModel)
Description copied from interface: BaseModel
Sets whether this model instance was retrieved from the entity cache.

Specified by:
setCachedModel in interface BaseModel<Group>
Specified by:
setCachedModel in interface GroupModel
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

public boolean isEscapedModel()
Description copied from interface: BaseModel
Determines if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<Group>
Specified by:
isEscapedModel in interface GroupModel
Returns:
true if this model instance is escaped; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

public void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:
setEscapedModel in interface BaseModel<Group>
Specified by:
setEscapedModel in interface GroupModel
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Gets the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<Group>
Specified by:
getPrimaryKeyObj in interface GroupModel
Returns:
the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Gets the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<Group>
Specified by:
getExpandoBridge in interface GroupModel
Returns:
the expando bridge for this model instance

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ServiceContext serviceContext)
Description copied from interface: BaseModel
Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:
setExpandoBridgeAttributes in interface BaseModel<Group>
Specified by:
setExpandoBridgeAttributes in interface GroupModel
Parameters:
serviceContext - the service context to retrieve the expando bridge attributes from
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

public Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<Group>
Specified by:
clone in interface GroupModel
Overrides:
clone in class Object
Returns:
the shallow clone of this model instance

compareTo

public int compareTo(Group group)
Specified by:
compareTo in interface GroupModel
Specified by:
compareTo in interface Comparable<Group>

hashCode

public int hashCode()
Specified by:
hashCode in interface GroupModel
Overrides:
hashCode in class Object

toString

public String toString()
Specified by:
toString in interface GroupModel
Overrides:
toString in class Object

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Gets the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<Group>
Specified by:
toXmlString in interface GroupModel
Returns:
the XML representation of this model instance

getDefaultPrivatePlid

public long getDefaultPrivatePlid()
Specified by:
getDefaultPrivatePlid in interface Group

getDefaultPublicPlid

public long getDefaultPublicPlid()
Specified by:
getDefaultPublicPlid in interface Group

getDescriptiveName

public String getDescriptiveName()
                          throws PortalException,
                                 SystemException
Specified by:
getDescriptiveName in interface Group
Throws:
PortalException
SystemException

getLiveGroup

public Group getLiveGroup()
Specified by:
getLiveGroup in interface Group

getOrganizationId

public long getOrganizationId()
Specified by:
getOrganizationId in interface Group

getPathFriendlyURL

public String getPathFriendlyURL(boolean privateLayout,
                                 ThemeDisplay themeDisplay)
Specified by:
getPathFriendlyURL in interface Group

getPrivateLayoutSet

public LayoutSet getPrivateLayoutSet()
Specified by:
getPrivateLayoutSet in interface Group

getPrivateLayoutsPageCount

public int getPrivateLayoutsPageCount()
Specified by:
getPrivateLayoutsPageCount in interface Group

getPublicLayoutSet

public LayoutSet getPublicLayoutSet()
Specified by:
getPublicLayoutSet in interface Group

getPublicLayoutsPageCount

public int getPublicLayoutsPageCount()
Specified by:
getPublicLayoutsPageCount in interface Group

getStagingGroup

public Group getStagingGroup()
Specified by:
getStagingGroup in interface Group

getTypeLabel

public String getTypeLabel()
Specified by:
getTypeLabel in interface Group

getTypeSettingsProperties

public UnicodeProperties getTypeSettingsProperties()
Specified by:
getTypeSettingsProperties in interface Group

getTypeSettingsProperty

public String getTypeSettingsProperty(String key)
Specified by:
getTypeSettingsProperty in interface Group

getWorkflowRoleNames

public String getWorkflowRoleNames()
Specified by:
getWorkflowRoleNames in interface Group

getWorkflowStages

public int getWorkflowStages()
Specified by:
getWorkflowStages in interface Group

hasPrivateLayouts

public boolean hasPrivateLayouts()
Specified by:
hasPrivateLayouts in interface Group

hasPublicLayouts

public boolean hasPublicLayouts()
Specified by:
hasPublicLayouts in interface Group

hasStagingGroup

public boolean hasStagingGroup()
Specified by:
hasStagingGroup in interface Group

isCommunity

public boolean isCommunity()
Specified by:
isCommunity in interface Group

isCompany

public boolean isCompany()
Specified by:
isCompany in interface Group

isControlPanel

public boolean isControlPanel()
Specified by:
isControlPanel in interface Group

isLayout

public boolean isLayout()
Specified by:
isLayout in interface Group

isLayoutPrototype

public boolean isLayoutPrototype()
Specified by:
isLayoutPrototype in interface Group

isLayoutSetPrototype

public boolean isLayoutSetPrototype()
Specified by:
isLayoutSetPrototype in interface Group

isOrganization

public boolean isOrganization()
Specified by:
isOrganization in interface Group

isStaged

public boolean isStaged()
Specified by:
isStaged in interface Group

isStagedPortlet

public boolean isStagedPortlet(String portletId)
Specified by:
isStagedPortlet in interface Group

isStagedRemotely

public boolean isStagedRemotely()
Specified by:
isStagedRemotely in interface Group

isStagingGroup

public boolean isStagingGroup()
Specified by:
isStagingGroup in interface Group

isUser

public boolean isUser()
Specified by:
isUser in interface Group

isUserGroup

public boolean isUserGroup()
Specified by:
isUserGroup in interface Group

isWorkflowEnabled

public boolean isWorkflowEnabled()
Specified by:
isWorkflowEnabled in interface Group

setTypeSettingsProperties

public void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
Specified by:
setTypeSettingsProperties in interface Group

getWrappedGroup

public Group getWrappedGroup()

Liferay 6.0.5