|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.UserGroupServiceUtil
@ProviderType public class UserGroupServiceUtil
Provides the remote service utility for UserGroup. This utility wraps
UserGroupServiceImpl and is the
primary access point for service operations in application layer code running
on a remote server. Methods of this service are expected to have security
checks based on the propagated JAAS credentials because this service can be
accessed remotely.
UserGroupService,
UserGroupServiceBaseImpl,
UserGroupServiceImpl| Constructor Summary | |
|---|---|
UserGroupServiceUtil()
|
|
| Method Summary | |
|---|---|
static void |
addGroupUserGroups(long groupId,
long[] userGroupIds)
Adds the user groups to the group. |
static void |
addTeamUserGroups(long teamId,
long[] userGroupIds)
Adds the user groups to the team |
static UserGroup |
addUserGroup(String name,
String description)
Deprecated. As of 6.2.0, replaced by addUserGroup(String, String,
ServiceContext) |
static UserGroup |
addUserGroup(String name,
String description,
ServiceContext serviceContext)
Adds a user group. |
static void |
deleteUserGroup(long userGroupId)
Deletes the user group. |
static UserGroup |
fetchUserGroup(long userGroupId)
Fetches the user group with the primary key. |
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier. |
static UserGroupService |
getService()
|
static UserGroup |
getUserGroup(long userGroupId)
Returns the user group with the primary key. |
static UserGroup |
getUserGroup(String name)
Returns the user group with the name. |
static List<UserGroup> |
getUserGroups(long companyId)
|
static List<UserGroup> |
getUserUserGroups(long userId)
Returns all the user groups to which the user belongs. |
static void |
unsetGroupUserGroups(long groupId,
long[] userGroupIds)
Removes the user groups from the group. |
static void |
unsetTeamUserGroups(long teamId,
long[] userGroupIds)
Removes the user groups from the team. |
static UserGroup |
updateUserGroup(long userGroupId,
String name,
String description)
Deprecated. As of 6.2.0, replaced by updateUserGroup(long,
String, String, ServiceContext) |
static UserGroup |
updateUserGroup(long userGroupId,
String name,
String description,
ServiceContext serviceContext)
Updates the user group. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public UserGroupServiceUtil()
| Method Detail |
|---|
public static void addGroupUserGroups(long groupId,
long[] userGroupIds)
throws PortalException
groupId - the primary key of the groupuserGroupIds - the primary keys of the user groups
PortalException
public static void addTeamUserGroups(long teamId,
long[] userGroupIds)
throws PortalException
teamId - the primary key of the teamuserGroupIds - the primary keys of the user groups
PortalException
@Deprecated
public static UserGroup addUserGroup(String name,
String description)
throws PortalException
addUserGroup(String, String,
ServiceContext)
This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.
name - the user group's namedescription - the user group's description
PortalException
public static UserGroup addUserGroup(String name,
String description,
ServiceContext serviceContext)
throws PortalException
This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.
name - the user group's namedescription - the user group's descriptionserviceContext - the service context to be applied (optionally
null). Can set expando bridge attributes for the
user group.
PortalException
public static void deleteUserGroup(long userGroupId)
throws PortalException
userGroupId - the primary key of the user group
PortalException
public static UserGroup fetchUserGroup(long userGroupId)
throws PortalException
userGroupId - the primary key of the user group
PortalExceptionpublic static String getOSGiServiceIdentifier()
public static UserGroup getUserGroup(String name)
throws PortalException
name - the user group's name
PortalException
public static UserGroup getUserGroup(long userGroupId)
throws PortalException
userGroupId - the primary key of the user group
PortalException
public static List<UserGroup> getUserGroups(long companyId)
throws PortalException
PortalException
public static List<UserGroup> getUserUserGroups(long userId)
throws PortalException
userId - the primary key of the user
PortalException
public static void unsetGroupUserGroups(long groupId,
long[] userGroupIds)
throws PortalException
groupId - the primary key of the groupuserGroupIds - the primary keys of the user groups
PortalException
public static void unsetTeamUserGroups(long teamId,
long[] userGroupIds)
throws PortalException
teamId - the primary key of the teamuserGroupIds - the primary keys of the user groups
PortalException
@Deprecated
public static UserGroup updateUserGroup(long userGroupId,
String name,
String description)
throws PortalException
updateUserGroup(long,
String, String, ServiceContext)
userGroupId - the primary key of the user groupname - the user group's namedescription - the the user group's description
PortalException
public static UserGroup updateUserGroup(long userGroupId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException
userGroupId - the primary key of the user groupname - the user group's namedescription - the the user group's descriptionserviceContext - the service context to be applied (optionally
null). Can set expando bridge attributes for the
user group.
PortalExceptionpublic static UserGroupService getService()
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||