|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.GroupServiceWrapper
public class GroupServiceWrapper
This class is a wrapper for GroupService
.
GroupService
Constructor Summary | |
---|---|
GroupServiceWrapper(GroupService groupService)
|
Method Summary | |
---|---|
Group |
addGroup(long liveGroupId,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Adds a group. |
Group |
addGroup(String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Adds the group using the group default live group ID. |
void |
addRoleGroups(long roleId,
long[] groupIds)
Adds the groups to the role. |
void |
deleteGroup(long groupId)
Deletes the group. |
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
Group |
getGroup(long groupId)
Returns the group with the primary key. |
Group |
getGroup(long companyId,
String name)
Returns the group with the name. |
List<Group> |
getManageableSites(Collection<Portlet> portlets,
int max)
Returns a range of all the site groups for which the user has control panel access. |
List<Group> |
getOrganizationsGroups(List<Organization> organizations)
Returns the groups associated with the organizations. |
Group |
getUserGroup(long companyId,
long userId)
Returns the group associated with the user. |
List<Group> |
getUserGroupsGroups(List<UserGroup> userGroups)
Returns the groups associated with the user groups. |
List<Group> |
getUserOrganizationsGroups(long userId,
int start,
int end)
Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property organizations.membership.strict is set to
true . |
List<Group> |
getUserPlaces(long userId,
String[] classNames,
boolean includeControlPanel,
int max)
|
List<Group> |
getUserPlaces(long userId,
String[] classNames,
int max)
Returns the user's group "places" associated with the group entity class names, including the control panel group if the user is permitted to view the control panel. |
List<Group> |
getUserPlaces(String[] classNames,
int max)
Returns the guest or current user's group "places" associated with the group entity class names, including the control panel group if the user is permitted to view the control panel. |
List<Group> |
getUserSites()
Returns the guest or current user's layout set group, organization groups, inherited organization groups, and site groups. |
GroupService |
getWrappedGroupService()
Deprecated. Renamed to getWrappedService() |
GroupService |
getWrappedService()
|
boolean |
hasUserGroup(long userId,
long groupId)
Returns true if the user is associated with the group,
including the user's inherited organizations and user groups. |
List<Group> |
search(long companyId,
String name,
String description,
String[] params,
int start,
int end)
Returns a name ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. |
int |
searchCount(long companyId,
String name,
String description,
String[] params)
Returns the number of groups and organization groups that match the name and description, optionally including the user's inherited organizations and user groups. |
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setRoleGroups(long roleId,
long[] groupIds)
Sets the groups associated with the role, removing and adding associations as necessary. |
void |
setWrappedGroupService(GroupService groupService)
Deprecated. Renamed to setWrappedService(com.liferay.portal.service.GroupService) |
void |
setWrappedService(GroupService groupService)
|
void |
unsetRoleGroups(long roleId,
long[] groupIds)
Removes the groups from the role. |
Group |
updateFriendlyURL(long groupId,
String friendlyURL)
Updates the group's friendly URL. |
Group |
updateGroup(long groupId,
String typeSettings)
Updates the group's type settings. |
Group |
updateGroup(long groupId,
String name,
String description,
int type,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
Updates the group. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GroupServiceWrapper(GroupService groupService)
Method Detail |
---|
public String getBeanIdentifier()
getBeanIdentifier
in interface GroupService
public void setBeanIdentifier(String beanIdentifier)
setBeanIdentifier
in interface GroupService
beanIdentifier
- the Spring bean ID for this beanpublic Group addGroup(long liveGroupId, String name, String description, int type, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) throws PortalException, SystemException
addGroup
in interface GroupService
liveGroupId
- the primary key of the live groupname
- the entity's namedescription
- the group's description (optionally
null
)type
- the group's type. For more information see GroupConstants
friendlyURL
- the group's friendlyURL (optionally
null
)site
- whether the group is to be associated with a main siteactive
- whether the group is activeserviceContext
- the service context to be applied (optionally
null
). Can set the asset category IDs and asset tag
names for the group, and can set whether the group is for staging
PortalException
- if the user did not have permission to add the
group, if a creator could not be found, if the group's
information was invalid, if a layout could not be found, or if a
valid friendly URL could not be created for the group
SystemException
- if a system exception occurredpublic Group addGroup(String name, String description, int type, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) throws PortalException, SystemException
addGroup
in interface GroupService
name
- the entity's namedescription
- the group's description (optionally
null
)type
- the group's type. For more information see GroupConstants
friendlyURL
- the group's friendlyURLsite
- whether the group is to be associated with a main siteactive
- whether the group is activeserviceContext
- the service context to be applied (optionally
null
). Can set asset category IDs and asset tag
names for the group, and can set whether the group is for staging
PortalException
- if the user did not have permission to add the
group, if a creator could not be found, if the group's
information was invalid, if a layout could not be found, or if a
valid friendly URL could not be created for the group
SystemException
- if a system exception occurredpublic void addRoleGroups(long roleId, long[] groupIds) throws PortalException, SystemException
addRoleGroups
in interface GroupService
roleId
- the primary key of the rolegroupIds
- the primary keys of the groups
PortalException
- if the user did not have permission to update the
role
SystemException
- if a system exception occurredpublic void deleteGroup(long groupId) throws PortalException, SystemException
The group is unstaged and its assets and resources including layouts, membership requests, subscriptions, teams, blogs, bookmarks, calendar events, image gallery, journals, message boards, polls, shopping related entities, software catalog, and wikis are also deleted.
deleteGroup
in interface GroupService
groupId
- the primary key of the group
PortalException
- if the user did not have permission to delete the
group or its assets or resources, if a group with the primary key
could not be found, or if the group was a system group
SystemException
- if a system exception occurredpublic Group getGroup(long groupId) throws PortalException, SystemException
getGroup
in interface GroupService
groupId
- the primary key of the group
PortalException
- if a group with the primary key could not be
found or if the current user did not have permission to view the
group
SystemException
- if a system exception occurredpublic Group getGroup(long companyId, String name) throws PortalException, SystemException
getGroup
in interface GroupService
companyId
- the primary key of the companyname
- the group's name
PortalException
- if a matching group could not be found or if the
current user did not have permission to view the group
SystemException
- if a system exception occurredpublic List<Group> getManageableSites(Collection<Portlet> portlets, int max) throws PortalException, SystemException
getManageableSites
in interface GroupService
portlets
- the portlets to managemax
- the upper bound of the range of groups to consider (not
inclusive)
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic List<Group> getOrganizationsGroups(List<Organization> organizations) throws PortalException, SystemException
getOrganizationsGroups
in interface GroupService
organizations
- the organizations
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic Group getUserGroup(long companyId, long userId) throws PortalException, SystemException
getUserGroup
in interface GroupService
companyId
- the primary key of the companyuserId
- the primary key of the user
PortalException
- if a matching group could not be found or if the
current user did not have permission to view the group
SystemException
- if a system exception occurredpublic List<Group> getUserGroupsGroups(List<UserGroup> userGroups) throws PortalException, SystemException
getUserGroupsGroups
in interface GroupService
userGroups
- the user groups
PortalException
- if any one of the user group's group could not be
found
SystemException
- if a system exception occurredpublic List<Group> getUserOrganizationsGroups(long userId, int start, int end) throws PortalException, SystemException
organizations.membership.strict
is set to
true
.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
getUserOrganizationsGroups
in interface GroupService
userId
- the primary key of the userstart
- the lower bound of the range of groups to considerend
- the upper bound of the range of groups to consider (not
inclusive)
PortalException
- if a user with the primary key could not be found
or if another portal exception occurred
SystemException
- if a system exception occurredpublic List<Group> getUserPlaces(long userId, String[] classNames, boolean includeControlPanel, int max) throws PortalException, SystemException
getUserPlaces
in interface GroupService
PortalException
SystemException
public List<Group> getUserPlaces(long userId, String[] classNames, int max) throws PortalException, SystemException
classNames
value of null
includes the user's layout set group,
organization groups, inherited organization groups, and site groups.
getUserPlaces
in interface GroupService
userId
- the primary key of the userclassNames
- the group entity class names (optionally
null
). For more information see getUserPlaces(long, String[], int)
max
- the maximum number of groups to return
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic List<Group> getUserPlaces(String[] classNames, int max) throws PortalException, SystemException
classNames
value of null
includes the user's layout set group,
organization groups, inherited organization groups, and site groups.
getUserPlaces
in interface GroupService
classNames
- the group entity class names (optionally
null
). For more information see getUserPlaces(String[], int)
max
- the maximum number of groups to return
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic List<Group> getUserSites() throws PortalException, SystemException
getUserSites
in interface GroupService
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic boolean hasUserGroup(long userId, long groupId) throws PortalException, SystemException
true
if the user is associated with the group,
including the user's inherited organizations and user groups. System and
staged groups are not included.
hasUserGroup
in interface GroupService
userId
- the primary key of the usergroupId
- the primary key of the group
true
if the user is associated with the group;
false
otherwise
PortalException
- if the current user did not have permission to
view the user or group members
SystemException
- if a system exception occurredpublic List<Group> search(long companyId, String name, String description, String[] params, int start, int end) throws PortalException, SystemException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
search
in interface GroupService
companyId
- the primary key of the companyname
- the group's name (optionally null
)description
- the group's description (optionally
null
)params
- the finder params (optionally null
). To
include the user's inherited organizations and user groups in the
search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder
start
- the lower bound of the range of groups to returnend
- the upper bound of the range of groups to return (not
inclusive)
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic int searchCount(long companyId, String name, String description, String[] params) throws SystemException
searchCount
in interface GroupService
companyId
- the primary key of the companyname
- the group's name (optionally null
)description
- the group's description (optionally
null
)params
- the finder params (optionally null
). To
include the user's inherited organizations and user groups in the
search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder
SystemException
- if a system exception occurredpublic void setRoleGroups(long roleId, long[] groupIds) throws PortalException, SystemException
setRoleGroups
in interface GroupService
roleId
- the primary key of the rolegroupIds
- the primary keys of the groups
PortalException
- if the user did not have permission to update
update the role
SystemException
- if a system exception occurredpublic void unsetRoleGroups(long roleId, long[] groupIds) throws PortalException, SystemException
unsetRoleGroups
in interface GroupService
roleId
- the primary key of the rolegroupIds
- the primary keys of the groups
PortalException
- if the user did not have permission to update the
role
SystemException
- if a system exception occurredpublic Group updateFriendlyURL(long groupId, String friendlyURL) throws PortalException, SystemException
updateFriendlyURL
in interface GroupService
groupId
- the primary key of the groupfriendlyURL
- the group's new friendlyURL (optionally
null
)
PortalException
- if the user did not have permission to update the
group, if a group with the primary key could not be found, or if
a valid friendly URL could not be created for the group
SystemException
- if a system exception occurredpublic Group updateGroup(long groupId, String typeSettings) throws PortalException, SystemException
updateGroup
in interface GroupService
groupId
- the primary key of the grouptypeSettings
- the group's new type settings (optionally
null
)
PortalException
- if the user did not have permission to update the
group or if a group with the primary key could not be found
SystemException
- if a system exception occurredpublic Group updateGroup(long groupId, String name, String description, int type, String friendlyURL, boolean active, ServiceContext serviceContext) throws PortalException, SystemException
updateGroup
in interface GroupService
groupId
- the primary key of the groupname
- the group's new namedescription
- the group's new description (optionally
null
)type
- the group's new type. For more information see GroupConstants
friendlyURL
- the group's new friendlyURL (optionally
null
)active
- whether the group is activeserviceContext
- the service context to be applied (optionally
null
). Can set the asset category IDs and asset tag
names for the group.
PortalException
- if the user did not have permission to update the
group, if a group with the primary key could not be found, if the
friendly URL was invalid or could one not be created
SystemException
- if a system exception occurredpublic GroupService getWrappedGroupService()
getWrappedService()
public void setWrappedGroupService(GroupService groupService)
setWrappedService(com.liferay.portal.service.GroupService)
public GroupService getWrappedService()
getWrappedService
in interface ServiceWrapper<GroupService>
public void setWrappedService(GroupService groupService)
setWrappedService
in interface ServiceWrapper<GroupService>
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |