|
Liferay 6.2.0-ce-rc2 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.model.GroupWrapper
public class GroupWrapper
This class is a wrapper for Group.
Group,
Serialized Form| Constructor Summary | |
|---|---|
GroupWrapper(Group group)
|
|
| Method Summary | |
|---|---|
String |
buildTreePath()
|
Object |
clone()
Creates a shallow clone of this model instance. |
int |
compareTo(Group group)
|
boolean |
equals(Object obj)
|
boolean |
getActive()
Returns the active of this group. |
List<Group> |
getAncestors()
|
List<Group> |
getChildren(boolean site)
|
List<Group> |
getChildrenWithLayouts(boolean site,
int start,
int end)
|
int |
getChildrenWithLayoutsCount(boolean site)
|
String |
getClassName()
Returns the fully qualified class name of this group. |
long |
getClassNameId()
Returns the class name ID of this group. |
long |
getClassPK()
Returns the class p k of this group. |
long |
getCompanyId()
Returns the company ID of this group. |
long |
getCreatorUserId()
Returns the creator user ID of this group. |
String |
getCreatorUserUuid()
Returns the creator user uuid of this group. |
long |
getDefaultPrivatePlid()
|
long |
getDefaultPublicPlid()
|
String |
getDescription()
Returns the description of this group. |
String |
getDescriptiveName()
|
String |
getDescriptiveName(Locale locale)
|
ExpandoBridge |
getExpandoBridge()
Returns the expando bridge for this model instance. |
String |
getFriendlyURL()
Returns the friendly u r l of this group. |
long |
getGroupId()
Returns the group ID of this group. |
String |
getIconURL(ThemeDisplay themeDisplay)
|
String |
getLayoutRootNodeName(boolean privateLayout,
Locale locale)
|
Group |
getLiveGroup()
|
long |
getLiveGroupId()
Returns the live group ID of this group. |
String |
getLiveParentTypeSettingsProperty(String key)
|
boolean |
getManualMembership()
Returns the manual membership of this group. |
int |
getMembershipRestriction()
Returns the membership restriction of this group. |
Map<String,Object> |
getModelAttributes()
|
Class<?> |
getModelClass()
|
String |
getModelClassName()
|
String |
getName()
Returns the name of this group. |
long |
getOrganizationId()
|
Group |
getParentGroup()
|
long |
getParentGroupId()
Returns the parent group ID of this group. |
UnicodeProperties |
getParentLiveGroupTypeSettingsProperties()
|
String |
getPathFriendlyURL(boolean privateLayout,
ThemeDisplay themeDisplay)
|
long |
getPrimaryKey()
Returns the primary key of this group. |
Serializable |
getPrimaryKeyObj()
Returns the primary key of this model instance. |
LayoutSet |
getPrivateLayoutSet()
|
int |
getPrivateLayoutsPageCount()
|
LayoutSet |
getPublicLayoutSet()
|
int |
getPublicLayoutsPageCount()
|
int |
getRemoteStagingGroupCount()
Returns the remote staging group count of this group. |
String |
getScopeDescriptiveName(ThemeDisplay themeDisplay)
|
String |
getScopeLabel(ThemeDisplay themeDisplay)
|
boolean |
getSite()
Returns the site of this group. |
Group |
getStagingGroup()
|
String |
getTreePath()
Returns the tree path of this group. |
int |
getType()
Returns the type of this group. |
String |
getTypeLabel()
|
String |
getTypeSettings()
Returns the type settings of this group. |
UnicodeProperties |
getTypeSettingsProperties()
|
String |
getTypeSettingsProperty(String key)
|
String |
getUuid()
Returns the uuid of this group. |
Group |
getWrappedGroup()
Deprecated. As of 6.1.0, replaced by getWrappedModel() |
Group |
getWrappedModel()
|
boolean |
hasAncestor(long groupId)
|
int |
hashCode()
|
boolean |
hasLocalOrRemoteStagingGroup()
|
boolean |
hasPrivateLayouts()
|
boolean |
hasPublicLayouts()
|
boolean |
hasStagingGroup()
|
boolean |
isActive()
Returns true if this group is active. |
boolean |
isCachedModel()
Returns true if this model instance was retrieved from the
entity cache. |
boolean |
isChild(long groupId)
|
boolean |
isCommunity()
Deprecated. As of 6.1.0, renamed to isRegularSite() |
boolean |
isCompany()
|
boolean |
isCompanyStagingGroup()
|
boolean |
isControlPanel()
|
boolean |
isEscapedModel()
Returns true if this model instance is escaped. |
boolean |
isGuest()
|
boolean |
isInStagingPortlet(String portletId)
|
boolean |
isLayout()
|
boolean |
isLayoutPrototype()
|
boolean |
isLayoutSetPrototype()
|
boolean |
isLimitedToParentSiteMembers()
|
boolean |
isManualMembership()
Returns true if this group is manual membership. |
boolean |
isNew()
Returns true if this model instance does not yet exist in
the database. |
boolean |
isOrganization()
|
boolean |
isRegularSite()
|
boolean |
isRoot()
|
boolean |
isShowSite(PermissionChecker permissionChecker,
boolean privateSite)
|
boolean |
isSite()
Returns true if this group is site. |
boolean |
isStaged()
|
boolean |
isStagedPortlet(String portletId)
|
boolean |
isStagedRemotely()
|
boolean |
isStagingGroup()
|
boolean |
isUser()
|
boolean |
isUserGroup()
|
boolean |
isUserPersonalSite()
|
void |
persist()
Updates this model instance in the database or adds it if it does not yet exist. |
void |
resetOriginalValues()
Reset all original fields to current values. |
void |
setActive(boolean active)
Sets whether this group is active. |
void |
setCachedModel(boolean cachedModel)
Sets whether this model instance was retrieved from the entity cache. |
void |
setClassName(String className)
|
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 |
setExpandoBridgeAttributes(BaseModel<?> baseModel)
|
void |
setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
|
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 |
setManualMembership(boolean manualMembership)
Sets whether this group is manual membership. |
void |
setMembershipRestriction(int membershipRestriction)
Sets the membership restriction of this group. |
void |
setModelAttributes(Map<String,Object> attributes)
|
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 primaryKey)
Sets the primary key of this group. |
void |
setPrimaryKeyObj(Serializable primaryKeyObj)
Sets the primary key of this model instance. |
void |
setRemoteStagingGroupCount(int remoteStagingGroupCount)
Sets the remote staging group count of this group. |
void |
setSite(boolean site)
Sets whether this group is site. |
void |
setTreePath(String treePath)
Sets the tree path 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)
|
void |
setUuid(String uuid)
Sets the uuid of this group. |
CacheModel<Group> |
toCacheModel()
Returns a cache model object for this entity used by entity cache. |
Group |
toEscapedModel()
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler. |
String |
toString()
|
Group |
toUnescapedModel()
|
String |
toXmlString()
Returns the XML representation of this model instance. |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public GroupWrapper(Group group)
| Method Detail |
|---|
public Class<?> getModelClass()
getModelClass in interface ClassedModelpublic String getModelClassName()
getModelClassName in interface ClassedModelpublic Map<String,Object> getModelAttributes()
getModelAttributes in interface BaseModel<Group>public void setModelAttributes(Map<String,Object> attributes)
setModelAttributes in interface BaseModel<Group>public long getPrimaryKey()
getPrimaryKey in interface GroupModelpublic void setPrimaryKey(long primaryKey)
setPrimaryKey in interface GroupModelprimaryKey - the primary key of this grouppublic String getUuid()
getUuid in interface GroupModelpublic void setUuid(String uuid)
setUuid in interface GroupModeluuid - the uuid of this grouppublic long getGroupId()
getGroupId in interface GroupModelpublic void setGroupId(long groupId)
setGroupId in interface GroupModelgroupId - the group ID of this grouppublic long getCompanyId()
getCompanyId in interface GroupModelpublic void setCompanyId(long companyId)
setCompanyId in interface GroupModelcompanyId - the company ID of this grouppublic long getCreatorUserId()
getCreatorUserId in interface GroupModelpublic void setCreatorUserId(long creatorUserId)
setCreatorUserId in interface GroupModelcreatorUserId - the creator user ID of this group
public String getCreatorUserUuid()
throws SystemException
getCreatorUserUuid in interface GroupModelSystemException - if a system exception occurredpublic void setCreatorUserUuid(String creatorUserUuid)
setCreatorUserUuid in interface GroupModelcreatorUserUuid - the creator user uuid of this grouppublic String getClassName()
getClassName in interface GroupModelgetClassName in interface TypedModelpublic void setClassName(String className)
setClassName in interface GroupModelpublic long getClassNameId()
getClassNameId in interface GroupModelgetClassNameId in interface TypedModelpublic void setClassNameId(long classNameId)
setClassNameId in interface GroupModelsetClassNameId in interface TypedModelclassNameId - the class name ID of this grouppublic long getClassPK()
getClassPK in interface AttachedModelgetClassPK in interface GroupModelpublic void setClassPK(long classPK)
setClassPK in interface AttachedModelsetClassPK in interface GroupModelclassPK - the class p k of this grouppublic long getParentGroupId()
getParentGroupId in interface GroupModelpublic void setParentGroupId(long parentGroupId)
setParentGroupId in interface GroupModelparentGroupId - the parent group ID of this grouppublic long getLiveGroupId()
getLiveGroupId in interface GroupModelpublic void setLiveGroupId(long liveGroupId)
setLiveGroupId in interface GroupModelliveGroupId - the live group ID of this grouppublic String getTreePath()
getTreePath in interface GroupModelpublic void setTreePath(String treePath)
setTreePath in interface GroupModeltreePath - the tree path of this grouppublic String getName()
getName in interface GroupModelpublic void setName(String name)
setName in interface GroupModelname - the name of this grouppublic String getDescription()
getDescription in interface GroupModelpublic void setDescription(String description)
setDescription in interface GroupModeldescription - the description of this grouppublic int getType()
getType in interface GroupModelpublic void setType(int type)
setType in interface GroupModeltype - the type of this grouppublic String getTypeSettings()
getTypeSettings in interface GroupModelpublic void setTypeSettings(String typeSettings)
setTypeSettings in interface GroupModeltypeSettings - the type settings of this grouppublic boolean getManualMembership()
getManualMembership in interface GroupModelpublic boolean isManualMembership()
true if this group is manual membership.
isManualMembership in interface GroupModeltrue if this group is manual membership; false otherwisepublic void setManualMembership(boolean manualMembership)
setManualMembership in interface GroupModelmanualMembership - the manual membership of this grouppublic int getMembershipRestriction()
getMembershipRestriction in interface GroupModelpublic void setMembershipRestriction(int membershipRestriction)
setMembershipRestriction in interface GroupModelmembershipRestriction - the membership restriction of this grouppublic String getFriendlyURL()
getFriendlyURL in interface GroupModelpublic void setFriendlyURL(String friendlyURL)
setFriendlyURL in interface GroupModelfriendlyURL - the friendly u r l of this grouppublic boolean getSite()
getSite in interface GroupModelpublic boolean isSite()
true if this group is site.
isSite in interface GroupModeltrue if this group is site; false otherwisepublic void setSite(boolean site)
setSite in interface GroupModelsite - the site of this grouppublic int getRemoteStagingGroupCount()
getRemoteStagingGroupCount in interface GroupModelpublic void setRemoteStagingGroupCount(int remoteStagingGroupCount)
setRemoteStagingGroupCount in interface GroupModelremoteStagingGroupCount - the remote staging group count of this grouppublic boolean getActive()
getActive in interface GroupModelpublic boolean isActive()
true if this group is active.
isActive in interface GroupModeltrue if this group is active; false otherwisepublic void setActive(boolean active)
setActive in interface GroupModelactive - the active of this grouppublic boolean isNew()
BaseModeltrue if this model instance does not yet exist in
the database.
isNew in interface BaseModel<Group>isNew in interface GroupModeltrue if this model instance does not yet exist in
the database; false otherwisepublic void setNew(boolean n)
BaseModel
setNew in interface BaseModel<Group>setNew in interface GroupModeln - whether this model instance does not yet exist in the databasepublic boolean isCachedModel()
BaseModeltrue if this model instance was retrieved from the
entity cache.
isCachedModel in interface BaseModel<Group>isCachedModel in interface GroupModeltrue if this model instance was retrieved from the
entity cache; false otherwiseBaseModel.setCachedModel(boolean)public void setCachedModel(boolean cachedModel)
BaseModel
setCachedModel in interface BaseModel<Group>setCachedModel in interface GroupModelcachedModel - whether this model instance was retrieved from the
entity cacheEntityCachepublic boolean isEscapedModel()
BaseModeltrue if this model instance is escaped.
isEscapedModel in interface BaseModel<Group>isEscapedModel in interface GroupModeltrue if this model instance is escaped;
false otherwisepublic Serializable getPrimaryKeyObj()
BaseModel
getPrimaryKeyObj in interface BaseModel<Group>getPrimaryKeyObj in interface ClassedModelgetPrimaryKeyObj in interface GroupModelpublic void setPrimaryKeyObj(Serializable primaryKeyObj)
BaseModel
setPrimaryKeyObj in interface BaseModel<Group>setPrimaryKeyObj in interface ClassedModelsetPrimaryKeyObj in interface GroupModelprimaryKeyObj - the primary key of this model instancepublic ExpandoBridge getExpandoBridge()
BaseModel
getExpandoBridge in interface BaseModel<Group>getExpandoBridge in interface ClassedModelgetExpandoBridge in interface GroupModelpublic void setExpandoBridgeAttributes(BaseModel<?> baseModel)
setExpandoBridgeAttributes in interface BaseModel<Group>setExpandoBridgeAttributes in interface GroupModelpublic void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
setExpandoBridgeAttributes in interface BaseModel<Group>setExpandoBridgeAttributes in interface GroupModelpublic void setExpandoBridgeAttributes(ServiceContext serviceContext)
BaseModel
setExpandoBridgeAttributes in interface BaseModel<Group>setExpandoBridgeAttributes in interface GroupModelserviceContext - the service context to be appliedServiceContext.getExpandoBridgeAttributes(
)public Object clone()
BaseModel
clone in interface BaseModel<Group>clone in interface GroupModelclone in class Objectpublic int compareTo(Group group)
compareTo in interface GroupModelcompareTo in interface Comparable<Group>public int hashCode()
hashCode in interface GroupModelhashCode in class Objectpublic CacheModel<Group> toCacheModel()
BaseModel
toCacheModel in interface BaseModel<Group>toCacheModel in interface GroupModelpublic Group toEscapedModel()
BaseModelAutoEscapeBeanHandler.
toEscapedModel in interface BaseModel<Group>toEscapedModel in interface GroupModelAutoEscapeBeanHandlerpublic Group toUnescapedModel()
toUnescapedModel in interface BaseModel<Group>toUnescapedModel in interface GroupModelpublic String toString()
toString in interface GroupModeltoString in class Objectpublic String toXmlString()
BaseModel
toXmlString in interface BaseModel<Group>toXmlString in interface GroupModel
public void persist()
throws SystemException
PersistedModel
persist in interface PersistedModelSystemException - if a system exception occurred
public String buildTreePath()
throws PortalException,
SystemException
buildTreePath in interface GroupPortalException
SystemException
public List<Group> getAncestors()
throws PortalException,
SystemException
getAncestors in interface GroupPortalException
SystemException
public List<Group> getChildren(boolean site)
throws SystemException
getChildren in interface GroupSystemException
public List<Group> getChildrenWithLayouts(boolean site,
int start,
int end)
throws SystemException
getChildrenWithLayouts in interface GroupSystemException
public int getChildrenWithLayoutsCount(boolean site)
throws SystemException
getChildrenWithLayoutsCount in interface GroupSystemExceptionpublic long getDefaultPrivatePlid()
getDefaultPrivatePlid in interface Grouppublic long getDefaultPublicPlid()
getDefaultPublicPlid in interface Group
public String getDescriptiveName()
throws PortalException,
SystemException
getDescriptiveName in interface GroupPortalException
SystemException
public String getDescriptiveName(Locale locale)
throws PortalException,
SystemException
getDescriptiveName in interface GroupPortalException
SystemExceptionpublic String getIconURL(ThemeDisplay themeDisplay)
getIconURL in interface Group
public String getLayoutRootNodeName(boolean privateLayout,
Locale locale)
getLayoutRootNodeName in interface Grouppublic Group getLiveGroup()
getLiveGroup in interface Grouppublic String getLiveParentTypeSettingsProperty(String key)
getLiveParentTypeSettingsProperty in interface Grouppublic long getOrganizationId()
getOrganizationId in interface Group
public Group getParentGroup()
throws PortalException,
SystemException
getParentGroup in interface GroupPortalException
SystemExceptionpublic UnicodeProperties getParentLiveGroupTypeSettingsProperties()
getParentLiveGroupTypeSettingsProperties in interface Group
public String getPathFriendlyURL(boolean privateLayout,
ThemeDisplay themeDisplay)
getPathFriendlyURL in interface Grouppublic LayoutSet getPrivateLayoutSet()
getPrivateLayoutSet in interface Grouppublic int getPrivateLayoutsPageCount()
getPrivateLayoutsPageCount in interface Grouppublic LayoutSet getPublicLayoutSet()
getPublicLayoutSet in interface Grouppublic int getPublicLayoutsPageCount()
getPublicLayoutsPageCount in interface Group
public String getScopeDescriptiveName(ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getScopeDescriptiveName in interface GroupPortalException
SystemExceptionpublic String getScopeLabel(ThemeDisplay themeDisplay)
getScopeLabel in interface Grouppublic Group getStagingGroup()
getStagingGroup in interface Grouppublic String getTypeLabel()
getTypeLabel in interface Grouppublic UnicodeProperties getTypeSettingsProperties()
getTypeSettingsProperties in interface Grouppublic String getTypeSettingsProperty(String key)
getTypeSettingsProperty in interface Grouppublic boolean hasAncestor(long groupId)
hasAncestor in interface Grouppublic boolean hasLocalOrRemoteStagingGroup()
hasLocalOrRemoteStagingGroup in interface Grouppublic boolean hasPrivateLayouts()
hasPrivateLayouts in interface Grouppublic boolean hasPublicLayouts()
hasPublicLayouts in interface Grouppublic boolean hasStagingGroup()
hasStagingGroup in interface Grouppublic boolean isChild(long groupId)
isChild in interface Grouppublic boolean isCommunity()
isRegularSite()
isCommunity in interface Grouppublic boolean isCompany()
isCompany in interface Grouppublic boolean isCompanyStagingGroup()
isCompanyStagingGroup in interface Grouppublic boolean isControlPanel()
isControlPanel in interface Grouppublic boolean isGuest()
isGuest in interface Grouppublic boolean isInStagingPortlet(String portletId)
isInStagingPortlet in interface Grouppublic boolean isLayout()
isLayout in interface Grouppublic boolean isLayoutPrototype()
isLayoutPrototype in interface Grouppublic boolean isLayoutSetPrototype()
isLayoutSetPrototype in interface Grouppublic boolean isLimitedToParentSiteMembers()
isLimitedToParentSiteMembers in interface Grouppublic boolean isOrganization()
isOrganization in interface Grouppublic boolean isRegularSite()
isRegularSite in interface Grouppublic boolean isRoot()
isRoot in interface Group
public boolean isShowSite(PermissionChecker permissionChecker,
boolean privateSite)
throws PortalException,
SystemException
isShowSite in interface GroupPortalException
SystemExceptionpublic boolean isStaged()
isStaged in interface Grouppublic boolean isStagedPortlet(String portletId)
isStagedPortlet in interface Grouppublic boolean isStagedRemotely()
isStagedRemotely in interface Grouppublic boolean isStagingGroup()
isStagingGroup in interface Grouppublic boolean isUser()
isUser in interface Grouppublic boolean isUserGroup()
isUserGroup in interface Grouppublic boolean isUserPersonalSite()
isUserPersonalSite in interface Grouppublic void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
setTypeSettingsProperties in interface Grouppublic boolean equals(Object obj)
equals in class Objectpublic Group getWrappedGroup()
getWrappedModel()
public Group getWrappedModel()
getWrappedModel in interface ModelWrapper<Group>public void resetOriginalValues()
BaseModel
resetOriginalValues in interface BaseModel<Group>
|
Liferay 6.2.0-ce-rc2 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||