|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ProviderType @AccessControlled @JSONWebService @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface GroupService
Provides the remote service interface for Group. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
GroupServiceUtil
,
GroupServiceBaseImpl
,
GroupServiceImpl
Method Summary | |
---|---|
Group |
addGroup(long parentGroupId,
long liveGroupId,
String name,
String description,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Adds a group. |
Group |
addGroup(long parentGroupId,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Deprecated. As of 6.2.0, replaced by addGroup(long, long, String,
String, int, boolean, int, String, boolean, boolean,
ServiceContext) |
Group |
addGroup(String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Deprecated. As of 6.2.0, replaced by addGroup(long, String,
String, int, String, boolean, boolean, ServiceContext) |
void |
addRoleGroups(long roleId,
long[] groupIds)
Adds the groups to the role. |
void |
checkRemoteStagingGroup(long groupId)
Checks that the current user is permitted to use the group for Remote Staging. |
void |
deleteGroup(long groupId)
Deletes the group. |
void |
disableStaging(long groupId)
|
void |
enableStaging(long groupId)
|
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
Group |
getCompanyGroup(long companyId)
Returns the company group. |
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> |
getGroups(long companyId,
long parentGroupId,
boolean site)
Returns all the groups that are direct children of the parent group. |
List<Group> |
getManageableSiteGroups(Collection<Portlet> portlets,
int max)
Returns a range of all the site groups for which the user has control panel access. |
List<Group> |
getManageableSites(Collection<Portlet> portlets,
int max)
Deprecated. As of 6.2.0, replaced by getManageableSiteGroups(Collection, int) |
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)
Deprecated. As of 6.2.0, replaced by getUserSitesGroups(long,
String[], boolean, int) |
List<Group> |
getUserPlaces(long userId,
String[] classNames,
int max)
Deprecated. As of 6.2.0, replaced by getUserSitesGroups(long,
String[], int) |
List<Group> |
getUserPlaces(String[] classNames,
int max)
Deprecated. As of 6.2.0, replaced by getUserSitesGroups(
String[], int) |
int |
getUserPlacesCount()
Deprecated. As of 6.2.0, replaced by getUserSitesGroupsCount() |
List<Group> |
getUserSites()
Deprecated. As of 6.2.0, replaced by getUserSitesGroups() |
List<Group> |
getUserSitesGroups()
|
List<Group> |
getUserSitesGroups(long userId,
String[] classNames,
boolean includeControlPanel,
int max)
|
List<Group> |
getUserSitesGroups(long userId,
String[] classNames,
int max)
Returns the user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel. |
List<Group> |
getUserSitesGroups(String[] classNames,
int max)
Returns the guest or current user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel. |
int |
getUserSitesGroupsCount()
Returns the number of the guest or current user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel. |
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,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
|
List<Group> |
search(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator obc)
|
List<Group> |
search(long companyId,
String name,
String description,
String[] params,
int start,
int end)
Returns an 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 |
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,
long parentGroupId,
String name,
String description,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
Updates the group. |
Group |
updateGroup(long groupId,
String typeSettings)
Updates the group's type settings. |
void |
updateStagedPortlets(long groupId,
Map<String,String> stagedPortletIds)
|
Method Detail |
---|
String getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanGroup addGroup(long parentGroupId, long liveGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) throws PortalException, SystemException
parentGroupId
- the primary key of the parent groupliveGroupId
- 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 occurredGroup addGroup(long parentGroupId, String name, String description, int type, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) throws PortalException, SystemException
addGroup(long, long, String,
String, int, boolean, int, String, boolean, boolean,
ServiceContext)
parentGroupId
- the primary key of the parent 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 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 occurredGroup addGroup(String name, String description, int type, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) throws PortalException, SystemException
addGroup(long, String,
String, int, String, boolean, boolean, ServiceContext)
PortalException
SystemException
void addRoleGroups(long roleId, long[] groupIds) throws PortalException, SystemException
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 occurredvoid checkRemoteStagingGroup(long groupId) throws PortalException, SystemException
groupId
- the primary key of the group
PortalException
- if a group with the primary key could not be
found, if the current user did not have permission to view the
group, or if the group's company was different from the current
user's company
SystemException
- if a system exception occurredvoid 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.
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 occurredvoid disableStaging(long groupId) throws PortalException, SystemException
PortalException
SystemException
void enableStaging(long groupId) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Group getCompanyGroup(long companyId) throws PortalException, SystemException
companyId
- the primary key of the company
PortalException
- if a matching group could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Group getGroup(long groupId) throws PortalException, SystemException
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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) Group getGroup(long companyId, String name) throws PortalException, SystemException
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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getGroups(long companyId, long parentGroupId, boolean site) throws PortalException, SystemException
companyId
- the primary key of the companyparentGroupId
- the primary key of the parent groupsite
- whether the group is to be associated with a main site
null
if no matches were
found
PortalException
- if the user did not have permission to view the
group or if a portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getManageableSiteGroups(Collection<Portlet> portlets, int max) throws PortalException, SystemException
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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getManageableSites(Collection<Portlet> portlets, int max) throws PortalException, SystemException
getManageableSiteGroups(Collection, int)
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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getOrganizationsGroups(List<Organization> organizations) throws PortalException, SystemException
organizations
- the organizations
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Group getUserGroup(long companyId, long userId) throws PortalException, SystemException
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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserGroupsGroups(List<UserGroup> userGroups) throws PortalException, SystemException
userGroups
- the user groups
PortalException
- if any one of the user group's group could not be
found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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.
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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserPlaces(long userId, String[] classNames, boolean includeControlPanel, int max) throws PortalException, SystemException
getUserSitesGroups(long,
String[], boolean, int)
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserPlaces(long userId, String[] classNames, int max) throws PortalException, SystemException
getUserSitesGroups(long,
String[], int)
classNames
value of null
includes the user's layout set group,
organization groups, inherited organization groups, and site groups.
userId
- the primary key of the userclassNames
- the group entity class names (optionally
null
). For more information see getUserSitesGroups(long, String[], int)
max
- the maximum number of groups to return
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserPlaces(String[] classNames, int max) throws PortalException, SystemException
getUserSitesGroups(
String[], int)
classNames
value of null
includes the user's layout set group,
organization groups, inherited organization groups, and site groups.
classNames
- the group entity class names (optionally
null
). For more information see getUserSitesGroups(String[], int)
max
- the maximum number of groups to return
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getUserPlacesCount() throws PortalException, SystemException
getUserSitesGroupsCount()
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSites() throws PortalException, SystemException
getUserSitesGroups()
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups() throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups(long userId, String[] classNames, boolean includeControlPanel, int max) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups(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.
userId
- the primary key of the userclassNames
- the group entity class names (optionally
null
). For more information see getUserSitesGroups(long, String[], boolean, int)
max
- the maximum number of groups to return
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> getUserSitesGroups(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.
classNames
- the group entity class names (optionally
null
). For more information see getUserSitesGroups(long, String[], boolean, int)
max
- the maximum number of groups to return
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getUserSitesGroupsCount() throws PortalException, SystemException
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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.
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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Group> search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator obc) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) 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.
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 occurred@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, String name, String description, String[] params) throws SystemException
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 occurredvoid setRoleGroups(long roleId, long[] groupIds) throws PortalException, SystemException
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 occurredvoid unsetRoleGroups(long roleId, long[] groupIds) throws PortalException, SystemException
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 occurredGroup updateFriendlyURL(long groupId, String friendlyURL) throws PortalException, SystemException
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 occurredGroup updateGroup(long groupId, long parentGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean active, ServiceContext serviceContext) throws PortalException, SystemException
groupId
- the primary key of the groupparentGroupId
- the primary key of the parent 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 occurredGroup updateGroup(long groupId, String typeSettings) throws PortalException, SystemException
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 occurredvoid updateStagedPortlets(long groupId, Map<String,String> stagedPortletIds) throws PortalException, SystemException
PortalException
SystemException
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |