|
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.GroupLocalServiceUtil
public class GroupLocalServiceUtil
The utility for the group local service. This utility wraps GroupLocalServiceImpl
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 GroupLocalServiceImpl
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.
GroupLocalService
,
GroupLocalServiceBaseImpl
,
GroupLocalServiceImpl
Constructor Summary | |
---|---|
GroupLocalServiceUtil()
|
Method Summary | |
---|---|
static Group |
addGroup(Group group)
Adds the group to the database. |
static Group |
addGroup(long userId,
String className,
long classPK,
long liveGroupId,
String name,
String description,
int type,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
|
static Group |
addGroup(long userId,
String className,
long classPK,
String name,
String description,
int type,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
|
static void |
addRoleGroups(long roleId,
long[] groupIds)
|
static void |
addUserGroups(long userId,
long[] groupIds)
|
static void |
checkCompanyGroup(long companyId)
|
static void |
checkSystemGroups(long companyId)
|
static Group |
createGroup(long groupId)
Creates a new group with the primary key. |
static void |
deleteGroup(Group group)
Deletes the group from the database. |
static void |
deleteGroup(long groupId)
Deletes the group with the primary key 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 Group |
getCompanyGroup(long companyId)
|
static List<Group> |
getCompanyGroups(long companyId,
int start,
int end)
|
static int |
getCompanyGroupsCount(long companyId)
|
static Group |
getFriendlyURLGroup(long companyId,
String friendlyURL)
|
static Group |
getGroup(long groupId)
Gets the group with the primary key. |
static Group |
getGroup(long companyId,
String name)
|
static List<Group> |
getGroups(int start,
int end)
Gets a range of all the groups. |
static List<Group> |
getGroups(long[] groupIds)
|
static int |
getGroupsCount()
Gets the number of groups. |
static Group |
getLayoutGroup(long companyId,
long plid)
|
static Group |
getLayoutPrototypeGroup(long companyId,
long layoutPrototypeId)
|
static Group |
getLayoutSetPrototypeGroup(long companyId,
long layoutSetPrototypeId)
|
static List<Group> |
getLiveGroups()
|
static List<Group> |
getNoLayoutsGroups(String className,
boolean privateLayout,
int start,
int end)
|
static List<Group> |
getNullFriendlyURLGroups()
|
static Group |
getOrganizationGroup(long companyId,
long organizationId)
|
static List<Group> |
getOrganizationsGroups(List<Organization> organizations)
|
static List<Group> |
getOrganizationsRelatedGroups(List<Organization> organizations)
|
static List<Group> |
getRoleGroups(long roleId)
|
static GroupLocalService |
getService()
|
static Group |
getStagingGroup(long liveGroupId)
|
static Group |
getUserGroup(long companyId,
long userId)
|
static Group |
getUserGroupGroup(long companyId,
long userGroupId)
|
static List<Group> |
getUserGroups(long userId)
|
static List<Group> |
getUserGroups(long userId,
boolean inherit)
|
static List<Group> |
getUserGroups(long userId,
boolean inherit,
int start,
int end)
|
static List<Group> |
getUserGroups(long userId,
int start,
int end)
|
static List<Group> |
getUserGroupsGroups(List<UserGroup> userGroups)
|
static List<Group> |
getUserGroupsRelatedGroups(List<UserGroup> userGroups)
|
static List<Group> |
getUserOrganizationsGroups(long userId,
int start,
int end)
|
static boolean |
hasRoleGroup(long roleId,
long groupId)
|
static boolean |
hasStagingGroup(long liveGroupId)
|
static boolean |
hasUserGroup(long userId,
long groupId)
|
static List<Group> |
search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
int start,
int end)
|
static List<Group> |
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)
|
static void |
setRoleGroups(long roleId,
long[] groupIds)
|
void |
setService(GroupLocalService service)
|
static void |
unsetRoleGroups(long roleId,
long[] groupIds)
|
static void |
unsetUserGroups(long userId,
long[] groupIds)
|
static void |
updateAsset(long userId,
Group group,
long[] assetCategoryIds,
String[] assetTagNames)
|
static Group |
updateFriendlyURL(long groupId,
String friendlyURL)
|
static Group |
updateGroup(Group group)
Updates the group in the database. |
static Group |
updateGroup(Group group,
boolean merge)
Updates the group in the database. |
static Group |
updateGroup(long groupId,
String typeSettings)
|
static Group |
updateGroup(long groupId,
String name,
String description,
int type,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
|
static Group |
updateWorkflow(long groupId,
boolean workflowEnabled,
int workflowStages,
String workflowRoleNames)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GroupLocalServiceUtil()
Method Detail |
---|
public static Group addGroup(Group group) throws SystemException
group
- the group to add
SystemException
- if a system exception occurredpublic static Group createGroup(long groupId)
groupId
- the primary key for the new group
public static void deleteGroup(long groupId) throws PortalException, SystemException
groupId
- the primary key of the group to delete
PortalException
- if a group with the primary key could not be found
SystemException
- if a system exception occurredpublic static void deleteGroup(Group group) throws SystemException
group
- the 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 Group getGroup(long groupId) throws PortalException, SystemException
groupId
- the primary key of the group to get
PortalException
- if a group with the primary key could not be found
SystemException
- if a system exception occurredpublic static List<Group> getGroups(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 groups to returnend
- the upper bound of the range of groups to return (not inclusive)
SystemException
- if a system exception occurredpublic static int getGroupsCount() throws SystemException
SystemException
- if a system exception occurredpublic static Group updateGroup(Group group) throws SystemException
group
- the group to update
SystemException
- if a system exception occurredpublic static Group updateGroup(Group group, boolean merge) throws SystemException
group
- the group to updatemerge
- whether to merge the 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 Group addGroup(long userId, String className, long classPK, String name, String description, int type, String friendlyURL, boolean active, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static Group addGroup(long userId, String className, long classPK, long liveGroupId, String name, String description, int type, String friendlyURL, boolean active, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static void addRoleGroups(long roleId, long[] groupIds) throws SystemException
SystemException
public static void addUserGroups(long userId, long[] groupIds) throws SystemException
SystemException
public static void checkCompanyGroup(long companyId) throws PortalException, SystemException
PortalException
SystemException
public static void checkSystemGroups(long companyId) throws PortalException, SystemException
PortalException
SystemException
public static Group getCompanyGroup(long companyId) throws PortalException, SystemException
PortalException
SystemException
public static List<Group> getCompanyGroups(long companyId, int start, int end) throws SystemException
SystemException
public static int getCompanyGroupsCount(long companyId) throws SystemException
SystemException
public static Group getFriendlyURLGroup(long companyId, String friendlyURL) throws PortalException, SystemException
PortalException
SystemException
public static Group getGroup(long companyId, String name) throws PortalException, SystemException
PortalException
SystemException
public static List<Group> getGroups(long[] groupIds) throws PortalException, SystemException
PortalException
SystemException
public static Group getLayoutGroup(long companyId, long plid) throws PortalException, SystemException
PortalException
SystemException
public static Group getLayoutPrototypeGroup(long companyId, long layoutPrototypeId) throws PortalException, SystemException
PortalException
SystemException
public static Group getLayoutSetPrototypeGroup(long companyId, long layoutSetPrototypeId) throws PortalException, SystemException
PortalException
SystemException
public static List<Group> getLiveGroups() throws SystemException
SystemException
public static List<Group> getNoLayoutsGroups(String className, boolean privateLayout, int start, int end) throws SystemException
SystemException
public static List<Group> getNullFriendlyURLGroups() throws SystemException
SystemException
public static Group getOrganizationGroup(long companyId, long organizationId) throws PortalException, SystemException
PortalException
SystemException
public static List<Group> getOrganizationsGroups(List<Organization> organizations)
public static List<Group> getOrganizationsRelatedGroups(List<Organization> organizations) throws SystemException
SystemException
public static List<Group> getRoleGroups(long roleId) throws SystemException
SystemException
public static Group getStagingGroup(long liveGroupId) throws PortalException, SystemException
PortalException
SystemException
public static Group getUserGroup(long companyId, long userId) throws PortalException, SystemException
PortalException
SystemException
public static Group getUserGroupGroup(long companyId, long userGroupId) throws PortalException, SystemException
PortalException
SystemException
public static List<Group> getUserGroups(long userId) throws PortalException, SystemException
PortalException
SystemException
public static List<Group> getUserGroups(long userId, boolean inherit) throws PortalException, SystemException
PortalException
SystemException
public static List<Group> getUserGroups(long userId, int start, int end) throws PortalException, SystemException
PortalException
SystemException
public static List<Group> getUserGroups(long userId, boolean inherit, int start, int end) throws PortalException, SystemException
PortalException
SystemException
public static List<Group> getUserGroupsGroups(List<UserGroup> userGroups) throws PortalException, SystemException
PortalException
SystemException
public static List<Group> getUserGroupsRelatedGroups(List<UserGroup> userGroups) throws SystemException
SystemException
public static List<Group> getUserOrganizationsGroups(long userId, int start, int end) throws PortalException, SystemException
PortalException
SystemException
public static boolean hasRoleGroup(long roleId, long groupId) throws SystemException
SystemException
public static boolean hasStagingGroup(long liveGroupId) throws SystemException
SystemException
public static boolean hasUserGroup(long userId, long groupId) throws SystemException
SystemException
public static List<Group> search(long companyId, String name, String description, LinkedHashMap<String,Object> params, int start, int end) throws SystemException
SystemException
public static List<Group> 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 setRoleGroups(long roleId, long[] groupIds) throws SystemException
SystemException
public static void unsetRoleGroups(long roleId, long[] groupIds) throws SystemException
SystemException
public static void unsetUserGroups(long userId, long[] groupIds) throws SystemException
SystemException
public static void updateAsset(long userId, Group group, long[] assetCategoryIds, String[] assetTagNames) throws PortalException, SystemException
PortalException
SystemException
public static Group updateFriendlyURL(long groupId, String friendlyURL) throws PortalException, SystemException
PortalException
SystemException
public static Group updateGroup(long groupId, String name, String description, int type, String friendlyURL, boolean active, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static Group updateGroup(long groupId, String typeSettings) throws PortalException, SystemException
PortalException
SystemException
public static Group updateWorkflow(long groupId, boolean workflowEnabled, int workflowStages, String workflowRoleNames) throws PortalException, SystemException
PortalException
SystemException
public static GroupLocalService getService()
public void setService(GroupLocalService service)
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |