GroupLocalServiceUtil (Liferay 6.2-ce-ga5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.2-ce-ga5

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.service
Class GroupLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.GroupLocalServiceUtil

@ProviderType public class GroupLocalServiceUtil
extends Object
extends Object

Provides the local service utility for Group. This utility wraps com.liferay.portal.service.impl.GroupLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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.

See Also:: GroupLocalService, GroupLocalServiceBaseImpl, com.liferay.portal.service.impl.GroupLocalServiceImpl

Constructor Summary
`GroupLocalServiceUtil()`

Method Summary
`static Group`	`addGroup(Group group)` Adds the group to the database.
`static Group`	`addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)` Adds a group.
`static Group`	`addGroup(long userId, long parentGroupId, String className, long classPK, 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, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)`
`static Group`	`addGroup(long userId, String className, long classPK, long liveGroupId, 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, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)`
`static Group`	`addGroup(long userId, String className, long classPK, 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, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)`
`static void`	`addOrganizationGroup(long organizationId, Group group)`
`static void`	`addOrganizationGroup(long organizationId, long groupId)`
`static void`	`addOrganizationGroups(long organizationId, List<Group> Groups)`
`static void`	`addOrganizationGroups(long organizationId, long[] groupIds)`
`static void`	`addRoleGroup(long roleId, Group group)`
`static void`	`addRoleGroup(long roleId, long groupId)`
`static void`	`addRoleGroups(long roleId, List<Group> Groups)`
`static void`	`addRoleGroups(long roleId, long[] groupIds)`
`static void`	`addUserGroup(long userId, Group group)`
`static void`	`addUserGroup(long userId, long groupId)`
`static void`	`addUserGroupGroup(long userGroupId, Group group)`
`static void`	`addUserGroupGroup(long userGroupId, long groupId)`
`static void`	`addUserGroupGroups(long userGroupId, List<Group> Groups)`
`static void`	`addUserGroupGroups(long userGroupId, long[] groupIds)`
`static void`	`addUserGroups(long userId, List<Group> Groups)`
`static void`	`addUserGroups(long userId, long[] groupIds)`
`static void`	`checkCompanyGroup(long companyId)` Adds a company group if it does not exist.
`static void`	`checkSystemGroups(long companyId)` Creates systems groups and other related data needed by the system on the very first startup.
`static void`	`clearOrganizationGroups(long organizationId)`
`static void`	`clearRoleGroups(long roleId)`
`static void`	`clearUserGroupGroups(long userGroupId)`
`static void`	`clearUserGroups(long userId)`
`static Group`	`createGroup(long groupId)` Creates a new group with the primary key.
`static Group`	`deleteGroup(Group group)` Deletes the group from the database.
`static Group`	`deleteGroup(long groupId)` Deletes the group with the primary key from the database.
`static void`	`deleteOrganizationGroup(long organizationId, Group group)`
`static void`	`deleteOrganizationGroup(long organizationId, long groupId)`
`static void`	`deleteOrganizationGroups(long organizationId, List<Group> Groups)`
`static void`	`deleteOrganizationGroups(long organizationId, long[] groupIds)`
`static void`	`deleteRoleGroup(long roleId, Group group)`
`static void`	`deleteRoleGroup(long roleId, long groupId)`
`static void`	`deleteRoleGroups(long roleId, List<Group> Groups)`
`static void`	`deleteRoleGroups(long roleId, long[] groupIds)`
`static void`	`deleteUserGroup(long userId, Group group)`
`static void`	`deleteUserGroup(long userId, long groupId)`
`static void`	`deleteUserGroupGroup(long userGroupId, Group group)`
`static void`	`deleteUserGroupGroup(long userGroupId, long groupId)`
`static void`	`deleteUserGroupGroups(long userGroupId, List<Group> Groups)`
`static void`	`deleteUserGroupGroups(long userGroupId, long[] groupIds)`
`static void`	`deleteUserGroups(long userId, List<Group> Groups)`
`static void`	`deleteUserGroups(long userId, long[] groupIds)`
`static void`	`disableStaging(long groupId)`
`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 long`	`dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)` Returns the number of rows that match the dynamic query.
`static void`	`enableStaging(long groupId)`
`static Group`	`fetchFriendlyURLGroup(long companyId, String friendlyURL)` Returns the group with the matching friendly URL.
`static Group`	`fetchGroup(long groupId)`
`static Group`	`fetchGroup(long companyId, String name)` Returns the group with the matching group name by first searching the system groups and then using the finder cache.
`static Group`	`fetchGroupByUuidAndCompanyId(String uuid, long companyId)` Returns the group with the matching UUID and company.
`static String`	`getBeanIdentifier()` Returns the Spring bean ID for this bean.
`static Group`	`getCompanyGroup(long companyId)` Returns the company group.
`static List<Group>`	`getCompanyGroups(long companyId, int start, int end)` Returns a range of all the groups associated with the company.
`static int`	`getCompanyGroupsCount(long companyId)` Returns the number of groups associated with the company.
`static Group`	`getFriendlyURLGroup(long companyId, String friendlyURL)` Returns the group with the matching friendly URL.
`static Group`	`getGroup(long groupId)` Returns the group with the primary key.
`static Group`	`getGroup(long companyId, String name)` Returns the group with the matching group name.
`static Group`	`getGroupByUuidAndCompanyId(String uuid, long companyId)` Returns the group with the matching UUID and company.
`static String`	`getGroupDescriptiveName(Group group, Locale locale)`
`static String`	`getGroupDescriptiveName(long groupId, Locale locale)`
`static List<Group>`	`getGroups(int start, int end)` Returns a range of all the groups.
`static List<Group>`	`getGroups(long[] groupIds)` Returns the groups with the matching primary keys.
`static List<Group>`	`getGroups(long companyId, long parentGroupId, boolean site)` Returns all the groups that are direct children of the parent group.
`static List<Group>`	`getGroups(long companyId, String className, long parentGroupId)` Returns all the groups that are direct children of the parent group with the matching className.
`static List<Group>`	`getGroups(long companyId, String className, long parentGroupId, int start, int end)` Returns a range of all the groups that are direct children of the parent group with the matching className.
`static int`	`getGroupsCount()` Returns the number of groups.
`static int`	`getGroupsCount(long companyId, long parentGroupId, boolean site)` Returns the number of groups that are direct children of the parent group.
`static int`	`getGroupsCount(long companyId, String className, long parentGroupId)` Returns the number of groups that are direct children of the parent group with the matching className.
`static Group`	`getLayoutGroup(long companyId, long plid)` Returns the group associated with the layout.
`static Group`	`getLayoutPrototypeGroup(long companyId, long layoutPrototypeId)` Returns the group associated with the layout prototype.
`static Group`	`getLayoutSetPrototypeGroup(long companyId, long layoutSetPrototypeId)` Returns the group associated with the layout set prototype.
`static List<Group>`	`getLayoutsGroups(long companyId, long parentGroupId, boolean site, int start, int end)` Deprecated. As of 6.2.0, replaced by `getLayoutsGroups(long, long, boolean, int, int, OrderByComparator)`
`static List<Group>`	`getLayoutsGroups(long companyId, long parentGroupId, boolean site, int start, int end, OrderByComparator obc)` Returns a range of all groups that are children of the parent group and that have at least one layout.
`static int`	`getLayoutsGroupsCount(long companyId, long parentGroupId, boolean site)` Returns the number of groups that are children or the parent group and that have at least one layout
`static List<Group>`	`getLiveGroups()` Returns all live groups.
`static List<Group>`	`getNoLayoutsGroups(String className, boolean privateLayout, int start, int end)` Returns a range of all non-system groups of a specified type (className) that have no layouts.
`static List<Group>`	`getNullFriendlyURLGroups()` Returns all non-system groups having `null` or empty friendly URLs.
`static Group`	`getOrganizationGroup(long companyId, long organizationId)` Returns the specified organization group.
`static List<Group>`	`getOrganizationGroups(long organizationId)`
`static List<Group>`	`getOrganizationGroups(long organizationId, int start, int end)`
`static List<Group>`	`getOrganizationGroups(long organizationId, int start, int end, OrderByComparator orderByComparator)`
`static int`	`getOrganizationGroupsCount(long organizationId)`
`static List<Group>`	`getOrganizationsGroups(List<Organization> organizations)` Returns the specified organization groups.
`static List<Group>`	`getOrganizationsRelatedGroups(List<Organization> organizations)` Returns all the groups related to the organizations.
`static List<Group>`	`getParentGroups(long groupId)` Returns the group followed by all its parent groups ordered by closest ancestor.
`static PersistedModel`	`getPersistedModel(Serializable primaryKeyObj)`
`static List<Group>`	`getRoleGroups(long roleId)`
`static List<Group>`	`getRoleGroups(long roleId, int start, int end)`
`static List<Group>`	`getRoleGroups(long roleId, int start, int end, OrderByComparator orderByComparator)`
`static int`	`getRoleGroupsCount(long roleId)`
`static GroupLocalService`	`getService()`
`static Group`	`getStagingGroup(long liveGroupId)` Returns the staging group.
`static Group`	`getUserGroup(long companyId, long userId)` Returns the group associated with the user.
`static Group`	`getUserGroupGroup(long companyId, long userGroupId)` Returns the specified "user group" group.
`static List<Group>`	`getUserGroupGroups(long userGroupId)`
`static List<Group>`	`getUserGroupGroups(long userGroupId, int start, int end)`
`static List<Group>`	`getUserGroupGroups(long userGroupId, int start, int end, OrderByComparator orderByComparator)`
`static int`	`getUserGroupGroupsCount(long userGroupId)`
`static List<Group>`	`getUserGroups(long userId)`
`static List<Group>`	`getUserGroups(long userId, boolean inherit)` Returns all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`getUserGroups(long userId, boolean inherit, int start, int end)` Returns an ordered range of all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`getUserGroups(long userId, int start, int end)`
`static List<Group>`	`getUserGroups(long userId, int start, int end, OrderByComparator orderByComparator)`
`static int`	`getUserGroupsCount(long userId)`
`static List<Group>`	`getUserGroupsGroups(List<UserGroup> userGroups)` Returns the groups associated with the user groups.
`static List<Group>`	`getUserGroupsRelatedGroups(List<UserGroup> userGroups)` Returns all the groups related to the user groups.
`static 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`.
`static Group`	`getUserPersonalSiteGroup(long companyId)`
`static List<Group>`	`getUserSitesGroups(long userId)`
`static List<Group>`	`getUserSitesGroups(long userId, boolean includeAdministrative)`
`static boolean`	`hasOrganizationGroup(long organizationId, long groupId)`
`static boolean`	`hasOrganizationGroups(long organizationId)`
`static boolean`	`hasRoleGroup(long roleId, long groupId)`
`static boolean`	`hasRoleGroups(long roleId)`
`static boolean`	`hasStagingGroup(long liveGroupId)` Returns `true` if the live group has a staging group.
`static boolean`	`hasUserGroup(long userId, long groupId)`
`static boolean`	`hasUserGroup(long userId, long groupId, boolean inherit)` Returns `true` if the user is immediately associated with the group, or optionally if the user is associated with the group via the user's organizations, inherited organizations, or user groups.
`static boolean`	`hasUserGroupGroup(long userGroupId, long groupId)`
`static boolean`	`hasUserGroupGroups(long userGroupId)`
`static boolean`	`hasUserGroups(long userId)`
`static Group`	`loadFetchGroup(long companyId, String name)` Returns the group with the matching group name by first searching the system groups and then using the finder cache.
`static Group`	`loadGetGroup(long companyId, String name)` Returns the group with the matching group name.
`static void`	`rebuildTree(long companyId)` Rebuilds the group tree.
`static List<Group>`	`search(long companyId, LinkedHashMap<String,Object> params, int start, int end)` Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end)` Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end)` Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end)` Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator obc)` Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end)` Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)` Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`static List<Group>`	`search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, 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.
`static List<Group>`	`search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator obc)` 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.
`static int`	`searchCount(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,Object> params)` Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)` Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params)` Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)` Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,Object> params)` Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)` Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params)` Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups.
`static int`	`searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)` Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
`static void`	`setBeanIdentifier(String beanIdentifier)` Sets the Spring bean ID for this bean.
`static void`	`setOrganizationGroups(long organizationId, long[] groupIds)`
`static void`	`setRoleGroups(long roleId, long[] groupIds)`
`void`	`setService(GroupLocalService service)` Deprecated. As of 6.2.0
`static void`	`setUserGroupGroups(long userGroupId, long[] groupIds)`
`static void`	`setUserGroups(long userId, long[] groupIds)`
`static void`	`unsetRoleGroups(long roleId, long[] groupIds)` Removes the groups from the role.
`static void`	`unsetUserGroups(long userId, long[] groupIds)` Removes the user from the groups.
`static void`	`updateAsset(long userId, Group group, long[] assetCategoryIds, String[] assetTagNames)` Updates the group's asset replacing categories and tag names.
`static Group`	`updateFriendlyURL(long groupId, String friendlyURL)` Updates the group's friendly URL.
`static Group`	`updateGroup(Group group)` Updates the group in the database or adds it if it does not yet exist.
`static 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.
`static Group`	`updateGroup(long groupId, String typeSettings)` Updates the group's type settings.
`static Group`	`updateSite(long groupId, boolean site)` Associates the group with a main site if the group is an organization.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

GroupLocalServiceUtil

public GroupLocalServiceUtil()

Method Detail

addGroup

public static Group addGroup(Group group)
                      throws SystemException

Adds the group to the database. Also notifies the appropriate model listeners.

Parameters:: group - the group
Returns:: the group that was added
Throws:: SystemException - if a system exception occurred

createGroup

public static Group createGroup(long groupId)

Creates a new group with the primary key. Does not add the group to the database.

Parameters:: groupId - the primary key for the new group
Returns:: the new group

deleteGroup

public static Group deleteGroup(long groupId)
                         throws PortalException,
                                SystemException

Deletes the group with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:: groupId - the primary key of the group
Returns:: the group that was removed
Throws:: PortalException - if a group with the primary key could not be found; SystemException - if a system exception occurred

deleteGroup

public static Group deleteGroup(Group group)
                         throws PortalException,
                                SystemException

Deletes the group from the database. Also notifies the appropriate model listeners.

Parameters:: group - the group
Returns:: the group that was removed
Throws:: PortalException; SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:: dynamicQuery - the dynamic query
Returns:: the matching rows
Throws:: SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from GroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:: dynamicQuery - the dynamic query; start - the lower bound of the range of model instances; end - the upper bound of the range of model instances (not inclusive)
Returns:: the range of matching rows
Throws:: SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Parameters:: dynamicQuery - the dynamic query; start - the lower bound of the range of model instances; end - the upper bound of the range of model instances (not inclusive); orderByComparator - the comparator to order the results by (optionally null)
Returns:: the ordered range of matching rows
Throws:: SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:: dynamicQuery - the dynamic query
Returns:: the number of rows that match the dynamic query
Throws:: SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:: dynamicQuery - the dynamic query; projection - the projection to apply to the query
Returns:: the number of rows that match the dynamic query
Throws:: SystemException - if a system exception occurred

fetchGroup

public static Group fetchGroup(long groupId)
                        throws SystemException

Throws:: SystemException

fetchGroupByUuidAndCompanyId

public static Group fetchGroupByUuidAndCompanyId(String uuid,
                                                 long companyId)
                                          throws SystemException

Returns the group with the matching UUID and company.

Parameters:: uuid - the group's UUID; companyId - the primary key of the company
Returns:: the matching group, or null if a matching group could not be found
Throws:: SystemException - if a system exception occurred

getGroup

public static Group getGroup(long groupId)
                      throws PortalException,
                             SystemException

Returns the group with the primary key.

Parameters:: groupId - the primary key of the group
Returns:: the group
Throws:: PortalException - if a group with the primary key could not be found; SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:: PortalException; SystemException

getGroupByUuidAndCompanyId

public static Group getGroupByUuidAndCompanyId(String uuid,
                                               long companyId)
                                        throws PortalException,
                                               SystemException

Returns the group with the matching UUID and company.

Parameters:: uuid - the group's UUID; companyId - the primary key of the company
Returns:: the matching group
Throws:: PortalException - if a matching group could not be found; SystemException - if a system exception occurred

getGroups

public static List<Group> getGroups(int start,
                                    int end)
                             throws SystemException

Returns a range of all the groups.

Parameters:: start - the lower bound of the range of groups; end - the upper bound of the range of groups (not inclusive)
Returns:: the range of groups
Throws:: SystemException - if a system exception occurred

getGroupsCount

public static int getGroupsCount()
                          throws SystemException

Returns the number of groups.

Returns:: the number of groups
Throws:: SystemException - if a system exception occurred

updateGroup

public static Group updateGroup(Group group)
                         throws SystemException

Updates the group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:: group - the group
Returns:: the group that was updated
Throws:: SystemException - if a system exception occurred

addOrganizationGroup

public static void addOrganizationGroup(long organizationId,
                                        long groupId)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

addOrganizationGroup

public static void addOrganizationGroup(long organizationId,
                                        Group group)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

addOrganizationGroups

public static void addOrganizationGroups(long organizationId,
                                         long[] groupIds)
                                  throws SystemException

Throws:: SystemException - if a system exception occurred

addOrganizationGroups

public static void addOrganizationGroups(long organizationId,
                                         List<Group> Groups)
                                  throws SystemException

Throws:: SystemException - if a system exception occurred

clearOrganizationGroups

public static void clearOrganizationGroups(long organizationId)
                                    throws SystemException

Throws:: SystemException - if a system exception occurred

deleteOrganizationGroup

public static void deleteOrganizationGroup(long organizationId,
                                           long groupId)
                                    throws SystemException

Throws:: SystemException - if a system exception occurred

deleteOrganizationGroup

public static void deleteOrganizationGroup(long organizationId,
                                           Group group)
                                    throws SystemException

Throws:: SystemException - if a system exception occurred

deleteOrganizationGroups

public static void deleteOrganizationGroups(long organizationId,
                                            long[] groupIds)
                                     throws SystemException

Throws:: SystemException - if a system exception occurred

deleteOrganizationGroups

public static void deleteOrganizationGroups(long organizationId,
                                            List<Group> Groups)
                                     throws SystemException

Throws:: SystemException - if a system exception occurred

getOrganizationGroups

public static List<Group> getOrganizationGroups(long organizationId)
                                         throws SystemException

Throws:: SystemException - if a system exception occurred

getOrganizationGroups

public static List<Group> getOrganizationGroups(long organizationId,
                                                int start,
                                                int end)
                                         throws SystemException

Throws:: SystemException - if a system exception occurred

getOrganizationGroups

public static List<Group> getOrganizationGroups(long organizationId,
                                                int start,
                                                int end,
                                                OrderByComparator orderByComparator)
                                         throws SystemException

Throws:: SystemException - if a system exception occurred

getOrganizationGroupsCount

public static int getOrganizationGroupsCount(long organizationId)
                                      throws SystemException

Throws:: SystemException - if a system exception occurred

hasOrganizationGroup

public static boolean hasOrganizationGroup(long organizationId,
                                           long groupId)
                                    throws SystemException

Throws:: SystemException - if a system exception occurred

hasOrganizationGroups

public static boolean hasOrganizationGroups(long organizationId)
                                     throws SystemException

Throws:: SystemException - if a system exception occurred

setOrganizationGroups

public static void setOrganizationGroups(long organizationId,
                                         long[] groupIds)
                                  throws SystemException

Throws:: SystemException - if a system exception occurred

addRoleGroup

public static void addRoleGroup(long roleId,
                                long groupId)
                         throws SystemException

Throws:: SystemException - if a system exception occurred

addRoleGroup

public static void addRoleGroup(long roleId,
                                Group group)
                         throws SystemException

Throws:: SystemException - if a system exception occurred

addRoleGroups

public static void addRoleGroups(long roleId,
                                 long[] groupIds)
                          throws SystemException

Throws:: SystemException - if a system exception occurred

addRoleGroups

public static void addRoleGroups(long roleId,
                                 List<Group> Groups)
                          throws SystemException

Throws:: SystemException - if a system exception occurred

clearRoleGroups

public static void clearRoleGroups(long roleId)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

deleteRoleGroup

public static void deleteRoleGroup(long roleId,
                                   long groupId)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

deleteRoleGroup

public static void deleteRoleGroup(long roleId,
                                   Group group)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

deleteRoleGroups

public static void deleteRoleGroups(long roleId,
                                    long[] groupIds)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

deleteRoleGroups

public static void deleteRoleGroups(long roleId,
                                    List<Group> Groups)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

getRoleGroups

public static List<Group> getRoleGroups(long roleId)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

getRoleGroups

public static List<Group> getRoleGroups(long roleId,
                                        int start,
                                        int end)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

getRoleGroups

public static List<Group> getRoleGroups(long roleId,
                                        int start,
                                        int end,
                                        OrderByComparator orderByComparator)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

getRoleGroupsCount

public static int getRoleGroupsCount(long roleId)
                              throws SystemException

Throws:: SystemException - if a system exception occurred

hasRoleGroup

public static boolean hasRoleGroup(long roleId,
                                   long groupId)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

hasRoleGroups

public static boolean hasRoleGroups(long roleId)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

setRoleGroups

public static void setRoleGroups(long roleId,
                                 long[] groupIds)
                          throws SystemException

Throws:: SystemException - if a system exception occurred

addUserGroupGroup

public static void addUserGroupGroup(long userGroupId,
                                     long groupId)
                              throws SystemException

Throws:: SystemException - if a system exception occurred

addUserGroupGroup

public static void addUserGroupGroup(long userGroupId,
                                     Group group)
                              throws SystemException

Throws:: SystemException - if a system exception occurred

addUserGroupGroups

public static void addUserGroupGroups(long userGroupId,
                                      long[] groupIds)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

addUserGroupGroups

public static void addUserGroupGroups(long userGroupId,
                                      List<Group> Groups)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

clearUserGroupGroups

public static void clearUserGroupGroups(long userGroupId)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

deleteUserGroupGroup

public static void deleteUserGroupGroup(long userGroupId,
                                        long groupId)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

deleteUserGroupGroup

public static void deleteUserGroupGroup(long userGroupId,
                                        Group group)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

deleteUserGroupGroups

public static void deleteUserGroupGroups(long userGroupId,
                                         long[] groupIds)
                                  throws SystemException

Throws:: SystemException - if a system exception occurred

deleteUserGroupGroups

public static void deleteUserGroupGroups(long userGroupId,
                                         List<Group> Groups)
                                  throws SystemException

Throws:: SystemException - if a system exception occurred

getUserGroupGroups

public static List<Group> getUserGroupGroups(long userGroupId)
                                      throws SystemException

Throws:: SystemException - if a system exception occurred

getUserGroupGroups

public static List<Group> getUserGroupGroups(long userGroupId,
                                             int start,
                                             int end)
                                      throws SystemException

Throws:: SystemException - if a system exception occurred

getUserGroupGroups

public static List<Group> getUserGroupGroups(long userGroupId,
                                             int start,
                                             int end,
                                             OrderByComparator orderByComparator)
                                      throws SystemException

Throws:: SystemException - if a system exception occurred

getUserGroupGroupsCount

public static int getUserGroupGroupsCount(long userGroupId)
                                   throws SystemException

Throws:: SystemException - if a system exception occurred

hasUserGroupGroup

public static boolean hasUserGroupGroup(long userGroupId,
                                        long groupId)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

hasUserGroupGroups

public static boolean hasUserGroupGroups(long userGroupId)
                                  throws SystemException

Throws:: SystemException - if a system exception occurred

setUserGroupGroups

public static void setUserGroupGroups(long userGroupId,
                                      long[] groupIds)
                               throws SystemException

Throws:: SystemException - if a system exception occurred

addUserGroup

public static void addUserGroup(long userId,
                                long groupId)
                         throws SystemException

Throws:: SystemException - if a system exception occurred

addUserGroup

public static void addUserGroup(long userId,
                                Group group)
                         throws SystemException

Throws:: SystemException - if a system exception occurred

addUserGroups

public static void addUserGroups(long userId,
                                 long[] groupIds)
                          throws SystemException

Throws:: SystemException - if a system exception occurred

addUserGroups

public static void addUserGroups(long userId,
                                 List<Group> Groups)
                          throws SystemException

Throws:: SystemException - if a system exception occurred

clearUserGroups

public static void clearUserGroups(long userId)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

deleteUserGroup

public static void deleteUserGroup(long userId,
                                   long groupId)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

deleteUserGroup

public static void deleteUserGroup(long userId,
                                   Group group)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

deleteUserGroups

public static void deleteUserGroups(long userId,
                                    long[] groupIds)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

deleteUserGroups

public static void deleteUserGroups(long userId,
                                    List<Group> Groups)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

getUserGroups

public static List<Group> getUserGroups(long userId)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

getUserGroups

public static List<Group> getUserGroups(long userId,
                                        int start,
                                        int end)
                                 throws SystemException

Throws:: SystemException - if a system exception occurred

getUserGroups

public static List<Group> getUserGroups(long userId,
                                        int start,
                                        int end,
                                        OrderByComparator orderByComparator)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException - if a system exception occurred

getUserGroupsCount

public static int getUserGroupsCount(long userId)
                              throws SystemException

Throws:: SystemException - if a system exception occurred

hasUserGroup

public static boolean hasUserGroup(long userId,
                                   long groupId)
                            throws SystemException

Throws:: SystemException - if a system exception occurred

hasUserGroups

public static boolean hasUserGroups(long userId)
                             throws SystemException

Throws:: SystemException - if a system exception occurred

setUserGroups

public static void setUserGroups(long userId,
                                 long[] groupIds)
                          throws SystemException

Throws:: SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:: the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:: beanIdentifier - the Spring bean ID for this bean

addGroup

public static Group addGroup(long userId,
                             long parentGroupId,
                             String className,
                             long classPK,
                             long liveGroupId,
                             String name,
                             String description,
                             int type,
                             boolean manualMembership,
                             int membershipRestriction,
                             String friendlyURL,
                             boolean site,
                             boolean active,
                             ServiceContext serviceContext)
                      throws PortalException,
                             SystemException

Adds a group.

Parameters:: userId - the primary key of the group's creator/owner; parentGroupId - the primary key of the parent group; className - the entity's class name; classPK - the primary key of the entity's instance; liveGroupId - the primary key of the live group; name - the entity's name; description - 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 site; active - whether the group is active; serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and whether the group is for staging.
Returns:: the group
Throws:: PortalException - 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 occurred

addGroup

public static Group addGroup(long userId,
                             long parentGroupId,
                             String className,
                             long classPK,
                             String name,
                             String description,
                             int type,
                             String friendlyURL,
                             boolean site,
                             boolean active,
                             ServiceContext serviceContext)
                      throws PortalException,
                             SystemException

Deprecated. As of 6.2.0, replaced by addGroup(long, long, String, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)

Adds the group using the default live group.

Parameters:: userId - the primary key of the group's creator/owner; parentGroupId - the primary key of the parent group; className - the entity's class name; classPK - the primary key of the entity's instance; name - the entity's name; description - the group's description (optionally null); type - the group's type. For more information see GroupConstants; friendlyURL - the group's friendlyURL; site - whether the group is to be associated with a main site; active - whether the group is active; serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and whether the group is for staging.
Returns:: the group
Throws:: PortalException - 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 occurred

addGroup

public static Group addGroup(long userId,
                             String className,
                             long classPK,
                             long liveGroupId,
                             String name,
                             String description,
                             int type,
                             String friendlyURL,
                             boolean site,
                             boolean active,
                             ServiceContext serviceContext)
                      throws PortalException,
                             SystemException

Deprecated. As of 6.2.0, replaced by addGroup(long, long, String, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)

Adds a group.

Parameters:: userId - the primary key of the group's creator/owner; className - the entity's class name; classPK - the primary key of the entity's instance; liveGroupId - the primary key of the live group; name - the entity's name; description - 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 site; active - whether the group is active; serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and whether the group is for staging.
Returns:: the group
Throws:: PortalException - 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 occurred

addGroup

public static Group addGroup(long userId,
                             String className,
                             long classPK,
                             String name,
                             String description,
                             int type,
                             String friendlyURL,
                             boolean site,
                             boolean active,
                             ServiceContext serviceContext)
                      throws PortalException,
                             SystemException

Deprecated. As of 6.2.0, replaced by addGroup(long, long, String, long, long, String, String, int, boolean, int, String, boolean, boolean, ServiceContext)

Adds the group using the default live group.

Parameters:: userId - the primary key of the group's creator/owner; className - the entity's class name; classPK - the primary key of the entity's instance; name - the entity's name; description - the group's description (optionally null); type - the group's type. For more information see GroupConstants; friendlyURL - the group's friendlyURL; site - whether the group is to be associated with a main site; active - whether the group is active; serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and whether the group is for staging.
Returns:: the group
Throws:: PortalException - 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 occurred

checkCompanyGroup

public static void checkCompanyGroup(long companyId)
                              throws PortalException,
                                     SystemException

Adds a company group if it does not exist. This method is typically used when a virtual host is added.

Parameters:: companyId - the primary key of the company
Throws:: PortalException - if a default user for the company 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 occurred

checkSystemGroups

public static void checkSystemGroups(long companyId)
                              throws PortalException,
                                     SystemException

Creates systems groups and other related data needed by the system on the very first startup. Also takes care of creating the Control Panel groups and layouts.

Parameters:: companyId - the primary key of the company
Throws:: PortalException - if a new system group could not be created; SystemException - if a system exception occurred

disableStaging

public static void disableStaging(long groupId)
                           throws PortalException,
                                  SystemException

Throws:: PortalException; SystemException

enableStaging

public static void enableStaging(long groupId)
                          throws PortalException,
                                 SystemException

Throws:: PortalException; SystemException

fetchFriendlyURLGroup

public static Group fetchFriendlyURLGroup(long companyId,
                                          String friendlyURL)
                                   throws SystemException

Returns the group with the matching friendly URL.

Parameters:: companyId - the primary key of the company; friendlyURL - the friendly URL
Returns:: the group with the friendly URL, or null if a matching group could not be found
Throws:: SystemException - if a system exception occurred

fetchGroup

public static Group fetchGroup(long companyId,
                               String name)
                        throws SystemException

Returns the group with the matching group name by first searching the system groups and then using the finder cache.

Parameters:: companyId - the primary key of the company; name - the group's name
Returns:: the group with the name and associated company, or null if a matching group could not be found
Throws:: SystemException - if a system exception occurred

getCompanyGroup

public static Group getCompanyGroup(long companyId)
                             throws PortalException,
                                    SystemException

Returns the company group.

Parameters:: companyId - the primary key of the company
Returns:: the group associated with the company
Throws:: PortalException - if a matching group could not be found; SystemException - if a system exception occurred

getCompanyGroups

public static List<Group> getCompanyGroups(long companyId,
                                           int start,
                                           int end)
                                    throws SystemException

Returns a range of all the groups associated with the company.

Parameters:: companyId - the primary key of the company; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the range of groups associated with the company
Throws:: SystemException - if a system exception occurred

getCompanyGroupsCount

public static int getCompanyGroupsCount(long companyId)
                                 throws SystemException

Returns the number of groups associated with the company.

Parameters:: companyId - the primary key of the company
Returns:: the number of groups associated with the company
Throws:: SystemException - if a system exception occurred

getFriendlyURLGroup

public static Group getFriendlyURLGroup(long companyId,
                                        String friendlyURL)
                                 throws PortalException,
                                        SystemException

Returns the group with the matching friendly URL.

Parameters:: companyId - the primary key of the company; friendlyURL - the group's friendlyURL
Returns:: the group with the friendly URL
Throws:: PortalException - if a matching group could not be found, or if the friendly URL was invalid; SystemException - if a system exception occurred

getGroup

public static Group getGroup(long companyId,
                             String name)
                      throws PortalException,
                             SystemException

Returns the group with the matching group name.

Parameters:: companyId - the primary key of the company; name - the group's name
Returns:: the group with the name
Throws:: PortalException - if a matching group could not be found; SystemException - if a system exception occurred

getGroupDescriptiveName

public static String getGroupDescriptiveName(Group group,
                                             Locale locale)
                                      throws PortalException,
                                             SystemException

Throws:: PortalException; SystemException

getGroupDescriptiveName

public static String getGroupDescriptiveName(long groupId,
                                             Locale locale)
                                      throws PortalException,
                                             SystemException

Throws:: PortalException; SystemException

getGroups

public static List<Group> getGroups(long companyId,
                                    long parentGroupId,
                                    boolean site)
                             throws SystemException

Returns all the groups that are direct children of the parent group.

Parameters:: companyId - the primary key of the company; parentGroupId - the primary key of the parent group; site - whether the group is to be associated with a main site
Returns:: the matching groups, or null if no matches were found
Throws:: SystemException - if a system exception occurred

getGroups

public static List<Group> getGroups(long companyId,
                                    String className,
                                    long parentGroupId)
                             throws SystemException

Returns all the groups that are direct children of the parent group with the matching className.

Parameters:: companyId - the primary key of the company; className - the class name of the group; parentGroupId - the primary key of the parent group
Returns:: the matching groups, or null if no matches were found
Throws:: SystemException - if a system exception occurred

getGroups

public static List<Group> getGroups(long companyId,
                                    String className,
                                    long parentGroupId,
                                    int start,
                                    int end)
                             throws SystemException

Returns a range of all the groups that are direct children of the parent group with the matching className.

Parameters:: companyId - the primary key of the company; className - the class name of the group; parentGroupId - the primary key of the parent group; start - the lower bound of the range of results; end - the upper bound of the range of results (not inclusive)
Returns:: the range of matching groups
Throws:: SystemException - if a system exception occurred

getGroups

public static List<Group> getGroups(long[] groupIds)
                             throws PortalException,
                                    SystemException

Returns the groups with the matching primary keys.

Parameters:: groupIds - the primary keys of the groups
Returns:: the groups with the primary keys
Throws:: PortalException - if any one of the groups could not be found; SystemException - if a system exception occurred

getGroupsCount

public static int getGroupsCount(long companyId,
                                 long parentGroupId,
                                 boolean site)
                          throws SystemException

Returns the number of groups that are direct children of the parent group.

Parameters:: companyId - the primary key of the company; parentGroupId - the primary key of the parent group; site - whether the group is to be associated with a main site
Returns:: the number of matching groups
Throws:: SystemException - if a system exception occurred

getGroupsCount

public static int getGroupsCount(long companyId,
                                 String className,
                                 long parentGroupId)
                          throws SystemException

Returns the number of groups that are direct children of the parent group with the matching className.

Parameters:: companyId - the primary key of the company; className - the class name of the group; parentGroupId - the primary key of the parent group
Returns:: the number of matching groups
Throws:: SystemException - if a system exception occurred

getLayoutGroup

public static Group getLayoutGroup(long companyId,
                                   long plid)
                            throws PortalException,
                                   SystemException

Returns the group associated with the layout.

Parameters:: companyId - the primary key of the company; plid - the primary key of the layout
Returns:: the group associated with the layout
Throws:: PortalException - if a matching group could not be found; SystemException - if a system exception occurred

getLayoutPrototypeGroup

public static Group getLayoutPrototypeGroup(long companyId,
                                            long layoutPrototypeId)
                                     throws PortalException,
                                            SystemException

Returns the group associated with the layout prototype.

Parameters:: companyId - the primary key of the company; layoutPrototypeId - the primary key of the layout prototype
Returns:: the group associated with the layout prototype
Throws:: PortalException - if a matching group could not be found; SystemException - if a system exception occurred

getLayoutSetPrototypeGroup

public static Group getLayoutSetPrototypeGroup(long companyId,
                                               long layoutSetPrototypeId)
                                        throws PortalException,
                                               SystemException

Returns the group associated with the layout set prototype.

Parameters:: companyId - the primary key of the company; layoutSetPrototypeId - the primary key of the layout set prototype
Returns:: the group associated with the layout set prototype
Throws:: PortalException - if a matching group could not be found; SystemException - if a system exception occurred

getLayoutsGroups

public static List<Group> getLayoutsGroups(long companyId,
                                           long parentGroupId,
                                           boolean site,
                                           int start,
                                           int end)
                                    throws SystemException

Deprecated. As of 6.2.0, replaced by getLayoutsGroups(long, long, boolean, int, int, OrderByComparator)

Returns a range of all groups that are children of the parent group and that have at least one layout.

Parameters:: companyId - the primary key of the company; parentGroupId - the primary key of the parent group; site - whether the group is to be associated with a main site; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the range of matching groups
Throws:: SystemException - if a system exception occurred

getLayoutsGroups

public static List<Group> getLayoutsGroups(long companyId,
                                           long parentGroupId,
                                           boolean site,
                                           int start,
                                           int end,
                                           OrderByComparator obc)
                                    throws SystemException

Returns a range of all groups that are children of the parent group and that have at least one layout.

Parameters:: companyId - the primary key of the company; parentGroupId - the primary key of the parent group; site - whether the group is to be associated with a main site; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive); obc - the comparator to order the groups (optionally null)
Returns:: the range of matching groups ordered by comparator obc
Throws:: SystemException - if a system exception occurred

getLayoutsGroupsCount

public static int getLayoutsGroupsCount(long companyId,
                                        long parentGroupId,
                                        boolean site)
                                 throws SystemException

Returns the number of groups that are children or the parent group and that have at least one layout

Parameters:: companyId - the primary key of the company; parentGroupId - the primary key of the parent group; site - whether the group is to be associated with a main site
Returns:: the number of matching groups
Throws:: SystemException - if a system exception occurred

getLiveGroups

public static List<Group> getLiveGroups()
                                 throws SystemException

Returns all live groups.

Returns:: all live groups
Throws:: SystemException - if a system exception occurred

getNoLayoutsGroups

public static List<Group> getNoLayoutsGroups(String className,
                                             boolean privateLayout,
                                             int start,
                                             int end)
                                      throws SystemException

Returns a range of all non-system groups of a specified type (className) that have no layouts.

Parameters:: className - the entity's class name; privateLayout - whether to include groups with private layout sets or non-private layout sets; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the range of matching groups
Throws:: SystemException - if a system exception occurred

getNullFriendlyURLGroups

public static List<Group> getNullFriendlyURLGroups()
                                            throws SystemException

Returns all non-system groups having null or empty friendly URLs.

Returns:: the non-system groups having null or empty friendly URLs
Throws:: SystemException - if a system exception occurred

getOrganizationGroup

public static Group getOrganizationGroup(long companyId,
                                         long organizationId)
                                  throws PortalException,
                                         SystemException

Returns the specified organization group.

Parameters:: companyId - the primary key of the company; organizationId - the primary key of the organization
Returns:: the group associated with the organization
Throws:: PortalException - if a matching group could not be found; SystemException - if a system exception occurred

getOrganizationsGroups

public static List<Group> getOrganizationsGroups(List<Organization> organizations)

Returns the specified organization groups.

Parameters:: organizations - the organizations
Returns:: the groups associated with the organizations

getOrganizationsRelatedGroups

public static List<Group> getOrganizationsRelatedGroups(List<Organization> organizations)
                                                 throws SystemException

Returns all the groups related to the organizations.

Parameters:: organizations - the organizations
Returns:: the groups related to the organizations
Throws:: SystemException - if a system exception occurred

getParentGroups

public static List<Group> getParentGroups(long groupId)
                                   throws PortalException,
                                          SystemException

Returns the group followed by all its parent groups ordered by closest ancestor.

Parameters:: groupId - the primary key of the group
Returns:: the group followed by all its parent groups ordered by closest ancestor
Throws:: PortalException - if a group with the primary key could not be found; SystemException - if a system exception occurred

getStagingGroup

public static Group getStagingGroup(long liveGroupId)
                             throws PortalException,
                                    SystemException

Returns the staging group.

Parameters:: liveGroupId - the primary key of the live group
Returns:: the staging group
Throws:: PortalException - if a matching staging group could not be found; SystemException - if a system exception occurred

getUserGroup

public static Group getUserGroup(long companyId,
                                 long userId)
                          throws PortalException,
                                 SystemException

Returns the group associated with the user.

Parameters:: companyId - the primary key of the company; userId - the primary key of the user
Returns:: the group associated with the user
Throws:: PortalException - if a matching group could not be found; SystemException - if a system exception occurred

getUserGroupGroup

public static Group getUserGroupGroup(long companyId,
                                      long userGroupId)
                               throws PortalException,
                                      SystemException

Returns the specified "user group" group. That is, the group that represents the UserGroup entity.

Parameters:: companyId - the primary key of the company; userGroupId - the primary key of the user group
Returns:: the group associated with the user group
Throws:: PortalException - if a matching group could not be found; SystemException - if a system exception occurred

getUserGroups

public static List<Group> getUserGroups(long userId,
                                        boolean inherit)
                                 throws PortalException,
                                        SystemException

Returns all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: userId - the primary key of the user; inherit - whether to include the user's inherited organization groups and user groups
Returns:: the user's groups and immediate organization groups
Throws:: PortalException - if a user with the primary key could not be found; SystemException - if a system exception occurred

getUserGroups

public static List<Group> getUserGroups(long userId,
                                        boolean inherit,
                                        int start,
                                        int end)
                                 throws PortalException,
                                        SystemException

Returns an ordered range of all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: userId - the primary key of the user; inherit - whether to include the user's inherited organization groups and user groups; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the range of the user's groups and immediate organization groups ordered by name
Throws:: PortalException - if a user with the primary key could not be found; SystemException - if a system exception occurred

getUserGroupsGroups

public static List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
                                       throws PortalException,
                                              SystemException

Returns the groups associated with the user groups.

Parameters:: userGroups - the user groups
Returns:: the groups associated with the user groups
Throws:: PortalException - if any one of the user group's group could not be found; SystemException - if a system exception occurred

getUserGroupsRelatedGroups

public static List<Group> getUserGroupsRelatedGroups(List<UserGroup> userGroups)
                                              throws SystemException

Returns all the groups related to the user groups.

Parameters:: userGroups - the user groups
Returns:: the groups related to the user groups
Throws:: SystemException - if a system exception occurred

getUserOrganizationsGroups

public static List<Group> getUserOrganizationsGroups(long userId,
                                                     int start,
                                                     int end)
                                              throws PortalException,
                                                     SystemException

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.

Parameters:: userId - the primary key of the user; start - the lower bound of the range of groups to consider; end - the upper bound of the range of groups to consider (not inclusive)
Returns:: the range of groups associated with the user's organization groups
Throws:: PortalException - if a user with the primary key could not be found or if another portal exception occurred; SystemException - if a system exception occurred

getUserPersonalSiteGroup

public static Group getUserPersonalSiteGroup(long companyId)
                                      throws PortalException,
                                             SystemException

Throws:: PortalException; SystemException

getUserSitesGroups

public static List<Group> getUserSitesGroups(long userId)
                                      throws PortalException,
                                             SystemException

Throws:: PortalException; SystemException

getUserSitesGroups

public static List<Group> getUserSitesGroups(long userId,
                                             boolean includeAdministrative)
                                      throws PortalException,
                                             SystemException

Throws:: PortalException; SystemException

hasStagingGroup

public static boolean hasStagingGroup(long liveGroupId)
                               throws SystemException

Returns true if the live group has a staging group.

Parameters:: liveGroupId - the primary key of the live group
Returns:: true if the live group has a staging group; false otherwise
Throws:: SystemException - if a system exception occurred

hasUserGroup

public static boolean hasUserGroup(long userId,
                                   long groupId,
                                   boolean inherit)
                            throws SystemException

Returns true if the user is immediately associated with the group, or optionally if the user is associated with the group via the user's organizations, inherited organizations, or user groups.

Parameters:: userId - the primary key of the user; groupId - the primary key of the group; inherit - whether to include organization groups and user groups to which the user belongs in the determination
Returns:: true if the user is associated with the group; false otherwise
Throws:: SystemException - if a system exception occurred

loadFetchGroup

public static Group loadFetchGroup(long companyId,
                                   String name)
                            throws SystemException

Returns the group with the matching group name by first searching the system groups and then using the finder cache.

Parameters:: companyId - the primary key of the company; name - the group's name
Returns:: the group with the name and associated company, or null if a matching group could not be found
Throws:: SystemException - if a system exception occurred

loadGetGroup

public static Group loadGetGroup(long companyId,
                                 String name)
                          throws PortalException,
                                 SystemException

Returns the group with the matching group name.

Parameters:: companyId - the primary key of the company; name - the group's name
Returns:: the group with the name and associated company
Throws:: PortalException - if a matching group could not be found; SystemException - if a system exception occurred

rebuildTree

public static void rebuildTree(long companyId)
                        throws PortalException,
                               SystemException

Rebuilds the group tree.

Only call this method if the tree has become stale through operations other than normal CRUD. Under normal circumstances the tree is automatically rebuilt whenever necessary.

Parameters:: companyId - the primary key of the group's company
Throws:: PortalException - if a group with the primary key could not be found; SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end)
                          throws SystemException

Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the matching groups ordered by name
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long parentGroupId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end)
                          throws SystemException

Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; parentGroupId - the primary key of the parent group; keywords - the keywords (space separated), which may occur in the sites's name, or 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 return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the matching groups ordered by name
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long parentGroupId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws SystemException

Parameters:: companyId - the primary key of the company; parentGroupId - the primary key of the parent group; keywords - the keywords (space separated), which may occur in the sites's name, or 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 return; end - the upper bound of the range of groups to return (not inclusive); obc - the comparator to order the groups (optionally null)
Returns:: the matching groups ordered by comparator obc
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long parentGroupId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end)
                          throws SystemException

Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; parentGroupId - the primary key of the parent group; name - 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; andOperator - whether every field must match its keywords, or just one field.; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the matching groups ordered by name
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long parentGroupId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws SystemException

Parameters:: companyId - the primary key of the company; parentGroupId - the primary key of the parent group; name - 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; andOperator - whether every field must match its keywords, or just one field.; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive); obc - the comparator to order the groups (optionally null)
Returns:: the matching groups ordered by comparator obc
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 long parentGroupId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end)
                          throws SystemException

Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); parentGroupId - the primary key of the parent group; keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null); params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the matching groups ordered by name
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 long parentGroupId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws SystemException

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); parentGroupId - the primary key of the parent group; keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null); params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive); obc - the comparator to order the groups (optionally null)
Returns:: the matching groups ordered by comparator obc
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 long parentGroupId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end)
                          throws SystemException

Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); parentGroupId - the primary key of the parent group; name - the group's name (optionally null); description - the group's description (optionally null); params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder; andOperator - whether every field must match its keywords, or just one field.; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the matching groups ordered by name
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 long parentGroupId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws SystemException

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); parentGroupId - the primary key of the parent group; name - the group's name (optionally null); description - the group's description (optionally null); params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder; andOperator - whether every field must match its keywords, or just one field.; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive); obc - the comparator to order the groups (optionally null)
Returns:: the matching groups ordered by comparator obc
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end)
                          throws SystemException

Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null); params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the matching groups ordered by name
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws SystemException

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null); params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive); obc - the comparator to order the groups (optionally null)
Returns:: the matching groups ordered by comparator obc
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end)
                          throws SystemException

Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); name - the group's name (optionally null); description - the group's description (optionally null); params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder; andOperator - whether every field must match its keywords, or just one field.; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the matching groups ordered by name
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 long[] classNameIds,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws SystemException

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); name - the group's name (optionally null); description - the group's description (optionally null); params - the finder params (optionally null). To include a user's organizations, inherited organizations, and user groups in the search, add an entry with key "usersGroups" mapped to the user's ID and an entry with key "inherit" mapped to a non-null object. For more information see GroupFinder; andOperator - whether every field must match its keywords, or just one field.; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive); obc - the comparator to order the groups (optionally null)
Returns:: the matching groups ordered by comparator obc
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end)
                          throws SystemException

Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; keywords - the keywords (space separated), which may occur in the sites's name, or 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 return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the matching groups ordered by name
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws SystemException

Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; keywords - the keywords (space separated), which may occur in the sites's name, or 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 return; end - the upper bound of the range of groups to return (not inclusive); obc - the comparator to order the groups (optionally null)
Returns:: the matching groups ordered by comparator obc
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end)
                          throws SystemException

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. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; name - 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; andOperator - whether every field must match its keywords, or just one field.; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive)
Returns:: the matching groups ordered by name
Throws:: SystemException - if a system exception occurred

search

public static List<Group> search(long companyId,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end,
                                 OrderByComparator obc)
                          throws SystemException

Parameters:: companyId - the primary key of the company; name - 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; andOperator - whether every field must match its keywords, or just one field.; start - the lower bound of the range of groups to return; end - the upper bound of the range of groups to return (not inclusive); obc - the comparator to order the groups (optionally null)
Returns:: the matching groups ordered by comparator obc
Throws:: SystemException - if a system exception occurred

searchCount

public static int searchCount(long companyId,
                              long parentGroupId,
                              String keywords,
                              LinkedHashMap<String,Object> params)
                       throws SystemException

Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; parentGroupId - the primary key of the parent group; keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null); params - the finder params (optionally null). To include the user's inherited organization groups 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
Returns:: the number of matching groups
Throws:: SystemException - if a system exception occurred

searchCount

public static int searchCount(long companyId,
                              long parentGroupId,
                              String name,
                              String description,
                              LinkedHashMap<String,Object> params,
                              boolean andOperator)
                       throws SystemException

Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; parentGroupId - the primary key of the parent group; name - 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 organization groups 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; andOperator - whether every field must match its keywords, or just one field.
Returns:: the number of matching groups
Throws:: SystemException - if a system exception occurred

searchCount

public static int searchCount(long companyId,
                              long[] classNameIds,
                              long parentGroupId,
                              String keywords,
                              LinkedHashMap<String,Object> params)
                       throws SystemException

Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); parentGroupId - the primary key of the parent group; keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null); params - the finder params (optionally null). To include the user's inherited organization groups 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
Returns:: the number of matching groups
Throws:: SystemException - if a system exception occurred

searchCount

public static int searchCount(long companyId,
                              long[] classNameIds,
                              long parentGroupId,
                              String name,
                              String description,
                              LinkedHashMap<String,Object> params,
                              boolean andOperator)
                       throws SystemException

Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); parentGroupId - the primary key of the parent group; name - 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 organization groups 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; andOperator - whether every field must match its keywords, or just one field.
Returns:: the number of matching groups
Throws:: SystemException - if a system exception occurred

searchCount

public static int searchCount(long companyId,
                              long[] classNameIds,
                              String keywords,
                              LinkedHashMap<String,Object> params)
                       throws SystemException

Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null); params - the finder params (optionally null). To include the user's inherited organization groups 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
Returns:: the number of matching groups
Throws:: SystemException - if a system exception occurred

searchCount

public static int searchCount(long companyId,
                              long[] classNameIds,
                              String name,
                              String description,
                              LinkedHashMap<String,Object> params,
                              boolean andOperator)
                       throws SystemException

Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; classNameIds - the primary keys of the class names of the entities the groups are related to (optionally null); name - 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 organization groups 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; andOperator - whether every field must match its keywords, or just one field.
Returns:: the number of matching groups
Throws:: SystemException - if a system exception occurred

searchCount

public static int searchCount(long companyId,
                              String keywords,
                              LinkedHashMap<String,Object> params)
                       throws SystemException

Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; keywords - the keywords (space separated), which may occur in the sites's name, or description (optionally null); params - the finder params (optionally null). To include the user's inherited organization groups 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
Returns:: the number of matching groups
Throws:: SystemException - if a system exception occurred

searchCount

public static int searchCount(long companyId,
                              String name,
                              String description,
                              LinkedHashMap<String,Object> params,
                              boolean andOperator)
                       throws SystemException

Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Parameters:: companyId - the primary key of the company; name - 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 organization groups 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; andOperator - whether every field must match its keywords, or just one field.
Returns:: the number of matching groups
Throws:: SystemException - if a system exception occurred

unsetRoleGroups

public static void unsetRoleGroups(long roleId,
                                   long[] groupIds)
                            throws SystemException

Removes the groups from the role.

Parameters:: roleId - the primary key of the role; groupIds - the primary keys of the groups
Throws:: SystemException - if a system exception occurred

unsetUserGroups

public static void unsetUserGroups(long userId,
                                   long[] groupIds)
                            throws SystemException

Removes the user from the groups.

Parameters:: userId - the primary key of the user; groupIds - the primary keys of the groups
Throws:: SystemException - if a system exception occurred

updateAsset

public static void updateAsset(long userId,
                               Group group,
                               long[] assetCategoryIds,
                               String[] assetTagNames)
                        throws PortalException,
                               SystemException

Updates the group's asset replacing categories and tag names.

Parameters:: userId - the primary key of the user; group - the group; assetCategoryIds - the primary keys of the asset categories (optionally null); assetTagNames - the asset tag names (optionally null)
Throws:: PortalException - if a user with the primary key could not be found; SystemException - if a system exception occurred

updateFriendlyURL

public static Group updateFriendlyURL(long groupId,
                                      String friendlyURL)
                               throws PortalException,
                                      SystemException

Updates the group's friendly URL.

Parameters:: groupId - the primary key of the group; friendlyURL - the group's new friendlyURL (optionally null)
Returns:: the group
Throws:: PortalException - 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 occurred

updateGroup

public static Group updateGroup(long groupId,
                                long parentGroupId,
                                String name,
                                String description,
                                int type,
                                boolean manualMembership,
                                int membershipRestriction,
                                String friendlyURL,
                                boolean active,
                                ServiceContext serviceContext)
                         throws PortalException,
                                SystemException

Updates the group.

Parameters:: groupId - the primary key of the group; parentGroupId - the primary key of the parent group; name - the group's new name; description - 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 active; serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group.
Returns:: the group
Throws:: PortalException - if a group with the primary key could not be found or if the friendly URL was invalid or could one not be created; SystemException - if a system exception occurred

updateGroup

public static Group updateGroup(long groupId,
                                String typeSettings)
                         throws PortalException,
                                SystemException

Updates the group's type settings.

Parameters:: groupId - the primary key of the group; typeSettings - the group's new type settings (optionally null)
Returns:: the group
Throws:: PortalException - if a group with the primary key could not be found; SystemException - if a system exception occurred

updateSite

public static Group updateSite(long groupId,
                               boolean site)
                        throws PortalException,
                               SystemException

Associates the group with a main site if the group is an organization.

Parameters:: groupId - the primary key of the group; site - whether the group is to be associated with a main site
Returns:: the group
Throws:: PortalException - if a group with the primary key could not be found; SystemException - if a system exception occurred

getService

public static GroupLocalService getService()

setService

public void setService(GroupLocalService service)

Deprecated. As of 6.2.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.2-ce-ga5

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.service Class GroupLocalServiceUtil

GroupLocalServiceUtil

addGroup

createGroup

deleteGroup

deleteGroup

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

fetchGroup

fetchGroupByUuidAndCompanyId

getGroup

getPersistedModel

getGroupByUuidAndCompanyId

getGroups

getGroupsCount

updateGroup

addOrganizationGroup

addOrganizationGroup

addOrganizationGroups

addOrganizationGroups

clearOrganizationGroups

deleteOrganizationGroup

deleteOrganizationGroup

deleteOrganizationGroups

deleteOrganizationGroups

getOrganizationGroups

getOrganizationGroups

getOrganizationGroups

getOrganizationGroupsCount

hasOrganizationGroup

hasOrganizationGroups

setOrganizationGroups

addRoleGroup

addRoleGroup

addRoleGroups

addRoleGroups

clearRoleGroups

deleteRoleGroup

deleteRoleGroup

deleteRoleGroups

deleteRoleGroups

getRoleGroups

getRoleGroups

getRoleGroups

getRoleGroupsCount

hasRoleGroup

hasRoleGroups

setRoleGroups

addUserGroupGroup

addUserGroupGroup

addUserGroupGroups

addUserGroupGroups

clearUserGroupGroups

deleteUserGroupGroup

deleteUserGroupGroup

deleteUserGroupGroups

deleteUserGroupGroups

getUserGroupGroups

getUserGroupGroups

getUserGroupGroups

getUserGroupGroupsCount

hasUserGroupGroup

hasUserGroupGroups

setUserGroupGroups

addUserGroup

addUserGroup

addUserGroups

addUserGroups

clearUserGroups

deleteUserGroup

deleteUserGroup

deleteUserGroups

deleteUserGroups

getUserGroups

getUserGroups

getUserGroups

com.liferay.portal.service
Class GroupLocalServiceUtil