|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.UserGroupLocalServiceUtil
public class UserGroupLocalServiceUtil
The utility for the user group local service. This utility wraps UserGroupLocalServiceImpl
and is the primary access point for service operations in application layer code running on the local server.
Never modify this class directly. Add custom service methods to UserGroupLocalServiceImpl
and rerun ServiceBuilder to regenerate this class.
This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
UserGroupLocalService
,
UserGroupLocalServiceBaseImpl
,
UserGroupLocalServiceImpl
Constructor Summary | |
---|---|
UserGroupLocalServiceUtil()
|
Method Summary | |
---|---|
static void |
addGroupUserGroups(long groupId,
long[] userGroupIds)
|
static UserGroup |
addUserGroup(long userId,
long companyId,
String name,
String description)
|
static UserGroup |
addUserGroup(UserGroup userGroup)
Adds the user group to the database. |
static void |
clearUserUserGroups(long userId)
|
static void |
copyUserGroupLayouts(long[] userGroupIds,
long userId)
|
static void |
copyUserGroupLayouts(long userGroupId,
long userId)
|
static void |
copyUserGroupLayouts(long userGroupId,
long[] userIds)
|
static UserGroup |
createUserGroup(long userGroupId)
Creates a new user group with the primary key. |
static void |
deleteUserGroup(long userGroupId)
Deletes the user group with the primary key from the database. |
static void |
deleteUserGroup(UserGroup userGroup)
Deletes the user group from the database. |
static List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Counts the number of rows that match the dynamic query. |
static UserGroupLocalService |
getService()
|
static UserGroup |
getUserGroup(long userGroupId)
Gets the user group with the primary key. |
static UserGroup |
getUserGroup(long companyId,
String name)
|
static List<UserGroup> |
getUserGroups(int start,
int end)
Gets a range of all the user groups. |
static List<UserGroup> |
getUserGroups(long companyId)
|
static List<UserGroup> |
getUserGroups(long[] userGroupIds)
|
static int |
getUserGroupsCount()
Gets the number of user groups. |
static List<UserGroup> |
getUserUserGroups(long userId)
|
static boolean |
hasGroupUserGroup(long groupId,
long userGroupId)
|
static List<UserGroup> |
search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
|
static int |
searchCount(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params)
|
void |
setService(UserGroupLocalService service)
|
static void |
setUserUserGroups(long userId,
long[] userGroupIds)
|
static void |
unsetGroupUserGroups(long groupId,
long[] userGroupIds)
|
static UserGroup |
updateUserGroup(long companyId,
long userGroupId,
String name,
String description)
|
static UserGroup |
updateUserGroup(UserGroup userGroup)
Updates the user group in the database. |
static UserGroup |
updateUserGroup(UserGroup userGroup,
boolean merge)
Updates the user group in the database. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UserGroupLocalServiceUtil()
Method Detail |
---|
public static UserGroup addUserGroup(UserGroup userGroup) throws SystemException
userGroup
- the user group to add
SystemException
- if a system exception occurredpublic static UserGroup createUserGroup(long userGroupId)
userGroupId
- the primary key for the new user group
public static void deleteUserGroup(long userGroupId) throws PortalException, SystemException
userGroupId
- the primary key of the user group to delete
PortalException
- if a user group with the primary key could not be found
SystemException
- if a system exception occurredpublic static void deleteUserGroup(UserGroup userGroup) throws SystemException
userGroup
- the user group to delete
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws 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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws 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.
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)orderByComparator
- the comparator to order the results by
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static UserGroup getUserGroup(long userGroupId) throws PortalException, SystemException
userGroupId
- the primary key of the user group to get
PortalException
- if a user group with the primary key could not be found
SystemException
- if a system exception occurredpublic static List<UserGroup> getUserGroups(int start, int end) throws 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.
start
- the lower bound of the range of user groups to returnend
- the upper bound of the range of user groups to return (not inclusive)
SystemException
- if a system exception occurredpublic static int getUserGroupsCount() throws SystemException
SystemException
- if a system exception occurredpublic static UserGroup updateUserGroup(UserGroup userGroup) throws SystemException
userGroup
- the user group to update
SystemException
- if a system exception occurredpublic static UserGroup updateUserGroup(UserGroup userGroup, boolean merge) throws SystemException
userGroup
- the user group to updatemerge
- whether to merge the user group with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)
for an explanation.
SystemException
- if a system exception occurredpublic static void addGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
SystemException
public static UserGroup addUserGroup(long userId, long companyId, String name, String description) throws PortalException, SystemException
PortalException
SystemException
public static void clearUserUserGroups(long userId) throws SystemException
SystemException
public static void copyUserGroupLayouts(long userGroupId, long[] userIds) throws PortalException, SystemException
PortalException
SystemException
public static void copyUserGroupLayouts(long[] userGroupIds, long userId) throws PortalException, SystemException
PortalException
SystemException
public static void copyUserGroupLayouts(long userGroupId, long userId) throws PortalException, SystemException
PortalException
SystemException
public static UserGroup getUserGroup(long companyId, String name) throws PortalException, SystemException
PortalException
SystemException
public static List<UserGroup> getUserGroups(long companyId) throws SystemException
SystemException
public static List<UserGroup> getUserGroups(long[] userGroupIds) throws PortalException, SystemException
PortalException
SystemException
public static List<UserGroup> getUserUserGroups(long userId) throws SystemException
SystemException
public static boolean hasGroupUserGroup(long groupId, long userGroupId) throws SystemException
SystemException
public static List<UserGroup> search(long companyId, String name, String description, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc) throws SystemException
SystemException
public static int searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params) throws SystemException
SystemException
public static void setUserUserGroups(long userId, long[] userGroupIds) throws PortalException, SystemException
PortalException
SystemException
public static void unsetGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
SystemException
public static UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description) throws PortalException, SystemException
PortalException
SystemException
public static UserGroupLocalService getService()
public void setService(UserGroupLocalService service)
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |