com.liferay.portal.service.impl
Class GroupServiceImpl
java.lang.Object
com.liferay.portal.service.BaseServiceImpl
com.liferay.portal.service.base.GroupServiceBaseImpl
com.liferay.portal.service.impl.GroupServiceImpl
- All Implemented Interfaces:
- IdentifiableBean, BaseService, GroupService
public class GroupServiceImpl
- extends GroupServiceBaseImpl
The group remote service is responsible for accessing, creating, modifying
and deleting groups. For more information on group services and Group, see
GroupLocalServiceImpl
.
Fields inherited from class com.liferay.portal.service.base.GroupServiceBaseImpl |
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, 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 |
Method Summary |
Group |
addGroup(long liveGroupId,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Adds a group. |
Group |
addGroup(String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Adds the group using the group default live group ID. |
void |
addRoleGroups(long roleId,
long[] groupIds)
Adds the groups to the role. |
void |
deleteGroup(long groupId)
Deletes the group. |
protected List<Group> |
filterGroups(List<Group> groups)
|
Group |
getGroup(long groupId)
Returns the group with the primary key. |
Group |
getGroup(long companyId,
String name)
Returns the group with the name. |
List<Group> |
getManageableSites(Collection<Portlet> portlets,
int max)
Returns a range of all the site groups for which the user has control
panel access. |
List<Group> |
getOrganizationsGroups(List<Organization> organizations)
Returns the groups associated with the organizations. |
Group |
getUserGroup(long companyId,
long userId)
Returns the group associated with the user. |
List<Group> |
getUserGroupsGroups(List<UserGroup> userGroups)
Returns the groups associated with 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 . |
List<Group> |
getUserPlaces(long userId,
String[] classNames,
boolean includeControlPanel,
int max)
|
List<Group> |
getUserPlaces(long userId,
String[] classNames,
int max)
Returns the user's group "places" associated with the group
entity class names, including the control panel group if the user is
permitted to view the control panel. |
List<Group> |
getUserPlaces(String[] classNames,
int max)
Returns the guest or current user's group "places" associated
with the group entity class names, including the control panel group if
the user is permitted to view the control panel. |
List<Group> |
getUserSites()
Returns the guest or current user's layout set group, organization
groups, inherited organization groups, and site groups. |
boolean |
hasUserGroup(long userId,
long groupId)
Returns true if the user is associated with the group,
including the user's inherited organizations and user groups. |
List<Group> |
search(long companyId,
String name,
String description,
String[] 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. |
int |
searchCount(long companyId,
String name,
String description,
String[] params)
Returns the number of groups and organization groups that match the name
and description, optionally including the user's inherited organizations
and user groups. |
void |
setRoleGroups(long roleId,
long[] groupIds)
Sets the groups associated with the role, removing and adding
associations as necessary. |
void |
unsetRoleGroups(long roleId,
long[] groupIds)
Removes the groups from the role. |
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. |
Methods inherited from class com.liferay.portal.service.base.GroupServiceBaseImpl |
afterPropertiesSet, destroy, 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, 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, getOrganizationLocalService, getOrganizationPersistence, getOrganizationService, getOrgGroupPermissionFinder, getOrgGroupPermissionPersistence, getOrgGroupRolePersistence, getOrgLaborLocalService, getOrgLaborPersistence, getOrgLaborService, getPasswordPolicyFinder, getPasswordPolicyLocalService, getPasswordPolicyPersistence, getPasswordPolicyRelLocalService, getPasswordPolicyRelPersistence, getPasswordPolicyService, getPasswordTrackerLocalService, getPasswordTrackerPersistence, getPermissionFinder, getPermissionLocalService, getPermissionPersistence, getPermissionService, 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, 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, getUserGroupLocalService, getUserGroupPersistence, getUserGroupRoleFinder, getUserGroupRoleLocalService, getUserGroupRolePersistence, getUserGroupRoleService, 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, 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, setOrganizationLocalService, setOrganizationPersistence, setOrganizationService, setOrgGroupPermissionFinder, setOrgGroupPermissionPersistence, setOrgGroupRolePersistence, setOrgLaborLocalService, setOrgLaborPersistence, setOrgLaborService, setPasswordPolicyFinder, setPasswordPolicyLocalService, setPasswordPolicyPersistence, setPasswordPolicyRelLocalService, setPasswordPolicyRelPersistence, setPasswordPolicyService, setPasswordTrackerLocalService, setPasswordTrackerPersistence, setPermissionFinder, 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, setUserGroupLocalService, setUserGroupPersistence, setUserGroupRoleFinder, setUserGroupRoleLocalService, setUserGroupRolePersistence, setUserGroupRoleService, 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 |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
GroupServiceImpl
public GroupServiceImpl()
addGroup
public Group addGroup(long liveGroupId,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Adds a group.
- Parameters:
liveGroupId
- the primary key of the live groupname
- the entity's namedescription
- 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 siteactive
- whether the group is activeserviceContext
- the service context to be applied (optionally
null
). Can set the asset category IDs and asset tag
names for the group, and can set whether the group is for staging
- Returns:
- the group
- Throws:
PortalException
- if the user did not have permission to add the
group, 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(String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Adds the group using the group default live group ID.
- Parameters:
name
- the entity's namedescription
- the group's description (optionally
null
)type
- the group's type. For more information see GroupConstants
friendlyURL
- the group's friendlyURLsite
- whether the group is to be associated with a main siteactive
- whether the group is activeserviceContext
- the service context to be applied (optionally
null
). Can set asset category IDs and asset tag
names for the group, and can set whether the group is for staging
- Returns:
- the group
- Throws:
PortalException
- if the user did not have permission to add the
group, 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 PortalException,
SystemException
- Adds the groups to the role.
- Parameters:
roleId
- the primary key of the rolegroupIds
- the primary keys of the groups
- Throws:
PortalException
- if the user did not have permission to update the
role
SystemException
- if a system exception occurred
deleteGroup
public void deleteGroup(long groupId)
throws PortalException,
SystemException
- Deletes the group.
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.
- Parameters:
groupId
- the primary key of the group
- Throws:
PortalException
- if the user did not have permission to delete the
group or its assets or resources, if a group with the primary key
could not be found, or if the group was a system group
SystemException
- if a system exception occurred
getGroup
public Group getGroup(long groupId)
throws PortalException,
SystemException
- Returns the group with the primary key.
- Parameters:
groupId
- the primary key of the group
- Returns:
- the group with the primary key
- Throws:
PortalException
- if a group with the primary key could not be
found or if the current user did not have permission to view the
group
SystemException
- if a system exception occurred
getGroup
public Group getGroup(long companyId,
String name)
throws PortalException,
SystemException
- Returns the group with the name.
- Parameters:
companyId
- the primary key of the companyname
- the group's name
- Returns:
- the group with the name
- Throws:
PortalException
- if a matching group could not be found or if the
current user did not have permission to view the group
SystemException
- if a system exception occurred
getManageableSites
public List<Group> getManageableSites(Collection<Portlet> portlets,
int max)
throws PortalException,
SystemException
- Returns a range of all the site groups for which the user has control
panel access.
- Parameters:
portlets
- the portlets to managemax
- the upper bound of the range of groups to consider (not
inclusive)
- Returns:
- the range of site groups for which the user has control panel
access
- Throws:
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred
getOrganizationsGroups
public List<Group> getOrganizationsGroups(List<Organization> organizations)
throws PortalException,
SystemException
- Returns the groups associated with the organizations.
- Parameters:
organizations
- the organizations
- Returns:
- the groups associated with the organizations
- Throws:
PortalException
- if a portal exception occurred
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 companyuserId
- the primary key of the user
- Returns:
- the group associated with the user
- Throws:
PortalException
- if a matching group could not be found or if the
current user did not have permission to view the group
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
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 userstart
- the lower bound of the range of groups to considerend
- the upper bound of the range of groups to consider (not
inclusive)
- Returns:
- the range of groups associated with the user's organizations
- 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
getUserPlaces
public List<Group> getUserPlaces(long userId,
String[] classNames,
boolean includeControlPanel,
int max)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getUserPlaces
public List<Group> getUserPlaces(long userId,
String[] classNames,
int max)
throws PortalException,
SystemException
- Returns the user's group "places" associated with the group
entity class names, including the control panel group if the user is
permitted to view the control panel.
- Class name "User" includes the user's layout set
group.
- Class name "Organization" includes the user's
immediate organization groups and inherited organization groups.
- Class name "Group" includes the user's immediate
organization groups and site groups.
- A
classNames
value of null
includes the user's layout set group,
organization groups, inherited organization groups, and site groups.
- Parameters:
userId
- the primary key of the userclassNames
- the group entity class names (optionally
null
). For more information see getUserPlaces(long, String[], int)
max
- the maximum number of groups to return
- Returns:
- the user's group "places"
- Throws:
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred
getUserPlaces
public List<Group> getUserPlaces(String[] classNames,
int max)
throws PortalException,
SystemException
- Returns the guest or current user's group "places" associated
with the group entity class names, including the control panel group if
the user is permitted to view the control panel.
- Class name "User" includes the user's layout set
group.
- Class name "Organization" includes the user's
immediate organization groups and inherited organization groups.
- Class name "Group" includes the user's immediate
organization groups and site groups.
- A
classNames
value of null
includes the user's layout set group,
organization groups, inherited organization groups, and site groups.
- Parameters:
classNames
- the group entity class names (optionally
null
). For more information see getUserPlaces(String[], int)
max
- the maximum number of groups to return
- Returns:
- the user's group "places"
- Throws:
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred
getUserSites
public List<Group> getUserSites()
throws PortalException,
SystemException
- Returns the guest or current user's layout set group, organization
groups, inherited organization groups, and site groups.
- Returns:
- the user's layout set group, organization groups, and inherited
organization groups, and site groups
- Throws:
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred
hasUserGroup
public boolean hasUserGroup(long userId,
long groupId)
throws PortalException,
SystemException
- Returns
true
if the user is associated with the group,
including the user's inherited organizations and user groups. System and
staged groups are not included.
- Parameters:
userId
- the primary key of the usergroupId
- the primary key of the group
- Returns:
true
if the user is associated with the group;
false
otherwise
- Throws:
PortalException
- if the current user did not have permission to
view the user or group members
SystemException
- if a system exception occurred
search
public List<Group> search(long companyId,
String name,
String description,
String[] params,
int start,
int end)
throws PortalException,
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 companyname
- 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 returnend
- the upper bound of the range of groups to return (not
inclusive)
- Returns:
- the matching groups ordered by name
- Throws:
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurred
searchCount
public int searchCount(long companyId,
String name,
String description,
String[] params)
throws SystemException
- Returns the number of groups and organization groups that match the name
and description, optionally including the user's inherited organizations
and user groups. System and staged groups are not included.
- Parameters:
companyId
- the primary key of the companyname
- 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
- Returns:
- the number of matching groups
- Throws:
SystemException
- if a system exception occurred
setRoleGroups
public void setRoleGroups(long roleId,
long[] groupIds)
throws PortalException,
SystemException
- Sets the groups associated with the role, removing and adding
associations as necessary.
- Parameters:
roleId
- the primary key of the rolegroupIds
- the primary keys of the groups
- Throws:
PortalException
- if the user did not have permission to update
update the role
SystemException
- if a system exception occurred
unsetRoleGroups
public void unsetRoleGroups(long roleId,
long[] groupIds)
throws PortalException,
SystemException
- Removes the groups from the role.
- Parameters:
roleId
- the primary key of the rolegroupIds
- the primary keys of the groups
- Throws:
PortalException
- if the user did not have permission to update the
role
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 groupfriendlyURL
- the group's new friendlyURL (optionally
null
)
- Returns:
- the group
- Throws:
PortalException
- if the user did not have permission to update the
group, 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 grouptypeSettings
- the group's new type settings (optionally
null
)
- Returns:
- the group
- Throws:
PortalException
- if the user did not have permission to update the
group or 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 groupname
- the group's new namedescription
- 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 activeserviceContext
- the service context to be applied (optionally
null
). Can set the asset category IDs and asset tag
names for the group.
- Returns:
- the group
- Throws:
PortalException
- if the user did not have permission to update the
group, if a group with the primary key could not be found, if the
friendly URL was invalid or could one not be created
SystemException
- if a system exception occurred
filterGroups
protected List<Group> filterGroups(List<Group> groups)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException