Liferay 7.0-ce-b4

com.liferay.portal.service.impl
Class GroupLocalServiceImpl

java.lang.Object
  extended by com.liferay.portal.service.BaseLocalServiceImpl
      extended by com.liferay.portal.service.base.GroupLocalServiceBaseImpl
          extended by com.liferay.portal.service.impl.GroupLocalServiceImpl
All Implemented Interfaces:
IdentifiableOSGiService, BaseLocalService, GroupLocalService, PersistedModelLocalService

public class GroupLocalServiceImpl
extends GroupLocalServiceBaseImpl

Provides the local service for accessing, adding, deleting, and updating groups. Groups are mostly used in Liferay as a resource container for permissioning and content scoping purposes.

Groups are also the entity to which LayoutSets are generally associated. Since LayoutSets are the parent entities of Layouts (i.e. pages), no entity can have associated pages without also having an associated Group. This relationship can be depicted as ... Layout -> LayoutSet -> Group[type] [-> Entity]. Note, the Entity part is optional.

Group has a "type" definition that is typically identified by two fields of the entity - String className, and int type .

The className field helps create the group's association with other entities (e.g. Organization, User, Company, UserGroup, ... etc.). The value of className is the full name of the entity's class and the primary key of the associated entity instance. A site has className="Group" and has no associated entity.

The type field helps distinguish between a group used strictly for scoping and a group that also has pages (in which case the type is SITE). For a list of types, see GroupConstants.

Here is a listing of how Group is related to some portal entities ...

See Also:
GroupImpl

Field Summary
static String ORGANIZATION_NAME_SUFFIX
           
static String ORGANIZATION_STAGING_SUFFIX
           
protected  File publicLARFile
           
 
Fields inherited from class com.liferay.portal.service.base.GroupLocalServiceBaseImpl
accountLocalService, accountPersistence, assetCategoryFinder, assetCategoryLocalService, assetCategoryPersistence, assetEntryFinder, assetEntryLocalService, assetEntryPersistence, assetTagFinder, assetTagLocalService, assetTagPersistence, assetVocabularyFinder, assetVocabularyLocalService, assetVocabularyPersistence, classNameLocalService, classNamePersistence, companyLocalService, companyPersistence, counterLocalService, dlAppLocalService, expandoRowLocalService, expandoRowPersistence, exportImportConfigurationLocalService, exportImportConfigurationPersistence, exportImportLocalService, groupFinder, groupLocalService, groupPersistence, layoutFinder, layoutLocalService, layoutPersistence, layoutPrototypeLocalService, layoutPrototypePersistence, layoutSetBranchLocalService, layoutSetBranchPersistence, layoutSetLocalService, layoutSetPersistence, layoutSetPrototypeLocalService, layoutSetPrototypePersistence, membershipRequestLocalService, membershipRequestPersistence, organizationFinder, organizationLocalService, organizationPersistence, persistedModelLocalServiceRegistry, portletLocalService, portletPersistence, portletPreferencesFinder, portletPreferencesLocalService, portletPreferencesPersistence, resourceActionLocalService, resourceActionPersistence, resourceBlockFinder, resourceBlockLocalService, resourceBlockPersistence, resourceLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, resourceTypePermissionFinder, resourceTypePermissionLocalService, resourceTypePermissionPersistence, roleFinder, roleLocalService, rolePersistence, socialActivityFinder, socialActivityLocalService, socialActivityPersistence, socialActivitySettingLocalService, socialActivitySettingPersistence, socialRequestLocalService, socialRequestPersistence, stagingLocalService, subscriptionLocalService, subscriptionPersistence, teamFinder, teamLocalService, teamPersistence, trashEntryLocalService, trashEntryPersistence, userFinder, userGroupFinder, userGroupGroupRoleFinder, userGroupGroupRoleLocalService, userGroupGroupRolePersistence, userGroupLocalService, userGroupPersistence, userGroupRoleFinder, userGroupRoleLocalService, userGroupRolePersistence, userLocalService, userPersistence, workflowDefinitionLinkLocalService, workflowDefinitionLinkPersistence
 
Constructor Summary
GroupLocalServiceImpl()
          Constructs a group local service.
 
Method Summary
protected  void addControlPanelLayouts(Group group)
           
protected  void addDefaultGuestPublicLayoutByProperties(Group group)
           
protected  void addDefaultGuestPublicLayouts(Group group)
           
protected  void addDefaultGuestPublicLayoutsByLAR(Group group, File larFile)
           
 Group addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean inheritContent, boolean active, ServiceContext serviceContext)
           
 Group addGroup(long userId, long parentGroupId, String className, long classPK, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)
           
 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)
          Deprecated. As of 7.0.0, replaced by addGroup(long, long, String, long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)
protected  void addPortletDefaultData(Group group)
           
 void addRoleGroups(long roleId, long[] groupIds)
          Adds the groups to the role.
 void addUserGroups(long userId, long[] groupIds)
          Adds the user to the groups.
 void checkCompanyGroup(long companyId)
          Adds a company group if it does not exist.
 void checkSystemGroups(long companyId)
          Creates systems groups and other related data needed by the system on the very first startup.
 Group deleteGroup(Group group)
          Deletes the group and its associated data.
 Group deleteGroup(long groupId)
          Deletes the group and its associated data.
protected  void deletePortletData(Group group)
           
 void disableStaging(long groupId)
           
protected  Collection<Group> doSearch(long companyId, long[] classNameIds, long parentGroupId, String[] names, String[] descriptions, LinkedHashMap<String,Object> params, boolean andOperator)
           
 void enableStaging(long groupId)
           
 Group fetchCompanyGroup(long companyId)
          Returns the company's group.
 Group fetchFriendlyURLGroup(long companyId, String friendlyURL)
          Returns the group with the matching friendly URL.
 Group fetchGroup(long companyId, String groupKey)
          Returns the group with the matching group key by first searching the system groups and then using the finder cache.
 Group fetchUserGroup(long companyId, long userId)
           
 Group fetchUserPersonalSiteGroup(long companyId)
          Returns the default user's personal site group.
 List<Group> getActiveGroups(long companyId, boolean active)
          Returns all the active or inactive groups associated with the company.
protected  long[] getClassNameIds()
           
 Group getCompanyGroup(long companyId)
          Returns the company group.
 List<Group> getCompanyGroups(long companyId, int start, int end)
          Returns a range of all the groups associated with the company.
 int getCompanyGroupsCount(long companyId)
          Returns the number of groups associated with the company.
protected  String getFriendlyURL(long companyId, long groupId, long classNameId, long classPK, String friendlyName, String friendlyURL)
           
protected  String getFriendlyURL(String friendlyURL)
           
 Group getFriendlyURLGroup(long companyId, String friendlyURL)
          Returns the group with the matching friendly URL.
 Group getGroup(long groupId)
          Returns the group with the matching primary key.
 Group getGroup(long companyId, String groupKey)
          Returns the group with the matching group key.
 String getGroupDescriptiveName(Group group, Locale locale)
          Deprecated. As of 7.0.0, replaced by Group.getDescriptiveName(Locale)
 String getGroupDescriptiveName(long groupId, Locale locale)
          Deprecated. As of 7.0.0, replaced by Group.getDescriptiveName(Locale)
 List<Group> getGroups(long[] groupIds)
          Returns the groups with the matching primary keys.
 List<Group> getGroups(long companyId, long parentGroupId, boolean site)
          Returns all the groups that are direct children of the parent group.
 List<Group> getGroups(long companyId, long parentGroupId, boolean site, boolean inheritContent)
           
 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.
 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.
 int getGroupsCount(long companyId, long parentGroupId, boolean site)
          Returns the number of groups that are direct children of the parent group.
 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.
 Group getLayoutGroup(long companyId, long plid)
          Returns the group associated with the layout.
 Group getLayoutPrototypeGroup(long companyId, long layoutPrototypeId)
          Returns the group associated with the layout prototype.
 Group getLayoutSetPrototypeGroup(long companyId, long layoutSetPrototypeId)
          Returns the group associated with the layout set prototype.
 List<Group> getLayoutsGroups(long companyId, long parentGroupId, boolean site, int start, int end, OrderByComparator<Group> obc)
          Returns a range of all groups that are children of the parent group and that have at least one layout.
 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
 List<Group> getLiveGroups()
          Returns all live groups.
 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.
 List<Group> getNullFriendlyURLGroups()
          Returns all non-system groups having null or empty friendly URLs.
 Group getOrganizationGroup(long companyId, long organizationId)
          Returns the specified organization group.
 List<Group> getOrganizationsGroups(List<Organization> organizations)
          Returns the specified organization groups.
 List<Group> getOrganizationsRelatedGroups(List<Organization> organizations)
          Returns all the groups related to the organizations.
protected  String getOrgGroupName(String name)
           
 List<Group> getParentGroups(long groupId)
          Returns the group followed by all its parent groups ordered by closest ancestor.
protected  List<PortletDataHandler> getPortletDataHandlers(Group group)
           
protected  String[] getSearchNames(long companyId, String name)
           
 Group getStagingGroup(long liveGroupId)
          Returns the staging group.
 Group getUserGroup(long companyId, long userId)
          Returns the group directly associated with the user.
 Group getUserGroupGroup(long companyId, long userGroupId)
          Returns the specified "user group" group.
 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.
 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.
 List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
          Returns the groups associated with the user groups.
 List<Group> getUserGroupsRelatedGroups(List<UserGroup> userGroups)
          Returns all the groups related to the user groups.
 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.
 Group getUserPersonalSiteGroup(long companyId)
          Returns the default user's personal site group.
 List<Group> getUserSitesGroups(long userId)
           
 List<Group> getUserSitesGroups(long userId, boolean includeAdministrative)
           
 boolean hasStagingGroup(long liveGroupId)
          Returns true if the live group has a staging group.
 boolean hasUserGroup(long userId, long groupId)
          Returns true if the user is immediately associated with the group, or associated with the group via the user's organizations, inherited organizations, or user groups.
 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.
protected  void initImportLARFile()
           
protected  void initUserPersonalSitePermissions(Group group)
           
protected  boolean isParentGroup(long parentGroupId, long groupId)
           
protected  boolean isStaging(ServiceContext serviceContext)
           
protected  boolean isUseComplexSQL(long[] classNameIds)
           
 Group loadFetchGroup(long companyId, String groupKey)
          Returns the group with the matching group key by first searching the system groups and then using the finder cache.
 Group loadGetGroup(long companyId, String groupKey)
          Returns the group with the matching group key.
protected  boolean matches(String s, String[] keywords)
           
 void rebuildTree(long companyId)
          Rebuilds the group tree.
 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.
 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.
 List<Group> search(long companyId, long[] classNameIds, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> 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.
 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.
 List<Group> search(long companyId, long[] classNameIds, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> 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.
 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.
 List<Group> search(long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> 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.
 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.
 List<Group> search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> 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.
 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.
 List<Group> search(long companyId, long parentGroupId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> 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.
 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.
 List<Group> search(long companyId, long parentGroupId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> 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.
 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.
 List<Group> search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)
          Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups.
 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.
 List<Group> search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> 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.
 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.
 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.
 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.
 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.
 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.
 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.
 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.
 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.
protected  void setCompanyPermissions(Role role, String name, String[] actionIds)
           
 void setRoleGroups(long roleId, long[] groupIds)
          Sets the groups associated with the role, removing and adding associations as necessary.
protected  void setRolePermissions(Group group, Role role, String name)
           
protected  void setRolePermissions(Group group, Role role, String name, String[] actionIds)
           
protected  List<Group> sort(Collection<Group> groups, int start, int end, OrderByComparator<Group> obc)
           
protected  void unscheduleStaging(Group group)
           
 void unsetRoleGroups(long roleId, long[] groupIds)
          Removes the groups from the role.
 void unsetUserGroups(long userId, long[] groupIds)
          Removes the user from the groups.
 void updateAsset(long userId, Group group, long[] assetCategoryIds, String[] assetTagNames)
          Updates the group's asset replacing categories and tag names.
 Group updateFriendlyURL(long groupId, String friendlyURL)
          Updates the group's friendly URL.
 Group updateGroup(long groupId, long parentGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext)
           
 Group updateGroup(long groupId, long parentGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by updateGroup(long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)
 Group updateGroup(long groupId, String typeSettings)
          Updates the group's type settings.
 Group updateSite(long groupId, boolean site)
          Associates the group with a main site if the group is an organization.
protected  void validateFriendlyURL(long companyId, long groupId, long classNameId, long classPK, String friendlyURL)
           
protected  void validateGroupKey(long groupId, long companyId, String groupKey, boolean site)
           
protected  void validateInheritContent(long parentGroupId, boolean inheritContent)
           
protected  void validateLanguageIds(String defaultLanguageId, String languageIds)
           
protected  void validateParentGroup(long groupId, long parentGroupId)
           
 
Methods inherited from class com.liferay.portal.service.base.GroupLocalServiceBaseImpl
addGroup, addOrganizationGroup, addOrganizationGroup, addOrganizationGroups, addOrganizationGroups, addRoleGroup, addRoleGroup, addRoleGroups, addUserGroup, addUserGroup, addUserGroupGroup, addUserGroupGroup, addUserGroupGroups, addUserGroupGroups, addUserGroups, afterPropertiesSet, clearOrganizationGroups, clearRoleGroups, clearUserGroupGroups, clearUserGroups, createGroup, deleteOrganizationGroup, deleteOrganizationGroup, deleteOrganizationGroups, deleteOrganizationGroups, deletePersistedModel, deleteRoleGroup, deleteRoleGroup, deleteRoleGroups, deleteRoleGroups, deleteUserGroup, deleteUserGroup, deleteUserGroupGroup, deleteUserGroupGroup, deleteUserGroupGroups, deleteUserGroupGroups, deleteUserGroups, deleteUserGroups, destroy, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQueryCount, dynamicQueryCount, fetchGroup, fetchGroupByUuidAndCompanyId, getAccountLocalService, getAccountPersistence, getActionableDynamicQuery, getAssetCategoryFinder, getAssetCategoryLocalService, getAssetCategoryPersistence, getAssetEntryFinder, getAssetEntryLocalService, getAssetEntryPersistence, getAssetTagFinder, getAssetTagLocalService, getAssetTagPersistence, getAssetVocabularyFinder, getAssetVocabularyLocalService, getAssetVocabularyPersistence, getClassNameLocalService, getClassNamePersistence, getCompanyLocalService, getCompanyPersistence, getCounterLocalService, getDLAppLocalService, getExpandoRowLocalService, getExpandoRowPersistence, getExportImportConfigurationLocalService, getExportImportConfigurationPersistence, getExportImportLocalService, getGroupByUuidAndCompanyId, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroups, getGroupsCount, getIndexableActionableDynamicQuery, getLayoutFinder, getLayoutLocalService, getLayoutPersistence, getLayoutPrototypeLocalService, getLayoutPrototypePersistence, getLayoutSetBranchLocalService, getLayoutSetBranchPersistence, getLayoutSetLocalService, getLayoutSetPersistence, getLayoutSetPrototypeLocalService, getLayoutSetPrototypePersistence, getMembershipRequestLocalService, getMembershipRequestPersistence, getModelClass, getModelClassName, getOrganizationFinder, getOrganizationGroups, getOrganizationGroups, getOrganizationGroups, getOrganizationGroupsCount, getOrganizationLocalService, getOrganizationPersistence, getOrganizationPrimaryKeys, getOSGiServiceIdentifier, getPersistedModel, getPortletLocalService, getPortletPersistence, getPortletPreferencesFinder, getPortletPreferencesLocalService, getPortletPreferencesPersistence, getResourceActionLocalService, getResourceActionPersistence, getResourceBlockFinder, getResourceBlockLocalService, getResourceBlockPersistence, getResourceLocalService, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getResourceTypePermissionFinder, getResourceTypePermissionLocalService, getResourceTypePermissionPersistence, getRoleFinder, getRoleGroups, getRoleGroups, getRoleGroups, getRoleGroupsCount, getRoleLocalService, getRolePersistence, getRolePrimaryKeys, getSocialActivityFinder, getSocialActivityLocalService, getSocialActivityPersistence, getSocialActivitySettingLocalService, getSocialActivitySettingPersistence, getSocialRequestLocalService, getSocialRequestPersistence, getStagingLocalService, getSubscriptionLocalService, getSubscriptionPersistence, getTeamFinder, getTeamLocalService, getTeamPersistence, getTrashEntryLocalService, getTrashEntryPersistence, getUserFinder, getUserGroupFinder, getUserGroupGroupRoleFinder, getUserGroupGroupRoleLocalService, getUserGroupGroupRolePersistence, getUserGroupGroups, getUserGroupGroups, getUserGroupGroups, getUserGroupGroupsCount, getUserGroupLocalService, getUserGroupPersistence, getUserGroupPrimaryKeys, getUserGroupRoleFinder, getUserGroupRoleLocalService, getUserGroupRolePersistence, getUserGroups, getUserGroups, getUserGroups, getUserGroupsCount, getUserLocalService, getUserPersistence, getUserPrimaryKeys, getWorkflowDefinitionLinkLocalService, getWorkflowDefinitionLinkPersistence, hasOrganizationGroup, hasOrganizationGroups, hasRoleGroup, hasRoleGroups, hasUserGroupGroup, hasUserGroupGroups, hasUserGroups, initActionableDynamicQuery, runSQL, setAccountLocalService, setAccountPersistence, setAssetCategoryFinder, setAssetCategoryLocalService, setAssetCategoryPersistence, setAssetEntryFinder, setAssetEntryLocalService, setAssetEntryPersistence, setAssetTagFinder, setAssetTagLocalService, setAssetTagPersistence, setAssetVocabularyFinder, setAssetVocabularyLocalService, setAssetVocabularyPersistence, setClassNameLocalService, setClassNamePersistence, setCompanyLocalService, setCompanyPersistence, setCounterLocalService, setDLAppLocalService, setExpandoRowLocalService, setExpandoRowPersistence, setExportImportConfigurationLocalService, setExportImportConfigurationPersistence, setExportImportLocalService, setGroupFinder, setGroupLocalService, setGroupPersistence, setLayoutFinder, setLayoutLocalService, setLayoutPersistence, setLayoutPrototypeLocalService, setLayoutPrototypePersistence, setLayoutSetBranchLocalService, setLayoutSetBranchPersistence, setLayoutSetLocalService, setLayoutSetPersistence, setLayoutSetPrototypeLocalService, setLayoutSetPrototypePersistence, setMembershipRequestLocalService, setMembershipRequestPersistence, setOrganizationFinder, setOrganizationGroups, setOrganizationLocalService, setOrganizationPersistence, setPortletLocalService, setPortletPersistence, setPortletPreferencesFinder, setPortletPreferencesLocalService, setPortletPreferencesPersistence, setResourceActionLocalService, setResourceActionPersistence, setResourceBlockFinder, setResourceBlockLocalService, setResourceBlockPersistence, setResourceLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setResourceTypePermissionFinder, setResourceTypePermissionLocalService, setResourceTypePermissionPersistence, setRoleFinder, setRoleLocalService, setRolePersistence, setSocialActivityFinder, setSocialActivityLocalService, setSocialActivityPersistence, setSocialActivitySettingLocalService, setSocialActivitySettingPersistence, setSocialRequestLocalService, setSocialRequestPersistence, setStagingLocalService, setSubscriptionLocalService, setSubscriptionPersistence, setTeamFinder, setTeamLocalService, setTeamPersistence, setTrashEntryLocalService, setTrashEntryPersistence, setUserFinder, setUserGroupFinder, setUserGroupGroupRoleFinder, setUserGroupGroupRoleLocalService, setUserGroupGroupRolePersistence, setUserGroupGroups, setUserGroupLocalService, setUserGroupPersistence, setUserGroupRoleFinder, setUserGroupRoleLocalService, setUserGroupRolePersistence, setUserGroups, setUserLocalService, setUserPersistence, setWorkflowDefinitionLinkLocalService, setWorkflowDefinitionLinkPersistence, updateGroup
 
Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl
getClassLoader, getLocalizationMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ORGANIZATION_NAME_SUFFIX

public static final String ORGANIZATION_NAME_SUFFIX
See Also:
Constant Field Values

ORGANIZATION_STAGING_SUFFIX

public static final String ORGANIZATION_STAGING_SUFFIX
See Also:
Constant Field Values

publicLARFile

protected File publicLARFile
Constructor Detail

GroupLocalServiceImpl

public GroupLocalServiceImpl()
Constructs a group local service.

Method Detail

addGroup

public Group addGroup(long userId,
                      long parentGroupId,
                      String className,
                      long classPK,
                      long liveGroupId,
                      Map<Locale,String> nameMap,
                      Map<Locale,String> descriptionMap,
                      int type,
                      boolean manualMembership,
                      int membershipRestriction,
                      String friendlyURL,
                      boolean site,
                      boolean inheritContent,
                      boolean active,
                      ServiceContext serviceContext)
               throws PortalException
Throws:
PortalException

addGroup

public Group addGroup(long userId,
                      long parentGroupId,
                      String className,
                      long classPK,
                      long liveGroupId,
                      Map<Locale,String> nameMap,
                      Map<Locale,String> descriptionMap,
                      int type,
                      boolean manualMembership,
                      int membershipRestriction,
                      String friendlyURL,
                      boolean site,
                      boolean active,
                      ServiceContext serviceContext)
               throws PortalException
Throws:
PortalException

addGroup

@Deprecated
public 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
Deprecated. As of 7.0.0, replaced by addGroup(long, long, String, long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)

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.
manualMembership - whether manual membership is allowed for the group
membershipRestriction - the group's membership restriction. 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 portal exception occured

addRoleGroups

public void addRoleGroups(long roleId,
                          long[] groupIds)
Adds the groups to the role.

Specified by:
addRoleGroups in interface GroupLocalService
Overrides:
addRoleGroups in class GroupLocalServiceBaseImpl
Parameters:
roleId - the primary key of the role
groupIds - the primary keys of the groups

addUserGroups

public void addUserGroups(long userId,
                          long[] groupIds)
Adds the user to the groups.

Specified by:
addUserGroups in interface GroupLocalService
Overrides:
addUserGroups in class GroupLocalServiceBaseImpl
Parameters:
userId - the primary key of the user
groupIds - the primary keys of the groups

checkCompanyGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
public void checkCompanyGroup(long companyId)
                       throws PortalException
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 portal exception occurred

checkSystemGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
public void checkSystemGroups(long companyId)
                       throws PortalException
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 portal exception occurred

deleteGroup

public Group deleteGroup(Group group)
                  throws PortalException
Deletes the group and its associated data.

The group is unstaged and its assets and resources including layouts, membership requests, subscriptions, teams, blogs, bookmarks, events, image gallery, journals, message boards, polls, shopping related entities, and wikis are also deleted.

Specified by:
deleteGroup in interface GroupLocalService
Overrides:
deleteGroup in class GroupLocalServiceBaseImpl
Parameters:
group - the group
Returns:
the deleted group
Throws:
PortalException - if a portal exception occurred

deleteGroup

public Group deleteGroup(long groupId)
                  throws PortalException
Deletes the group and its associated data.

The group is unstaged and its assets and resources including layouts, membership requests, subscriptions, teams, blogs, bookmarks, events, image gallery, journals, message boards, polls, shopping related entities, and wikis are also deleted.

Specified by:
deleteGroup in interface GroupLocalService
Overrides:
deleteGroup in class GroupLocalServiceBaseImpl
Parameters:
groupId - the primary key of the group
Returns:
the deleted group
Throws:
PortalException - if a portal exception occurred

disableStaging

public void disableStaging(long groupId)
                    throws PortalException
Throws:
PortalException

enableStaging

public void enableStaging(long groupId)
                   throws PortalException
Throws:
PortalException

fetchCompanyGroup

public Group fetchCompanyGroup(long companyId)
Returns the company's group.

Parameters:
companyId - the primary key of the company
Returns:
the company's group, or null if a matching group could not be found

fetchFriendlyURLGroup

public Group fetchFriendlyURLGroup(long companyId,
                                   String friendlyURL)
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

fetchGroup

@Skip
public Group fetchGroup(long companyId,
                             String groupKey)
Returns the group with the matching group key by first searching the system groups and then using the finder cache.

Parameters:
companyId - the primary key of the company
groupKey - the group key
Returns:
the group with the group key and associated company, or null if a matching group could not be found

fetchUserGroup

public Group fetchUserGroup(long companyId,
                            long userId)

fetchUserPersonalSiteGroup

public Group fetchUserPersonalSiteGroup(long companyId)
                                 throws PortalException
Returns the default user's personal site group.

Parameters:
companyId - the primary key of the company
Returns:
the default user's personal site group, or null if a matching group could not be found
Throws:
PortalException - if a portal exception occurred

getActiveGroups

public List<Group> getActiveGroups(long companyId,
                                   boolean active)
Returns all the active or inactive groups associated with the company.

Parameters:
companyId - the primary key of the company
active - whether to return only active groups, or only inactive groups
Returns:
the active or inactive groups associated with the company

getCompanyGroup

public Group getCompanyGroup(long companyId)
                      throws PortalException
Returns the company group.

Parameters:
companyId - the primary key of the company
Returns:
the group associated with the company
Throws:
PortalException - if a portal exception occurred

getCompanyGroups

public List<Group> getCompanyGroups(long companyId,
                                    int start,
                                    int end)
Returns a range of all the groups associated with the company.

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.

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

getCompanyGroupsCount

public int getCompanyGroupsCount(long companyId)
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

getFriendlyURLGroup

public Group getFriendlyURLGroup(long companyId,
                                 String friendlyURL)
                          throws PortalException
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 portal exception occurred

getGroup

@ThreadLocalCachable
public Group getGroup(long groupId)
               throws PortalException
Returns the group with the matching primary key.

Specified by:
getGroup in interface GroupLocalService
Overrides:
getGroup in class GroupLocalServiceBaseImpl
Parameters:
groupId - the primary key of the group
Returns:
the group with the primary key
Throws:
PortalException - if a portal exception occurred

getGroup

@Skip
public Group getGroup(long companyId,
                           String groupKey)
               throws PortalException
Returns the group with the matching group key.

Parameters:
companyId - the primary key of the company
groupKey - the group key
Returns:
the group with the group key
Throws:
PortalException - if a portal exception occurred

getGroupDescriptiveName

@Deprecated
public String getGroupDescriptiveName(Group group,
                                                 Locale locale)
                               throws PortalException
Deprecated. As of 7.0.0, replaced by Group.getDescriptiveName(Locale)

Throws:
PortalException

getGroupDescriptiveName

@Deprecated
public String getGroupDescriptiveName(long groupId,
                                                 Locale locale)
                               throws PortalException
Deprecated. As of 7.0.0, replaced by Group.getDescriptiveName(Locale)

Throws:
PortalException

getGroups

public List<Group> getGroups(long companyId,
                             long parentGroupId,
                             boolean site)
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

getGroups

public List<Group> getGroups(long companyId,
                             long parentGroupId,
                             boolean site,
                             boolean inheritContent)

getGroups

public 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.

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

getGroups

public 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.

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

getGroups

public List<Group> getGroups(long[] groupIds)
                      throws PortalException
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 a portal exception occurred

getGroupsCount

public int getGroupsCount(long companyId,
                          long parentGroupId,
                          boolean site)
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

getGroupsCount

public 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.

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

getLayoutGroup

public Group getLayoutGroup(long companyId,
                            long plid)
                     throws PortalException
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 portal exception occurred

getLayoutPrototypeGroup

public Group getLayoutPrototypeGroup(long companyId,
                                     long layoutPrototypeId)
                              throws PortalException
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 portal exception occurred

getLayoutSetPrototypeGroup

public Group getLayoutSetPrototypeGroup(long companyId,
                                        long layoutSetPrototypeId)
                                 throws PortalException
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 portal exception occurred

getLayoutsGroups

public List<Group> getLayoutsGroups(long companyId,
                                    long parentGroupId,
                                    boolean site,
                                    int start,
                                    int end,
                                    OrderByComparator<Group> obc)
Returns a range of all groups that are children of the parent group and that have at least one layout.

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.

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

getLayoutsGroupsCount

public 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

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

getLiveGroups

public List<Group> getLiveGroups()
Returns all live groups.

Returns:
all live groups

getNoLayoutsGroups

public 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.

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.

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

getNullFriendlyURLGroups

public List<Group> getNullFriendlyURLGroups()
Returns all non-system groups having null or empty friendly URLs.

Returns:
the non-system groups having null or empty friendly URLs

getOrganizationGroup

public Group getOrganizationGroup(long companyId,
                                  long organizationId)
                           throws PortalException
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 portal exception occurred

getOrganizationsGroups

public List<Group> getOrganizationsGroups(List<Organization> organizations)
Returns the specified organization groups.

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

getOrganizationsRelatedGroups

public List<Group> getOrganizationsRelatedGroups(List<Organization> organizations)
Returns all the groups related to the organizations.

Parameters:
organizations - the organizations
Returns:
the groups related to the organizations

getParentGroups

public List<Group> getParentGroups(long groupId)
                            throws PortalException
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 portal exception occurred

getStagingGroup

public Group getStagingGroup(long liveGroupId)
                      throws PortalException
Returns the staging group.

Parameters:
liveGroupId - the primary key of the live group
Returns:
the staging group
Throws:
PortalException - if a portal exception occurred

getUserGroup

public Group getUserGroup(long companyId,
                          long userId)
                   throws PortalException
Returns the group directly associated with the user.

Parameters:
companyId - the primary key of the company
userId - the primary key of the user
Returns:
the group directly associated with the user
Throws:
PortalException - if a portal exception occurred

getUserGroupGroup

public Group getUserGroupGroup(long companyId,
                               long userGroupId)
                        throws PortalException
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 portal exception occurred

getUserGroups

public List<Group> getUserGroups(long userId,
                                 boolean inherit)
                          throws PortalException
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 portal exception occurred

getUserGroups

public List<Group> getUserGroups(long userId,
                                 boolean inherit,
                                 int start,
                                 int end)
                          throws PortalException
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.

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.

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 portal exception occurred

getUserGroupsGroups

public List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
                                throws PortalException
Returns the groups associated with the user groups.

Parameters:
userGroups - the user groups
Returns:
the groups associated with the user groups
Throws:
PortalException - if a portal exception occurred

getUserGroupsRelatedGroups

public List<Group> getUserGroupsRelatedGroups(List<UserGroup> userGroups)
Returns all the groups related to the user groups.

Parameters:
userGroups - the user groups
Returns:
the groups related to the user groups

getUserOrganizationsGroups

public List<Group> getUserOrganizationsGroups(long userId,
                                              int start,
                                              int end)
                                       throws PortalException
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.

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.

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 portal exception occurred

getUserPersonalSiteGroup

public Group getUserPersonalSiteGroup(long companyId)
                               throws PortalException
Returns the default user's personal site group.

Parameters:
companyId - the primary key of the company
Returns:
the default user's personal site group
Throws:
PortalException - if a portal exception occurred

getUserSitesGroups

public List<Group> getUserSitesGroups(long userId)
                               throws PortalException
Throws:
PortalException

getUserSitesGroups

public List<Group> getUserSitesGroups(long userId,
                                      boolean includeAdministrative)
                               throws PortalException
Throws:
PortalException

hasStagingGroup

public boolean hasStagingGroup(long liveGroupId)
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

hasUserGroup

public boolean hasUserGroup(long userId,
                            long groupId)
Returns true if the user is immediately associated with the group, or associated with the group via the user's organizations, inherited organizations, or user groups.

Specified by:
hasUserGroup in interface GroupLocalService
Overrides:
hasUserGroup in class GroupLocalServiceBaseImpl
Parameters:
userId - the primary key of the user
groupId - the primary key of the group
Returns:
true if the user is associated with the group; false otherwise

hasUserGroup

public 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.

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

loadFetchGroup

public Group loadFetchGroup(long companyId,
                            String groupKey)
Returns the group with the matching group key by first searching the system groups and then using the finder cache.

Parameters:
companyId - the primary key of the company
groupKey - the group key
Returns:
the group with the group key and associated company, or null if a matching group could not be found

loadGetGroup

public Group loadGetGroup(long companyId,
                          String groupKey)
                   throws PortalException
Returns the group with the matching group key.

Parameters:
companyId - the primary key of the company
groupKey - the group key
Returns:
the group with the group key and associated company
Throws:
PortalException - if a portal exception occurred

rebuildTree

public void rebuildTree(long companyId)
                 throws PortalException
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 portal exception occurred

search

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

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.

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

search

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

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.

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

search

public List<Group> search(long companyId,
                          long parentGroupId,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. System and staged groups are not included.

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.

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

search

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

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.

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

search

public List<Group> search(long companyId,
                          long parentGroupId,
                          String name,
                          String description,
                          LinkedHashMap<String,Object> params,
                          boolean andOperator,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. System and staged groups are not included.

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.

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

search

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

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.

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

search

public List<Group> search(long companyId,
                          long[] classNameIds,
                          long parentGroupId,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. System and staged groups are not included.

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.

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

search

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

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.

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

search

public List<Group> search(long companyId,
                          long[] classNameIds,
                          long parentGroupId,
                          String name,
                          String description,
                          LinkedHashMap<String,Object> params,
                          boolean andOperator,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. System and staged groups are not included.

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.

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

search

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

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.

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

search

public List<Group> search(long companyId,
                          long[] classNameIds,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. System and staged groups are not included.

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.

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

search

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

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.

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

search

public List<Group> search(long companyId,
                          long[] classNameIds,
                          String name,
                          String description,
                          LinkedHashMap<String,Object> params,
                          boolean andOperator,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. System and staged groups are not included.

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.

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

search

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

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.

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

search

public List<Group> search(long companyId,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          OrderByComparator<Group> obc)
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.

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.

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

search

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

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.

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

search

public List<Group> search(long companyId,
                          String name,
                          String description,
                          LinkedHashMap<String,Object> params,
                          boolean andOperator,
                          int start,
                          int end,
                          OrderByComparator<Group> 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. System and staged groups are not included.

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.

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

searchCount

@ThreadLocalCachable
public 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. 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

searchCount

@ThreadLocalCachable
public 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. 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

searchCount

@ThreadLocalCachable
public 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. 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

searchCount

@ThreadLocalCachable
public 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. 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

searchCount

@ThreadLocalCachable
public 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. 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

searchCount

@ThreadLocalCachable
public 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. 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

searchCount

@ThreadLocalCachable
public 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. 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

searchCount

@ThreadLocalCachable
public 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. 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

setRoleGroups

public void setRoleGroups(long roleId,
                          long[] groupIds)
Sets the groups associated with the role, removing and adding associations as necessary.

Specified by:
setRoleGroups in interface GroupLocalService
Overrides:
setRoleGroups in class GroupLocalServiceBaseImpl
Parameters:
roleId - the primary key of the role
groupIds - the primary keys of the groups

unsetRoleGroups

public void unsetRoleGroups(long roleId,
                            long[] groupIds)
Removes the groups from the role.

Parameters:
roleId - the primary key of the role
groupIds - the primary keys of the groups

unsetUserGroups

public void unsetUserGroups(long userId,
                            long[] groupIds)
Removes the user from the groups.

Parameters:
userId - the primary key of the user
groupIds - the primary keys of the groups

updateAsset

public void updateAsset(long userId,
                        Group group,
                        long[] assetCategoryIds,
                        String[] assetTagNames)
                 throws PortalException
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 portal exception occurred

updateFriendlyURL

public Group updateFriendlyURL(long groupId,
                               String friendlyURL)
                        throws PortalException
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 portal exception occurred

updateGroup

public Group updateGroup(long groupId,
                         long parentGroupId,
                         Map<Locale,String> nameMap,
                         Map<Locale,String> descriptionMap,
                         int type,
                         boolean manualMembership,
                         int membershipRestriction,
                         String friendlyURL,
                         boolean inheritContent,
                         boolean active,
                         ServiceContext serviceContext)
                  throws PortalException
Throws:
PortalException

updateGroup

@Deprecated
public Group updateGroup(long groupId,
                                    long parentGroupId,
                                    String name,
                                    String description,
                                    int type,
                                    boolean manualMembership,
                                    int membershipRestriction,
                                    String friendlyURL,
                                    boolean inheritContent,
                                    boolean active,
                                    ServiceContext serviceContext)
                  throws PortalException
Deprecated. As of 7.0.0, replaced by updateGroup(long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)

Updates the group.

Parameters:
groupId - the primary key of the group
parentGroupId - the primary key of the parent group
name - the name's key
description - the group's new description (optionally null)
type - the group's new type. For more information see GroupConstants.
manualMembership - whether manual membership is allowed for the group
membershipRestriction - the group's membership restriction. For more information see GroupConstants.
friendlyURL - the group's new friendlyURL (optionally null)
inheritContent - whether to inherit content from the parent group
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 portal exception occurred

updateGroup

public Group updateGroup(long groupId,
                         String typeSettings)
                  throws PortalException
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 portal exception occurred

updateSite

public Group updateSite(long groupId,
                        boolean site)
                 throws PortalException
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 portal exception occurred

addControlPanelLayouts

protected void addControlPanelLayouts(Group group)
                               throws PortalException
Throws:
PortalException

addDefaultGuestPublicLayoutByProperties

protected void addDefaultGuestPublicLayoutByProperties(Group group)
                                                throws PortalException
Throws:
PortalException

addDefaultGuestPublicLayouts

protected void addDefaultGuestPublicLayouts(Group group)
                                     throws PortalException
Throws:
PortalException

addDefaultGuestPublicLayoutsByLAR

protected void addDefaultGuestPublicLayoutsByLAR(Group group,
                                                 File larFile)
                                          throws PortalException
Throws:
PortalException

addPortletDefaultData

protected void addPortletDefaultData(Group group)
                              throws PortalException
Throws:
PortalException

deletePortletData

protected void deletePortletData(Group group)
                          throws PortalException
Throws:
PortalException

doSearch

protected Collection<Group> doSearch(long companyId,
                                     long[] classNameIds,
                                     long parentGroupId,
                                     String[] names,
                                     String[] descriptions,
                                     LinkedHashMap<String,Object> params,
                                     boolean andOperator)

getClassNameIds

protected long[] getClassNameIds()

getFriendlyURL

protected String getFriendlyURL(long companyId,
                                long groupId,
                                long classNameId,
                                long classPK,
                                String friendlyName,
                                String friendlyURL)
                         throws PortalException
Throws:
PortalException

getFriendlyURL

protected String getFriendlyURL(String friendlyURL)

getOrgGroupName

protected String getOrgGroupName(String name)

getPortletDataHandlers

protected List<PortletDataHandler> getPortletDataHandlers(Group group)

getSearchNames

protected String[] getSearchNames(long companyId,
                                  String name)

initImportLARFile

protected void initImportLARFile()

initUserPersonalSitePermissions

protected void initUserPersonalSitePermissions(Group group)
                                        throws PortalException
Throws:
PortalException

isParentGroup

protected boolean isParentGroup(long parentGroupId,
                                long groupId)
                         throws PortalException
Throws:
PortalException

isStaging

protected boolean isStaging(ServiceContext serviceContext)

isUseComplexSQL

protected boolean isUseComplexSQL(long[] classNameIds)

matches

protected boolean matches(String s,
                          String[] keywords)

setCompanyPermissions

protected void setCompanyPermissions(Role role,
                                     String name,
                                     String[] actionIds)
                              throws PortalException
Throws:
PortalException

setRolePermissions

protected void setRolePermissions(Group group,
                                  Role role,
                                  String name)
                           throws PortalException
Throws:
PortalException

setRolePermissions

protected void setRolePermissions(Group group,
                                  Role role,
                                  String name,
                                  String[] actionIds)
                           throws PortalException
Throws:
PortalException

sort

protected List<Group> sort(Collection<Group> groups,
                           int start,
                           int end,
                           OrderByComparator<Group> obc)

unscheduleStaging

protected void unscheduleStaging(Group group)

validateFriendlyURL

protected void validateFriendlyURL(long companyId,
                                   long groupId,
                                   long classNameId,
                                   long classPK,
                                   String friendlyURL)
                            throws PortalException
Throws:
PortalException

validateGroupKey

protected void validateGroupKey(long groupId,
                                long companyId,
                                String groupKey,
                                boolean site)
                         throws PortalException
Throws:
PortalException

validateInheritContent

protected void validateInheritContent(long parentGroupId,
                                      boolean inheritContent)
                               throws GroupInheritContentException
Throws:
GroupInheritContentException

validateLanguageIds

protected void validateLanguageIds(String defaultLanguageId,
                                   String languageIds)
                            throws PortalException
Throws:
PortalException

validateParentGroup

protected void validateParentGroup(long groupId,
                                   long parentGroupId)
                            throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4