com.liferay.portal.service.impl
Class GroupLocalServiceImpl

java.lang.Object
  com.liferay.portal.service.BaseLocalServiceImpl
      com.liferay.portal.service.base.GroupLocalServiceBaseImpl
          com.liferay.portal.service.impl.GroupLocalServiceImpl

All Implemented Interfaces:

IdentifiableBean, BaseLocalService, GroupLocalService, PersistedModelLocalService

public class GroupLocalServiceImpl
extends GroupLocalServiceBaseImpl

The group local service is responsible for accessing, creating, modifying and deleting groups.

Groups are mostly used in Liferay as a resource container for permissioning and content scoping purposes as described in GroupImpl.

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

• Site is a Group with className="Group"
• Company has 1 Group (this is the global scope, but never has pages)
• User has 1 Group (pages are optional based on the behavior configuration for personal pages)
• Layout Template (LayoutPrototype) has 1 Group which uses only 1 of it's 2 LayoutSets to store a single page which can later be used to derive a single page in any Site
• Site Template (LayoutSetPrototype) has 1 Group which uses only 1 of it's 2 LayoutSets to store many pages which can later be used to derive entire Sites or pulled into an existing Site
• Organization has 1 Group, but can also be associated to a Site at any point in it's life cycle in order to support having pages
• UserGroup has 1 Group that can have pages in both of the group's LayoutSets which are later inherited by users assigned to the UserGroup

Field Summary

static String	ORGANIZATION_NAME_SUFFIX
protected File	publicLARFile

Fields inherited from class com.liferay.portal.service.base.GroupLocalServiceBaseImpl

accountLocalService, accountPersistence, accountService, addressLocalService, addressPersistence, addressService, assetEntryFinder, assetEntryLocalService, assetEntryPersistence, assetEntryService, assetVocabularyFinder, assetVocabularyLocalService, assetVocabularyPersistence, assetVocabularyService, blogsEntryFinder, blogsEntryLocalService, blogsEntryPersistence, blogsEntryService, blogsStatsUserFinder, blogsStatsUserLocalService, blogsStatsUserPersistence, bookmarksFolderFinder, bookmarksFolderLocalService, bookmarksFolderPersistence, bookmarksFolderService, browserTrackerLocalService, browserTrackerPersistence, calEventFinder, calEventLocalService, calEventPersistence, calEventService, classNameLocalService, classNamePersistence, classNameService, clusterGroupLocalService, clusterGroupPersistence, cmisRepositoryLocalService, companyLocalService, companyPersistence, companyService, contactLocalService, contactPersistence, contactService, counterLocalService, countryPersistence, countryService, dlAppLocalService, dlAppService, dlFileEntryTypeFinder, dlFileEntryTypeLocalService, dlFileEntryTypePersistence, dlFileEntryTypeService, emailAddressLocalService, emailAddressPersistence, emailAddressService, groupFinder, groupLocalService, groupPersistence, groupService, imageLocalService, imagePersistence, imageService, journalArticleFinder, journalArticleLocalService, journalArticlePersistence, journalArticleService, journalStructureFinder, journalStructureLocalService, journalStructurePersistence, journalStructureService, journalTemplateFinder, journalTemplateLocalService, journalTemplatePersistence, journalTemplateService, layoutBranchLocalService, layoutBranchPersistence, layoutBranchService, layoutFinder, layoutLocalService, layoutPersistence, layoutPrototypeLocalService, layoutPrototypePersistence, layoutPrototypeService, layoutRevisionLocalService, layoutRevisionPersistence, layoutRevisionService, layoutService, layoutSetBranchLocalService, layoutSetBranchPersistence, layoutSetBranchService, layoutSetLocalService, layoutSetPersistence, layoutSetPrototypeLocalService, layoutSetPrototypePersistence, layoutSetPrototypeService, layoutSetService, layoutTemplateLocalService, listTypePersistence, listTypeService, lockFinder, lockLocalService, lockPersistence, mbBanLocalService, mbBanPersistence, mbBanService, mbCategoryFinder, mbCategoryLocalService, mbCategoryPersistence, mbCategoryService, mbStatsUserLocalService, mbStatsUserPersistence, mbThreadFinder, mbThreadLocalService, mbThreadPersistence, mbThreadService, membershipRequestLocalService, membershipRequestPersistence, membershipRequestService, organizationFinder, organizationLocalService, organizationPersistence, organizationService, orgGroupPermissionFinder, orgGroupPermissionPersistence, orgGroupRolePersistence, orgLaborLocalService, orgLaborPersistence, orgLaborService, passwordPolicyFinder, passwordPolicyLocalService, passwordPolicyPersistence, passwordPolicyRelLocalService, passwordPolicyRelPersistence, passwordPolicyService, passwordTrackerLocalService, passwordTrackerPersistence, permissionFinder, permissionLocalService, permissionPersistence, permissionService, persistedModelLocalServiceRegistry, phoneLocalService, phonePersistence, phoneService, pluginSettingLocalService, pluginSettingPersistence, pluginSettingService, pollsQuestionLocalService, pollsQuestionPersistence, pollsQuestionService, portalLocalService, portalPreferencesLocalService, portalPreferencesPersistence, portalService, portletItemLocalService, portletItemPersistence, portletLocalService, portletPersistence, portletPreferencesFinder, portletPreferencesLocalService, portletPreferencesPersistence, portletPreferencesService, portletService, quartzLocalService, regionPersistence, regionService, releaseLocalService, releasePersistence, repositoryEntryLocalService, repositoryEntryPersistence, repositoryLocalService, repositoryPersistence, repositoryService, resourceActionLocalService, resourceActionPersistence, resourceBlockFinder, resourceBlockLocalService, resourceBlockPermissionLocalService, resourceBlockPermissionPersistence, resourceBlockPersistence, resourceBlockService, resourceCodeLocalService, resourceCodePersistence, resourceFinder, resourceLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, resourcePermissionService, resourcePersistence, resourceService, resourceTypePermissionFinder, resourceTypePermissionLocalService, resourceTypePermissionPersistence, roleFinder, roleLocalService, rolePersistence, roleService, scFrameworkVersionLocalService, scFrameworkVersionPersistence, scFrameworkVersionService, scProductEntryLocalService, scProductEntryPersistence, scProductEntryService, serviceComponentLocalService, serviceComponentPersistence, shardLocalService, shardPersistence, shoppingCartLocalService, shoppingCartPersistence, shoppingCategoryLocalService, shoppingCategoryPersistence, shoppingCategoryService, shoppingCouponFinder, shoppingCouponLocalService, shoppingCouponPersistence, shoppingCouponService, shoppingOrderFinder, shoppingOrderLocalService, shoppingOrderPersistence, shoppingOrderService, subscriptionLocalService, subscriptionPersistence, teamFinder, teamLocalService, teamPersistence, teamService, themeLocalService, themeService, ticketLocalService, ticketPersistence, userFinder, userGroupFinder, userGroupGroupRoleLocalService, userGroupGroupRolePersistence, userGroupGroupRoleService, userGroupLocalService, userGroupPersistence, userGroupRoleFinder, userGroupRoleLocalService, userGroupRolePersistence, userGroupRoleService, userGroupService, userIdMapperLocalService, userIdMapperPersistence, userLocalService, userNotificationEventLocalService, userNotificationEventPersistence, userPersistence, userService, userTrackerLocalService, userTrackerPathLocalService, userTrackerPathPersistence, userTrackerPersistence, virtualHostLocalService, virtualHostPersistence, webDAVPropsLocalService, webDAVPropsPersistence, websiteLocalService, websitePersistence, websiteService, wikiNodeLocalService, wikiNodePersistence, wikiNodeService, workflowDefinitionLinkLocalService, workflowDefinitionLinkPersistence, workflowInstanceLinkLocalService, workflowInstanceLinkPersistence

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, String className, long classPK, long liveGroupId, String name, String description, int type, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) Adds a group.
Group	addGroup(long userId, String className, long classPK, String name, String description, int type, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) Adds the group using the default live 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)
Group	fetchFriendlyURLGroup(long companyId, String friendlyURL) Returns the group with the matching friendly URL.
Group	fetchGroup(long companyId, String name) Returns the group with the matching group name.
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 name) Returns the group with the matching group name.
String	getGroupDescriptiveName(Group group, Locale locale)
String	getGroupDescriptiveName(long groupId, Locale locale)
List<Group>	getGroups(long[] groupIds) Returns the groups with the matching primary keys.
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>	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)
protected String	getRealName(long companyId, String name)
List<Group>	getRoleGroups(long roleId) Returns all the groups associated with the role.
Group	getStagingGroup(long liveGroupId) Returns the staging group.
Group	getUserGroup(long companyId, long userId) Returns the group associated with the user.
Group	getUserGroupGroup(long companyId, long userGroupId) Returns the specified "user group" group.
List<Group>	getUserGroups(long userId) Returns all the user's site groups and immediate organization groups.
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 a name 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>	getUserGroups(long userId, int start, int end) Returns a name ordered range of all the user's site groups and immediate organization 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.
boolean	hasRoleGroup(long roleId, long groupId) Returns true if the group is associated with the role.
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	isStaging(ServiceContext serviceContext)
Group	loadFetchGroup(long companyId, String name)
Group	loadGetGroup(long companyId, String name)
List<Group>	search(long companyId, LinkedHashMap<String,Object> params, int start, int end)
List<Group>	search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, int start, int end) Returns a name 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, int start, int end, OrderByComparator obc) Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups.
List<Group>	search(long companyId, String name, String description, LinkedHashMap<String,Object> params, int start, int end) Returns a name 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, int start, int end, OrderByComparator obc) Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
int	searchCount(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params) 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, String name, String description, LinkedHashMap<String,Object> params) 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 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, String typeSettings) Updates the group's type settings.
Group	updateGroup(long groupId, String name, String description, int type, String friendlyURL, boolean active, ServiceContext serviceContext) Updates the group.
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	validateName(long groupId, long companyId, String name, boolean site)

Methods inherited from class com.liferay.portal.service.base.GroupLocalServiceBaseImpl

addGroup, addOrganizationGroup, addOrganizationGroup, addOrganizationGroups, addOrganizationGroups, addPermissionGroup, addPermissionGroup, addPermissionGroups, addPermissionGroups, addRoleGroup, addRoleGroup, addRoleGroups, addUserGroup, addUserGroup, addUserGroupGroup, addUserGroupGroup, addUserGroupGroups, addUserGroupGroups, addUserGroups, afterPropertiesSet, clearOrganizationGroups, clearPermissionGroups, clearRoleGroups, clearUserGroupGroups, clearUserGroups, createGroup, deleteOrganizationGroup, deleteOrganizationGroup, deleteOrganizationGroups, deleteOrganizationGroups, deletePermissionGroup, deletePermissionGroup, deletePermissionGroups, deletePermissionGroups, deleteRoleGroup, deleteRoleGroup, deleteRoleGroups, deleteRoleGroups, deleteUserGroup, deleteUserGroup, deleteUserGroupGroup, deleteUserGroupGroup, deleteUserGroupGroups, deleteUserGroupGroups, deleteUserGroups, deleteUserGroups, destroy, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQueryCount, fetchGroup, getAccountLocalService, getAccountPersistence, getAccountService, getAddressLocalService, getAddressPersistence, getAddressService, getAssetEntryFinder, getAssetEntryLocalService, getAssetEntryPersistence, getAssetEntryService, getAssetVocabularyFinder, getAssetVocabularyLocalService, getAssetVocabularyPersistence, getAssetVocabularyService, getBeanIdentifier, getBlogsEntryFinder, getBlogsEntryLocalService, getBlogsEntryPersistence, getBlogsEntryService, getBlogsStatsUserFinder, getBlogsStatsUserLocalService, getBlogsStatsUserPersistence, getBookmarksFolderFinder, getBookmarksFolderLocalService, getBookmarksFolderPersistence, getBookmarksFolderService, getBrowserTrackerLocalService, getBrowserTrackerPersistence, getCalEventFinder, getCalEventLocalService, getCalEventPersistence, getCalEventService, getClassNameLocalService, getClassNamePersistence, getClassNameService, getClusterGroupLocalService, getClusterGroupPersistence, getCMISRepositoryLocalService, getCompanyLocalService, getCompanyPersistence, getCompanyService, getContactLocalService, getContactPersistence, getContactService, getCounterLocalService, getCountryPersistence, getCountryService, getDLAppLocalService, getDLAppService, getDLFileEntryTypeFinder, getDLFileEntryTypeLocalService, getDLFileEntryTypePersistence, getDLFileEntryTypeService, getEmailAddressLocalService, getEmailAddressPersistence, getEmailAddressService, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroups, getGroupsCount, getGroupService, getImageLocalService, getImagePersistence, getImageService, getJournalArticleFinder, getJournalArticleLocalService, getJournalArticlePersistence, getJournalArticleService, getJournalStructureFinder, getJournalStructureLocalService, getJournalStructurePersistence, getJournalStructureService, getJournalTemplateFinder, getJournalTemplateLocalService, getJournalTemplatePersistence, getJournalTemplateService, getLayoutBranchLocalService, getLayoutBranchPersistence, getLayoutBranchService, getLayoutFinder, getLayoutLocalService, getLayoutPersistence, getLayoutPrototypeLocalService, getLayoutPrototypePersistence, getLayoutPrototypeService, getLayoutRevisionLocalService, getLayoutRevisionPersistence, getLayoutRevisionService, getLayoutService, getLayoutSetBranchLocalService, getLayoutSetBranchPersistence, getLayoutSetBranchService, getLayoutSetLocalService, getLayoutSetPersistence, getLayoutSetPrototypeLocalService, getLayoutSetPrototypePersistence, getLayoutSetPrototypeService, getLayoutSetService, getLayoutTemplateLocalService, getListTypePersistence, getListTypeService, getLockFinder, getLockLocalService, getLockPersistence, getMBBanLocalService, getMBBanPersistence, getMBBanService, getMBCategoryFinder, getMBCategoryLocalService, getMBCategoryPersistence, getMBCategoryService, getMBStatsUserLocalService, getMBStatsUserPersistence, getMBThreadFinder, getMBThreadLocalService, getMBThreadPersistence, getMBThreadService, getMembershipRequestLocalService, getMembershipRequestPersistence, getMembershipRequestService, getModelClass, getModelClassName, getOrganizationFinder, getOrganizationGroups, getOrganizationGroups, getOrganizationGroups, getOrganizationGroupsCount, getOrganizationLocalService, getOrganizationPersistence, getOrganizationService, getOrgGroupPermissionFinder, getOrgGroupPermissionPersistence, getOrgGroupRolePersistence, getOrgLaborLocalService, getOrgLaborPersistence, getOrgLaborService, getPasswordPolicyFinder, getPasswordPolicyLocalService, getPasswordPolicyPersistence, getPasswordPolicyRelLocalService, getPasswordPolicyRelPersistence, getPasswordPolicyService, getPasswordTrackerLocalService, getPasswordTrackerPersistence, getPermissionFinder, getPermissionGroups, getPermissionGroups, getPermissionGroups, getPermissionGroupsCount, getPermissionLocalService, getPermissionPersistence, getPermissionService, getPersistedModel, getPhoneLocalService, getPhonePersistence, getPhoneService, getPluginSettingLocalService, getPluginSettingPersistence, getPluginSettingService, getPollsQuestionLocalService, getPollsQuestionPersistence, getPollsQuestionService, getPortalLocalService, getPortalPreferencesLocalService, getPortalPreferencesPersistence, getPortalService, getPortletItemLocalService, getPortletItemPersistence, getPortletLocalService, getPortletPersistence, getPortletPreferencesFinder, getPortletPreferencesLocalService, getPortletPreferencesPersistence, getPortletPreferencesService, getPortletService, getQuartzLocalService, getRegionPersistence, getRegionService, getReleaseLocalService, getReleasePersistence, getRepositoryEntryLocalService, getRepositoryEntryPersistence, getRepositoryLocalService, getRepositoryPersistence, getRepositoryService, getResourceActionLocalService, getResourceActionPersistence, getResourceBlockFinder, getResourceBlockLocalService, getResourceBlockPermissionLocalService, getResourceBlockPermissionPersistence, getResourceBlockPersistence, getResourceBlockService, getResourceCodeLocalService, getResourceCodePersistence, getResourceFinder, getResourceLocalService, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getResourcePermissionService, getResourcePersistence, getResourceService, getResourceTypePermissionFinder, getResourceTypePermissionLocalService, getResourceTypePermissionPersistence, getRoleFinder, getRoleGroups, getRoleGroups, getRoleGroupsCount, getRoleLocalService, getRolePersistence, getRoleService, getSCFrameworkVersionLocalService, getSCFrameworkVersionPersistence, getSCFrameworkVersionService, getSCProductEntryLocalService, getSCProductEntryPersistence, getSCProductEntryService, getServiceComponentLocalService, getServiceComponentPersistence, getShardLocalService, getShardPersistence, getShoppingCartLocalService, getShoppingCartPersistence, getShoppingCategoryLocalService, getShoppingCategoryPersistence, getShoppingCategoryService, getShoppingCouponFinder, getShoppingCouponLocalService, getShoppingCouponPersistence, getShoppingCouponService, getShoppingOrderFinder, getShoppingOrderLocalService, getShoppingOrderPersistence, getShoppingOrderService, getSubscriptionLocalService, getSubscriptionPersistence, getTeamFinder, getTeamLocalService, getTeamPersistence, getTeamService, getThemeLocalService, getThemeService, getTicketLocalService, getTicketPersistence, getUserFinder, getUserGroupFinder, getUserGroupGroupRoleLocalService, getUserGroupGroupRolePersistence, getUserGroupGroupRoleService, getUserGroupGroups, getUserGroupGroups, getUserGroupGroups, getUserGroupGroupsCount, getUserGroupLocalService, getUserGroupPersistence, getUserGroupRoleFinder, getUserGroupRoleLocalService, getUserGroupRolePersistence, getUserGroupRoleService, getUserGroups, getUserGroupsCount, getUserGroupService, getUserIdMapperLocalService, getUserIdMapperPersistence, getUserLocalService, getUserNotificationEventLocalService, getUserNotificationEventPersistence, getUserPersistence, getUserService, getUserTrackerLocalService, getUserTrackerPathLocalService, getUserTrackerPathPersistence, getUserTrackerPersistence, getVirtualHostLocalService, getVirtualHostPersistence, getWebDAVPropsLocalService, getWebDAVPropsPersistence, getWebsiteLocalService, getWebsitePersistence, getWebsiteService, getWikiNodeLocalService, getWikiNodePersistence, getWikiNodeService, getWorkflowDefinitionLinkLocalService, getWorkflowDefinitionLinkPersistence, getWorkflowInstanceLinkLocalService, getWorkflowInstanceLinkPersistence, hasOrganizationGroup, hasOrganizationGroups, hasPermissionGroup, hasPermissionGroups, hasRoleGroups, hasUserGroupGroup, hasUserGroupGroups, hasUserGroups, runSQL, setAccountLocalService, setAccountPersistence, setAccountService, setAddressLocalService, setAddressPersistence, setAddressService, setAssetEntryFinder, setAssetEntryLocalService, setAssetEntryPersistence, setAssetEntryService, setAssetVocabularyFinder, setAssetVocabularyLocalService, setAssetVocabularyPersistence, setAssetVocabularyService, setBeanIdentifier, setBlogsEntryFinder, setBlogsEntryLocalService, setBlogsEntryPersistence, setBlogsEntryService, setBlogsStatsUserFinder, setBlogsStatsUserLocalService, setBlogsStatsUserPersistence, setBookmarksFolderFinder, setBookmarksFolderLocalService, setBookmarksFolderPersistence, setBookmarksFolderService, setBrowserTrackerLocalService, setBrowserTrackerPersistence, setCalEventFinder, setCalEventLocalService, setCalEventPersistence, setCalEventService, setClassNameLocalService, setClassNamePersistence, setClassNameService, setClusterGroupLocalService, setClusterGroupPersistence, setCMISRepositoryLocalService, setCompanyLocalService, setCompanyPersistence, setCompanyService, setContactLocalService, setContactPersistence, setContactService, setCounterLocalService, setCountryPersistence, setCountryService, setDLAppLocalService, setDLAppService, setDLFileEntryTypeFinder, setDLFileEntryTypeLocalService, setDLFileEntryTypePersistence, setDLFileEntryTypeService, setEmailAddressLocalService, setEmailAddressPersistence, setEmailAddressService, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setImageLocalService, setImagePersistence, setImageService, setJournalArticleFinder, setJournalArticleLocalService, setJournalArticlePersistence, setJournalArticleService, setJournalStructureFinder, setJournalStructureLocalService, setJournalStructurePersistence, setJournalStructureService, setJournalTemplateFinder, setJournalTemplateLocalService, setJournalTemplatePersistence, setJournalTemplateService, setLayoutBranchLocalService, setLayoutBranchPersistence, setLayoutBranchService, setLayoutFinder, setLayoutLocalService, setLayoutPersistence, setLayoutPrototypeLocalService, setLayoutPrototypePersistence, setLayoutPrototypeService, setLayoutRevisionLocalService, setLayoutRevisionPersistence, setLayoutRevisionService, setLayoutService, setLayoutSetBranchLocalService, setLayoutSetBranchPersistence, setLayoutSetBranchService, setLayoutSetLocalService, setLayoutSetPersistence, setLayoutSetPrototypeLocalService, setLayoutSetPrototypePersistence, setLayoutSetPrototypeService, setLayoutSetService, setLayoutTemplateLocalService, setListTypePersistence, setListTypeService, setLockFinder, setLockLocalService, setLockPersistence, setMBBanLocalService, setMBBanPersistence, setMBBanService, setMBCategoryFinder, setMBCategoryLocalService, setMBCategoryPersistence, setMBCategoryService, setMBStatsUserLocalService, setMBStatsUserPersistence, setMBThreadFinder, setMBThreadLocalService, setMBThreadPersistence, setMBThreadService, setMembershipRequestLocalService, setMembershipRequestPersistence, setMembershipRequestService, setOrganizationFinder, setOrganizationGroups, setOrganizationLocalService, setOrganizationPersistence, setOrganizationService, setOrgGroupPermissionFinder, setOrgGroupPermissionPersistence, setOrgGroupRolePersistence, setOrgLaborLocalService, setOrgLaborPersistence, setOrgLaborService, setPasswordPolicyFinder, setPasswordPolicyLocalService, setPasswordPolicyPersistence, setPasswordPolicyRelLocalService, setPasswordPolicyRelPersistence, setPasswordPolicyService, setPasswordTrackerLocalService, setPasswordTrackerPersistence, setPermissionFinder, setPermissionGroups, setPermissionLocalService, setPermissionPersistence, setPermissionService, setPhoneLocalService, setPhonePersistence, setPhoneService, setPluginSettingLocalService, setPluginSettingPersistence, setPluginSettingService, setPollsQuestionLocalService, setPollsQuestionPersistence, setPollsQuestionService, setPortalLocalService, setPortalPreferencesLocalService, setPortalPreferencesPersistence, setPortalService, setPortletItemLocalService, setPortletItemPersistence, setPortletLocalService, setPortletPersistence, setPortletPreferencesFinder, setPortletPreferencesLocalService, setPortletPreferencesPersistence, setPortletPreferencesService, setPortletService, setQuartzLocalService, setRegionPersistence, setRegionService, setReleaseLocalService, setReleasePersistence, setRepositoryEntryLocalService, setRepositoryEntryPersistence, setRepositoryLocalService, setRepositoryPersistence, setRepositoryService, setResourceActionLocalService, setResourceActionPersistence, setResourceBlockFinder, setResourceBlockLocalService, setResourceBlockPermissionLocalService, setResourceBlockPermissionPersistence, setResourceBlockPersistence, setResourceBlockService, setResourceCodeLocalService, setResourceCodePersistence, setResourceFinder, setResourceLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setResourcePermissionService, setResourcePersistence, setResourceService, setResourceTypePermissionFinder, setResourceTypePermissionLocalService, setResourceTypePermissionPersistence, setRoleFinder, setRoleLocalService, setRolePersistence, setRoleService, setSCFrameworkVersionLocalService, setSCFrameworkVersionPersistence, setSCFrameworkVersionService, setSCProductEntryLocalService, setSCProductEntryPersistence, setSCProductEntryService, setServiceComponentLocalService, setServiceComponentPersistence, setShardLocalService, setShardPersistence, setShoppingCartLocalService, setShoppingCartPersistence, setShoppingCategoryLocalService, setShoppingCategoryPersistence, setShoppingCategoryService, setShoppingCouponFinder, setShoppingCouponLocalService, setShoppingCouponPersistence, setShoppingCouponService, setShoppingOrderFinder, setShoppingOrderLocalService, setShoppingOrderPersistence, setShoppingOrderService, setSubscriptionLocalService, setSubscriptionPersistence, setTeamFinder, setTeamLocalService, setTeamPersistence, setTeamService, setThemeLocalService, setThemeService, setTicketLocalService, setTicketPersistence, setUserFinder, setUserGroupFinder, setUserGroupGroupRoleLocalService, setUserGroupGroupRolePersistence, setUserGroupGroupRoleService, setUserGroupGroups, setUserGroupLocalService, setUserGroupPersistence, setUserGroupRoleFinder, setUserGroupRoleLocalService, setUserGroupRolePersistence, setUserGroupRoleService, setUserGroups, setUserGroupService, setUserIdMapperLocalService, setUserIdMapperPersistence, setUserLocalService, setUserNotificationEventLocalService, setUserNotificationEventPersistence, setUserPersistence, setUserService, setUserTrackerLocalService, setUserTrackerPathLocalService, setUserTrackerPathPersistence, setUserTrackerPersistence, setVirtualHostLocalService, setVirtualHostPersistence, setWebDAVPropsLocalService, setWebDAVPropsPersistence, setWebsiteLocalService, setWebsitePersistence, setWebsiteService, setWikiNodeLocalService, setWikiNodePersistence, setWikiNodeService, setWorkflowDefinitionLinkLocalService, setWorkflowDefinitionLinkPersistence, setWorkflowInstanceLinkLocalService, setWorkflowInstanceLinkPersistence, updateGroup, updateGroup

Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl

getClassLoader

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

publicLARFile

protected File publicLARFile

Constructor Detail

GroupLocalServiceImpl

public GroupLocalServiceImpl()

Constructs a group local service.

Method Detail

addGroup

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

Adds a group.

Parameters:

userId - the primary key of the group's creator/owner

className - the entity's class name

classPK - the primary key of the entity's instance

liveGroupId - the primary key of the live group

name - the entity's name

description - the group's description (optionally null)

type - the group's type. For more information see GroupConstants

friendlyURL - the group's friendlyURL (optionally null)

site - whether the group is to be associated with a main site

active - whether the group is active

serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and whether the group is for staging.

Returns:

the group

Throws:

PortalException - if a creator could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group

SystemException - if a system exception occurred

addGroup

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

Adds the group using the default live group.

Parameters:

userId - the primary key of the group's creator/owner

className - the entity's class name

classPK - the primary key of the entity's instance

name - the entity's name

description - the group's description (optionally null)

type - the group's type. For more information see GroupConstants

friendlyURL - the group's friendlyURL

site - whether the group is to be associated with a main site

active - whether the group is active

serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and whether the group is for staging.

Returns:

the group

Throws:

PortalException - if a creator could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group

SystemException - if a system exception occurred

addRoleGroups

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

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

Throws:

SystemException - if a system exception occurred

addUserGroups

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

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

Throws:

SystemException - if a system exception occurred

checkCompanyGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
public void checkCompanyGroup(long companyId)
                       throws PortalException,
                              SystemException

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

Parameters:

companyId - the primary key of the company

Throws:

PortalException - if a default user for the company could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group

SystemException - if a system exception occurred

checkSystemGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
public void checkSystemGroups(long companyId)
                       throws PortalException,
                              SystemException

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

Parameters:

companyId - the primary key of the company

Throws:

PortalException - if a new system group could not be created

SystemException - if a system exception occurred

deleteGroup

public Group deleteGroup(Group group)
                  throws PortalException,
                         SystemException

Deletes the group and its associated data.

The group is unstaged and its assets and resources including layouts, membership requests, subscriptions, teams, blogs, bookmarks, calendar events, image gallery, journals, message boards, polls, shopping related entities, software catalog, 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 the group was a system group, or if the user did not have permission to delete the group or its assets or its resources

SystemException - if a system exception occurred

deleteGroup

public Group deleteGroup(long groupId)
                  throws PortalException,
                         SystemException

Deletes the group and its associated data.

The group is unstaged and its assets and resources including layouts, membership requests, subscriptions, teams, blogs, bookmarks, calendar events, image gallery, journals, message boards, polls, shopping related entities, software catalog, 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 group with the primary key could not be found, if the group was a system group, or if the user did not have permission to delete the group, its assets, or its resources

SystemException - if a system exception occurred

fetchFriendlyURLGroup

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

Returns the group with the matching friendly URL.

Parameters:

companyId - the primary key of the company

friendlyURL - the friendly URL

Returns:

the group with the friendly URL, or null if a matching group could not be found

Throws:

SystemException - if a system exception occurred

fetchGroup

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

Returns the group with the matching group name.

Parameters:

companyId - the primary key of the company

name - the group's name

Returns:

the group with the name and associated company, or null if a matching group could not be found

Throws:

SystemException - if a system exception occurred

getCompanyGroup

public Group getCompanyGroup(long companyId)
                      throws PortalException,
                             SystemException

Returns the company group.

Parameters:

companyId - the primary key of the company

Returns:

the group associated with the company

Throws:

PortalException - if a matching group could not be found

SystemException - if a system exception occurred

getCompanyGroups

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

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

Throws:

SystemException - if a system exception occurred

getCompanyGroupsCount

public int getCompanyGroupsCount(long companyId)
                          throws SystemException

Returns the number of groups associated with the company.

Parameters:

companyId - the primary key of the company

Returns:

the number of groups associated with the company

Throws:

SystemException - if a system exception occurred

getFriendlyURLGroup

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

Returns the group with the matching friendly URL.

Parameters:

companyId - the primary key of the company

friendlyURL - the group's friendlyURL

Returns:

the group with the friendly URL

Throws:

PortalException - if a matching group could not be found, or if the friendly URL was invalid

SystemException - if a system exception occurred

getGroup

@ThreadLocalCachable
public Group getGroup(long groupId)
               throws PortalException,
                      SystemException

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 group with the primary key could not be found

SystemException - if a system exception occurred

getGroup

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

Returns the group with the matching group name.

Parameters:

companyId - the primary key of the company

name - the group's name

Returns:

the group with the name

Throws:

PortalException - if a matching group could not be found

SystemException - if a system exception occurred

getGroupDescriptiveName

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

Throws:

PortalException

SystemException

getGroupDescriptiveName

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

Throws:

PortalException

SystemException

getGroups

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

Returns the groups with the matching primary keys.

Parameters:

groupIds - the primary keys of the groups

Returns:

the groups with the primary keys

Throws:

PortalException - if any one of the groups could not be found

SystemException - if a system exception occurred

getLayoutGroup

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

Returns the group associated with the layout.

Parameters:

companyId - the primary key of the company

plid - the primary key of the layout

Returns:

the group associated with the layout

Throws:

PortalException - if a matching group could not be found

SystemException - if a system exception occurred

getLayoutPrototypeGroup

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

Returns the group associated with the layout prototype.

Parameters:

companyId - the primary key of the company

layoutPrototypeId - the primary key of the layout prototype

Returns:

the group associated with the layout prototype

Throws:

PortalException - if a matching group could not be found

SystemException - if a system exception occurred

getLayoutSetPrototypeGroup

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

Returns the group associated with the layout set prototype.

Parameters:

companyId - the primary key of the company

layoutSetPrototypeId - the primary key of the layout set prototype

Returns:

the group associated with the layout set prototype

Throws:

PortalException - if a matching group could not be found

SystemException - if a system exception occurred

getLiveGroups

public List<Group> getLiveGroups()
                          throws SystemException

Returns all live groups.

Returns:

all live groups

Throws:

SystemException - if a system exception occurred

getNoLayoutsGroups

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

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

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

Throws:

SystemException - if a system exception occurred

getNullFriendlyURLGroups

public List<Group> getNullFriendlyURLGroups()
                                     throws SystemException

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

Returns:

the non-system groups having null or empty friendly URLs

Throws:

SystemException - if a system exception occurred

getOrganizationGroup

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

Returns the specified organization group.

Parameters:

companyId - the primary key of the company

organizationId - the primary key of the organization

Returns:

the group associated with the organization

Throws:

PortalException - if a matching group could not be found

SystemException - if a system exception occurred

getOrganizationsGroups

public 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)
                                          throws SystemException

Returns all the groups related to the organizations.

Parameters:

organizations - the organizations

Returns:

the groups related to the organizations

Throws:

SystemException - if a system exception occurred

getRoleGroups

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

Returns all the groups associated with the role.

Specified by:

getRoleGroups in interface GroupLocalService

Overrides:

getRoleGroups in class GroupLocalServiceBaseImpl

Parameters:

roleId - the primary key of the role

Returns:

the groups associated with the role

Throws:

SystemException - if a system exception occurred

getStagingGroup

public Group getStagingGroup(long liveGroupId)
                      throws PortalException,
                             SystemException

Returns the staging group.

Parameters:

liveGroupId - the primary key of the live group

Returns:

the staging group

Throws:

PortalException - if a matching staging group could not be found

SystemException - if a system exception occurred

getUserGroup

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

Returns the group associated with the user.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

Returns:

the group associated with the user

Throws:

PortalException - if a matching group could not be found

SystemException - if a system exception occurred

getUserGroupGroup

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

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

Parameters:

companyId - the primary key of the company

userGroupId - the primary key of the user group

Returns:

the group associated with the user group

Throws:

PortalException - if a matching group could not be found

SystemException - if a system exception occurred

getUserGroups

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

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

Specified by:

getUserGroups in interface GroupLocalService

Overrides:

getUserGroups in class GroupLocalServiceBaseImpl

Parameters:

userId - the primary key of the user

Returns:

the user's groups and organization groups

Throws:

PortalException - if a user with the primary key could not be found

SystemException - if a system exception occurred

getUserGroups

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

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

Parameters:

userId - the primary key of the user

inherit - whether to include the user's inherited organization groups and user groups

Returns:

the user's groups and immediate organization groups

Throws:

PortalException - if a user with the primary key could not be found

SystemException - if a system exception occurred

getUserGroups

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

Returns a name 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 user with the primary key could not be found

SystemException - if a system exception occurred

getUserGroups

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

Returns a name ordered range of all the user's site groups and immediate organization 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.

Specified by:

getUserGroups in interface GroupLocalService

Overrides:

getUserGroups in class GroupLocalServiceBaseImpl

Parameters:

userId - the primary key of the user

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 organization groups ordered by name

Throws:

PortalException - if a user with the primary key could not be found

SystemException - if a system exception occurred

getUserGroupsGroups

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

Returns the groups associated with the user groups.

Parameters:

userGroups - the user groups

Returns:

the groups associated with the user groups

Throws:

PortalException - if any one of the user group's group could not be found

SystemException - if a system exception occurred

getUserGroupsRelatedGroups

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

Returns all the groups related to the user groups.

Parameters:

userGroups - the user groups

Returns:

the groups related to the user groups

Throws:

SystemException - if a system exception occurred

getUserOrganizationsGroups

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

Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property organizations.membership.strict is set to true.

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 user with the primary key could not be found or if another portal exception occurred

SystemException - if a system exception occurred

hasRoleGroup

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

Returns true if the group is associated with the role.

Specified by:

hasRoleGroup in interface GroupLocalService

Overrides:

hasRoleGroup in class GroupLocalServiceBaseImpl

Parameters:

roleId - the primary key of the role

groupId - the primary key of the group

Returns:

true if the group is associated with the role; false otherwise

Throws:

SystemException - if a system exception occurred

hasStagingGroup

public boolean hasStagingGroup(long liveGroupId)
                        throws SystemException

Returns true if the live group has a staging group.

Parameters:

liveGroupId - the primary key of the live group

Returns:

true if the live group has a staging group; false otherwise

Throws:

SystemException - if a system exception occurred

hasUserGroup

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

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

Throws:

SystemException - if a system exception occurred

hasUserGroup

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

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

Parameters:

userId - the primary key of the user

groupId - the primary key of the group

inherit - whether to include organization groups and user groups to which the user belongs in the determination

Returns:

true if the user is associated with the group; false otherwise

Throws:

SystemException - if a system exception occurred

loadFetchGroup

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

Throws:

SystemException

loadGetGroup

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

Throws:

PortalException

SystemException

search

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

Throws:

SystemException

search

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

Returns a name 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 class names of entities to include in the search (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 com.liferay.portal.service.persistence.GroupFinder}

start - the lower bound of the range of groups to return

end - the upper bound of the range of groups to return (not inclusive)

Returns:

the matching groups ordered by name

Throws:

SystemException - if a system exception occurred

search

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

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

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 group's class name IDs (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

start - the lower bound of the range of groups to return

end - the upper bound of the range of groups to return (not inclusive)

obc - the comparator to order the groups (optionally null)

Returns:

the matching groups ordered by comparator obc

Throws:

SystemException - if a system exception occurred

search

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

Returns a name 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

start - the lower bound of the range of groups to return

end - the upper bound of the range of groups to return (not inclusive)

Returns:

the matching groups ordered by name

Throws:

SystemException - if a system exception occurred

search

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

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

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

start - the lower bound of the range of groups to return

end - the upper bound of the range of groups to return (not inclusive)

obc - the comparator to order the groups (optionally null)

Returns:

the matching groups ordered by comparator obc

Throws:

SystemException - if a system exception occurred

searchCount

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

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

Parameters:

companyId - the primary key of the company

classNameIds - the class names of entities to include in the search (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

Returns:

the number of matching groups

Throws:

SystemException - if a system exception occurred

searchCount

@ThreadLocalCachable
public int searchCount(long companyId,
                                           String name,
                                           String description,
                                           LinkedHashMap<String,Object> params)
                throws SystemException

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

Parameters:

companyId - the primary key of the company

name - the group's name (optionally null)

description - the group's description (optionally null)

params - the finder params (optionally null). To include the user's inherited organization groups and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder

Returns:

the number of matching groups

Throws:

SystemException - if a system exception occurred

setRoleGroups

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

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

Throws:

SystemException - if a system exception occurred

unsetRoleGroups

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

Removes the groups from the role.

Parameters:

roleId - the primary key of the role

groupIds - the primary keys of the groups

Throws:

SystemException - if a system exception occurred

unsetUserGroups

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

Removes the user from the groups.

Parameters:

userId - the primary key of the user

groupIds - the primary keys of the groups

Throws:

SystemException - if a system exception occurred

updateAsset

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

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

Parameters:

userId - the primary key of the user

group - the group

assetCategoryIds - the primary keys of the asset categories (optionally null)

assetTagNames - the asset tag names (optionally null)

Throws:

PortalException - if a user with the primary key could not be found

SystemException - if a system exception occurred

updateFriendlyURL

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

Updates the group's friendly URL.

Parameters:

groupId - the primary key of the group

friendlyURL - the group's new friendlyURL (optionally null)

Returns:

the group

Throws:

PortalException - if a group with the primary key could not be found or if a valid friendly URL could not be created for the group

SystemException - if a system exception occurred

updateGroup

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

Updates the group's type settings.

Parameters:

groupId - the primary key of the group

typeSettings - the group's new type settings (optionally null)

Returns:

the group

Throws:

PortalException - if a group with the primary key could not be found

SystemException - if a system exception occurred

updateGroup

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

Updates the group.

Parameters:

groupId - the primary key of the group

name - the group's new name

description - the group's new description (optionally null)

type - the group's new type. For more information see GroupConstants

friendlyURL - the group's new friendlyURL (optionally null)

active - whether the group is active

serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group.

Returns:

the group

Throws:

PortalException - if a group with the primary key could not be found or if the friendly URL was invalid or could one not be created

SystemException - if a system exception occurred

updateSite

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

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

Parameters:

groupId - the primary key of the group

site - whether the group is to be associated with a main site

Returns:

the group

Throws:

PortalException - if a group with the primary key could not be found

SystemException - if a system exception occurred

addControlPanelLayouts

protected void addControlPanelLayouts(Group group)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

addDefaultGuestPublicLayoutByProperties

protected void addDefaultGuestPublicLayoutByProperties(Group group)
                                                throws PortalException,
                                                       SystemException

Throws:

PortalException

SystemException

addDefaultGuestPublicLayouts

protected void addDefaultGuestPublicLayouts(Group group)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

addDefaultGuestPublicLayoutsByLAR

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

Throws:

PortalException

SystemException

deletePortletData

protected void deletePortletData(Group group)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getFriendlyURL

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

Throws:

PortalException

SystemException

getFriendlyURL

protected String getFriendlyURL(String friendlyURL)

getOrgGroupName

protected String getOrgGroupName(String name)

getRealName

protected String getRealName(long companyId,
                             String name)
                      throws SystemException

Throws:

SystemException

initImportLARFile

protected void initImportLARFile()

initUserPersonalSitePermissions

protected void initUserPersonalSitePermissions(Group group)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

isStaging

protected boolean isStaging(ServiceContext serviceContext)

setCompanyPermissions

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

Throws:

PortalException

SystemException

setRolePermissions

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

Throws:

PortalException

SystemException

setRolePermissions

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

Throws:

PortalException

SystemException

unscheduleStaging

protected void unscheduleStaging(Group group)

validateFriendlyURL

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

Throws:

PortalException

SystemException

validateName

protected void validateName(long groupId,
                            long companyId,
                            String name,
                            boolean site)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException