|
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.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.
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 |
addGroupUserGroup(long groupId,
long userGroupId)
|
static void |
addGroupUserGroup(long groupId,
UserGroup userGroup)
|
static void |
addGroupUserGroups(long groupId,
List<UserGroup> UserGroups)
|
static void |
addGroupUserGroups(long groupId,
long[] userGroupIds)
|
static void |
addTeamUserGroup(long teamId,
long userGroupId)
|
static void |
addTeamUserGroup(long teamId,
UserGroup userGroup)
|
static void |
addTeamUserGroups(long teamId,
List<UserGroup> UserGroups)
|
static void |
addTeamUserGroups(long teamId,
long[] userGroupIds)
|
static UserGroup |
addUserGroup(long userId,
long companyId,
String name,
String description)
Adds a user group. |
static UserGroup |
addUserGroup(UserGroup userGroup)
Adds the user group to the database. |
static void |
addUserUserGroup(long userId,
long userGroupId)
|
static void |
addUserUserGroup(long userId,
UserGroup userGroup)
|
static void |
addUserUserGroups(long userId,
List<UserGroup> UserGroups)
|
static void |
addUserUserGroups(long userId,
long[] userGroupIds)
|
static void |
clearGroupUserGroups(long groupId)
|
static void |
clearTeamUserGroups(long teamId)
|
static void |
clearUserUserGroups(long userId)
|
static void |
copyUserGroupLayouts(long[] userGroupIds,
long userId)
Deprecated. |
static void |
copyUserGroupLayouts(long userGroupId,
long userId)
Deprecated. |
static void |
copyUserGroupLayouts(long userGroupId,
long[] userIds)
Deprecated. |
static UserGroup |
createUserGroup(long userGroupId)
Creates a new user group with the primary key. |
static void |
deleteGroupUserGroup(long groupId,
long userGroupId)
|
static void |
deleteGroupUserGroup(long groupId,
UserGroup userGroup)
|
static void |
deleteGroupUserGroups(long groupId,
List<UserGroup> UserGroups)
|
static void |
deleteGroupUserGroups(long groupId,
long[] userGroupIds)
|
static void |
deleteTeamUserGroup(long teamId,
long userGroupId)
|
static void |
deleteTeamUserGroup(long teamId,
UserGroup userGroup)
|
static void |
deleteTeamUserGroups(long teamId,
List<UserGroup> UserGroups)
|
static void |
deleteTeamUserGroups(long teamId,
long[] userGroupIds)
|
static UserGroup |
deleteUserGroup(long userGroupId)
Deletes the user group with the primary key from the database. |
static UserGroup |
deleteUserGroup(UserGroup userGroup)
Deletes the user group from the database. |
static void |
deleteUserUserGroup(long userId,
long userGroupId)
|
static void |
deleteUserUserGroup(long userId,
UserGroup userGroup)
|
static void |
deleteUserUserGroups(long userId,
List<UserGroup> UserGroups)
|
static void |
deleteUserUserGroups(long userId,
long[] userGroupIds)
|
static DynamicQuery |
dynamicQuery()
|
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)
Returns the number of rows that match the dynamic query. |
static UserGroup |
fetchUserGroup(long userGroupId)
|
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
static List<UserGroup> |
getGroupUserGroups(long groupId)
|
static List<UserGroup> |
getGroupUserGroups(long groupId,
int start,
int end)
|
static List<UserGroup> |
getGroupUserGroups(long groupId,
int start,
int end,
OrderByComparator orderByComparator)
|
static int |
getGroupUserGroupsCount(long groupId)
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
static UserGroupLocalService |
getService()
|
static List<UserGroup> |
getTeamUserGroups(long teamId)
|
static List<UserGroup> |
getTeamUserGroups(long teamId,
int start,
int end)
|
static List<UserGroup> |
getTeamUserGroups(long teamId,
int start,
int end,
OrderByComparator orderByComparator)
|
static int |
getTeamUserGroupsCount(long teamId)
|
static UserGroup |
getUserGroup(long userGroupId)
Returns the user group with the primary key. |
static UserGroup |
getUserGroup(long companyId,
String name)
Returns the user group with the name. |
static List<UserGroup> |
getUserGroups(int start,
int end)
Returns a range of all the user groups. |
static List<UserGroup> |
getUserGroups(long companyId)
Returns all the user groups belonging to the company. |
static List<UserGroup> |
getUserGroups(long[] userGroupIds)
Returns all the user groups with the primary keys. |
static int |
getUserGroupsCount()
Returns the number of user groups. |
static List<UserGroup> |
getUserUserGroups(long userId)
|
static List<UserGroup> |
getUserUserGroups(long userId,
int start,
int end)
|
static List<UserGroup> |
getUserUserGroups(long userId,
int start,
int end,
OrderByComparator orderByComparator)
|
static int |
getUserUserGroupsCount(long userId)
|
static boolean |
hasGroupUserGroup(long groupId,
long userGroupId)
|
static boolean |
hasGroupUserGroups(long groupId)
|
static boolean |
hasTeamUserGroup(long teamId,
long userGroupId)
|
static boolean |
hasTeamUserGroups(long teamId)
|
static boolean |
hasUserUserGroup(long userId,
long userGroupId)
|
static boolean |
hasUserUserGroups(long userId)
|
static List<UserGroup> |
search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
|
static List<UserGroup> |
search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the user groups that match the name and description. |
static int |
searchCount(long companyId,
String keywords,
LinkedHashMap<String,Object> params)
|
static int |
searchCount(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params)
Returns the number of user groups that match the name and description. |
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
static void |
setGroupUserGroups(long groupId,
long[] userGroupIds)
|
void |
setService(UserGroupLocalService service)
Deprecated. |
static void |
setTeamUserGroups(long teamId,
long[] userGroupIds)
|
static void |
setUserUserGroups(long userId,
long[] userGroupIds)
|
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 companyId,
long userGroupId,
String name,
String description)
Updates the user group. |
static UserGroup |
updateUserGroup(UserGroup userGroup)
Updates the user group in the database or adds it if it does not yet exist. |
static UserGroup |
updateUserGroup(UserGroup userGroup,
boolean merge)
Updates the user group in the database or adds it if it does not yet exist. |
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
SystemException
- if a system exception occurredpublic static UserGroup createUserGroup(long userGroupId)
userGroupId
- the primary key for the new user group
public static UserGroup deleteUserGroup(long userGroupId) throws PortalException, SystemException
userGroupId
- the primary key of the user group
PortalException
- if a user group with the primary key could not be found
SystemException
- if a system exception occurredpublic static UserGroup deleteUserGroup(UserGroup userGroup) throws PortalException, SystemException
userGroup
- the user group
PortalException
SystemException
- if a system exception occurredpublic static DynamicQuery dynamicQuery()
public static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
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 querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (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 querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic static UserGroup fetchUserGroup(long userGroupId) throws SystemException
SystemException
public static UserGroup getUserGroup(long userGroupId) throws PortalException, SystemException
userGroupId
- the primary key of the user group
PortalException
- if a user group with the primary key could not be found
SystemException
- if a system exception occurredpublic static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
PortalException
SystemException
public 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 groupsend
- the upper bound of the range of user groups (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
SystemException
- if a system exception occurredpublic static UserGroup updateUserGroup(UserGroup userGroup, boolean merge) throws SystemException
userGroup
- the user groupmerge
- 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 addGroupUserGroup(long groupId, long userGroupId) throws SystemException
SystemException
- if a system exception occurredpublic static void addGroupUserGroup(long groupId, UserGroup userGroup) throws SystemException
SystemException
- if a system exception occurredpublic static void addGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
SystemException
- if a system exception occurredpublic static void addGroupUserGroups(long groupId, List<UserGroup> UserGroups) throws SystemException
SystemException
- if a system exception occurredpublic static void clearGroupUserGroups(long groupId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteGroupUserGroup(long groupId, long userGroupId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteGroupUserGroup(long groupId, UserGroup userGroup) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteGroupUserGroups(long groupId, List<UserGroup> UserGroups) throws SystemException
SystemException
- if a system exception occurredpublic static List<UserGroup> getGroupUserGroups(long groupId) throws SystemException
SystemException
- if a system exception occurredpublic static List<UserGroup> getGroupUserGroups(long groupId, int start, int end) throws SystemException
SystemException
- if a system exception occurredpublic static List<UserGroup> getGroupUserGroups(long groupId, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
- if a system exception occurredpublic static int getGroupUserGroupsCount(long groupId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasGroupUserGroup(long groupId, long userGroupId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasGroupUserGroups(long groupId) throws SystemException
SystemException
- if a system exception occurredpublic static void setGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
SystemException
- if a system exception occurredpublic static void addTeamUserGroup(long teamId, long userGroupId) throws SystemException
SystemException
- if a system exception occurredpublic static void addTeamUserGroup(long teamId, UserGroup userGroup) throws SystemException
SystemException
- if a system exception occurredpublic static void addTeamUserGroups(long teamId, long[] userGroupIds) throws SystemException
SystemException
- if a system exception occurredpublic static void addTeamUserGroups(long teamId, List<UserGroup> UserGroups) throws SystemException
SystemException
- if a system exception occurredpublic static void clearTeamUserGroups(long teamId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteTeamUserGroup(long teamId, long userGroupId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteTeamUserGroup(long teamId, UserGroup userGroup) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteTeamUserGroups(long teamId, long[] userGroupIds) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteTeamUserGroups(long teamId, List<UserGroup> UserGroups) throws SystemException
SystemException
- if a system exception occurredpublic static List<UserGroup> getTeamUserGroups(long teamId) throws SystemException
SystemException
- if a system exception occurredpublic static List<UserGroup> getTeamUserGroups(long teamId, int start, int end) throws SystemException
SystemException
- if a system exception occurredpublic static List<UserGroup> getTeamUserGroups(long teamId, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
- if a system exception occurredpublic static int getTeamUserGroupsCount(long teamId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasTeamUserGroup(long teamId, long userGroupId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasTeamUserGroups(long teamId) throws SystemException
SystemException
- if a system exception occurredpublic static void setTeamUserGroups(long teamId, long[] userGroupIds) throws SystemException
SystemException
- if a system exception occurredpublic static void addUserUserGroup(long userId, long userGroupId) throws SystemException
SystemException
- if a system exception occurredpublic static void addUserUserGroup(long userId, UserGroup userGroup) throws SystemException
SystemException
- if a system exception occurredpublic static void addUserUserGroups(long userId, long[] userGroupIds) throws SystemException
SystemException
- if a system exception occurredpublic static void addUserUserGroups(long userId, List<UserGroup> UserGroups) throws SystemException
SystemException
- if a system exception occurredpublic static void clearUserUserGroups(long userId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteUserUserGroup(long userId, long userGroupId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteUserUserGroup(long userId, UserGroup userGroup) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteUserUserGroups(long userId, long[] userGroupIds) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteUserUserGroups(long userId, List<UserGroup> UserGroups) throws SystemException
SystemException
- if a system exception occurredpublic static List<UserGroup> getUserUserGroups(long userId) throws SystemException
SystemException
- if a system exception occurredpublic static List<UserGroup> getUserUserGroups(long userId, int start, int end) throws SystemException
SystemException
- if a system exception occurredpublic static List<UserGroup> getUserUserGroups(long userId, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
- if a system exception occurredpublic static int getUserUserGroupsCount(long userId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasUserUserGroup(long userId, long userGroupId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasUserUserGroups(long userId) throws SystemException
SystemException
- if a system exception occurredpublic static void setUserUserGroups(long userId, long[] userGroupIds) throws PortalException, SystemException
PortalException
SystemException
- if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic static UserGroup addUserGroup(long userId, long companyId, String name, String description) throws PortalException, SystemException
This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to setup default groups and resources for the user group.
userId
- the primary key of the usercompanyId
- the primary key of the user group's companyname
- the user group's namedescription
- the user group's description
PortalException
- if the user group's information was invalid
SystemException
- if a system exception occurredpublic static void copyUserGroupLayouts(long userGroupId, long userId) throws PortalException, SystemException
userGroupId
- the primary key of the user groupuserId
- the primary key of the user
PortalException
- if a user with the primary key could not be
found or if a portal exception occurred
SystemException
- if a system exception occurredpublic static void copyUserGroupLayouts(long userGroupId, long[] userIds) throws PortalException, SystemException
userGroupId
- the primary key of the user groupuserIds
- the primary keys of the users
PortalException
- if any one of the users could not be found or
if a portal exception occurred
SystemException
- if a system exception occurredpublic static void copyUserGroupLayouts(long[] userGroupIds, long userId) throws PortalException, SystemException
userGroupIds
- the primary keys of the user groupsuserId
- the primary key of the user
PortalException
- if a user with the primary key could not be
found or if a portal exception occurred
SystemException
- if a system exception occurredpublic static UserGroup getUserGroup(long companyId, String name) throws PortalException, SystemException
companyId
- the primary key of the user group's companyname
- the user group's name
PortalException
- if a user group with the name could not be found
SystemException
- if a system exception occurredpublic static List<UserGroup> getUserGroups(long companyId) throws SystemException
companyId
- the primary key of the user groups' company
SystemException
- if a system exception occurredpublic static List<UserGroup> getUserGroups(long[] userGroupIds) throws PortalException, SystemException
userGroupIds
- the primary keys of the user groups
PortalException
- if any one of the user groups could not be found
SystemException
- if a system exception occurredpublic static List<UserGroup> search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc) 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
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 user group's companyname
- the user group's name (optionally null
)description
- the user group's description (optionally
null
)params
- the finder params (optionally null
). For more
information see UserGroupFinder
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)obc
- the comparator to order the user groups (optionally
null
)
obc
SystemException
- if a system exception occurredUserGroupFinder
public static int searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params) throws SystemException
SystemException
public static int searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params) throws SystemException
companyId
- the primary key of the user group's companyname
- the user group's name (optionally null
)description
- the user group's description (optionally
null
)params
- the finder params (optionally null
). For more
information see UserGroupFinder
SystemException
- if a system exception occurredUserGroupFinder
public static void unsetGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups
SystemException
- if a system exception occurredpublic static void unsetTeamUserGroups(long teamId, long[] userGroupIds) throws SystemException
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups
SystemException
- if a system exception occurredpublic static UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description) throws PortalException, SystemException
companyId
- the primary key of the user group's companyuserGroupId
- the primary key of the user groupname
- the user group's namedescription
- the user group's description
PortalException
- if a user group with the primary key could not be
found or if the new information was invalid
SystemException
- if a system exception occurredpublic static UserGroupLocalService getService()
public void setService(UserGroupLocalService service)
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |