|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.BaseLocalServiceImpl
com.liferay.portal.service.base.GroupLocalServiceBaseImpl
com.liferay.portal.service.impl.GroupLocalServiceImpl
public class GroupLocalServiceImpl
Provides the local service for accessing, adding, deleting, and updating groups. Groups are mostly used in Liferay as a resource container for permissioning and content scoping purposes.
Groups are also the entity to which LayoutSets are generally associated. Since LayoutSets are the parent entities of Layouts (i.e. pages), no entity can have associated pages without also having an associated Group. This relationship can be depicted as ... Layout -> LayoutSet -> Group[type] [-> Entity]. Note, the Entity part is optional.
Group has a "type" definition that is typically identified by two fields of
the entity - String className, and int type .
The className field helps create the group's association with
other entities (e.g. Organization, User, Company, UserGroup, ... etc.). The
value of className is the full name of the entity's class and
the primary key of the associated entity instance. A site has
className="Group" and has no associated entity.
The type field helps distinguish between a group used strictly
for scoping and a group that also has pages (in which case the type is
SITE). For a list of types, see GroupConstants.
Here is a listing of how Group is related to some portal entities ...
className="Group"
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
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
GroupImpl| Field Summary | |
|---|---|
static String |
ORGANIZATION_NAME_SUFFIX
|
static String |
ORGANIZATION_STAGING_SUFFIX
|
protected File |
publicLARFile
|
| Constructor Summary | |
|---|---|
GroupLocalServiceImpl()
Constructs a group local service. |
|
| Method Summary | |
|---|---|
protected void |
addControlPanelLayouts(Group group)
|
protected void |
addDefaultGuestPublicLayoutByProperties(Group group)
|
protected void |
addDefaultGuestPublicLayouts(Group group)
|
protected void |
addDefaultGuestPublicLayoutsByLAR(Group group,
File larFile)
|
Group |
addGroup(long userId,
long parentGroupId,
String className,
long classPK,
long liveGroupId,
String name,
String description,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean site,
boolean inheritContent,
boolean active,
ServiceContext serviceContext)
|
Group |
addGroup(long userId,
long parentGroupId,
String className,
long classPK,
long liveGroupId,
String name,
String description,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Adds a group. |
Group |
addGroup(long userId,
long parentGroupId,
String className,
long classPK,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Deprecated. As of 6.2.0, replaced by addGroup(long, long, String,
long, long, String, String, int, boolean, int, String,
boolean, boolean, ServiceContext) |
Group |
addGroup(long userId,
String className,
long classPK,
long liveGroupId,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Deprecated. As of 6.2.0, replaced by addGroup(long, long, String,
long, long, String, String, int, boolean, int, String,
boolean, boolean, ServiceContext) |
Group |
addGroup(long userId,
String className,
long classPK,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Deprecated. As of 6.2.0, replaced by addGroup(long, long, String,
long, long, String, String, int, boolean, int, String,
boolean, boolean, ServiceContext) |
protected void |
addPortletDefaultData(Group group)
|
void |
addRoleGroups(long roleId,
long[] groupIds)
Adds the groups to the role. |
void |
addUserGroups(long userId,
long[] groupIds)
Adds the user to the groups. |
void |
checkCompanyGroup(long companyId)
Adds a company group if it does not exist. |
void |
checkSystemGroups(long companyId)
Creates systems groups and other related data needed by the system on the very first startup. |
Group |
deleteGroup(Group group)
Deletes the group and its associated data. |
Group |
deleteGroup(long groupId)
Deletes the group and its associated data. |
protected void |
deletePortletData(Group group)
|
void |
disableStaging(long groupId)
|
protected Collection<Group> |
doSearch(long companyId,
long[] classNameIds,
long parentGroupId,
String[] names,
String[] descriptions,
LinkedHashMap<String,Object> params,
boolean andOperator)
|
void |
enableStaging(long groupId)
|
Group |
fetchCompanyGroup(long companyId)
Returns the company's group. |
Group |
fetchFriendlyURLGroup(long companyId,
String friendlyURL)
Returns the group with the matching friendly URL. |
Group |
fetchGroup(long companyId,
String name)
Returns the group with the matching group name by first searching the system groups and then using the finder cache. |
Group |
fetchUserGroup(long companyId,
long userId)
|
Group |
fetchUserPersonalSiteGroup(long companyId)
Returns the default user's personal site group. |
protected long[] |
getClassNameIds()
|
Group |
getCompanyGroup(long companyId)
Returns the company group. |
List<Group> |
getCompanyGroups(long companyId,
int start,
int end)
Returns a range of all the groups associated with the company. |
int |
getCompanyGroupsCount(long companyId)
Returns the number of groups associated with the company. |
protected String |
getFriendlyURL(long companyId,
long groupId,
long classNameId,
long classPK,
String friendlyName,
String friendlyURL)
|
protected String |
getFriendlyURL(String friendlyURL)
|
Group |
getFriendlyURLGroup(long companyId,
String friendlyURL)
Returns the group with the matching friendly URL. |
Group |
getGroup(long groupId)
Returns the group with the matching primary key. |
Group |
getGroup(long companyId,
String name)
Returns the group with the matching group name. |
String |
getGroupDescriptiveName(Group group,
Locale locale)
Deprecated. As of 7.0.0, replaced by {@link Group#getDescriptiveName(Locale) |
String |
getGroupDescriptiveName(long groupId,
Locale locale)
Deprecated. As of 7.0.0, replaced by {@link Group#getDescriptiveName(Locale) |
List<Group> |
getGroups(long[] groupIds)
Returns the groups with the matching primary keys. |
List<Group> |
getGroups(long companyId,
long parentGroupId,
boolean site)
Returns all the groups that are direct children of the parent group. |
List<Group> |
getGroups(long companyId,
long parentGroupId,
boolean site,
boolean inheritContent)
|
List<Group> |
getGroups(long companyId,
String className,
long parentGroupId)
Returns all the groups that are direct children of the parent group with the matching className. |
List<Group> |
getGroups(long companyId,
String className,
long parentGroupId,
int start,
int end)
Returns a range of all the groups that are direct children of the parent group with the matching className. |
int |
getGroupsCount(long companyId,
long parentGroupId,
boolean site)
Returns the number of groups that are direct children of the parent group. |
int |
getGroupsCount(long companyId,
String className,
long parentGroupId)
Returns the number of groups that are direct children of the parent group with the matching className. |
Group |
getLayoutGroup(long companyId,
long plid)
Returns the group associated with the layout. |
Group |
getLayoutPrototypeGroup(long companyId,
long layoutPrototypeId)
Returns the group associated with the layout prototype. |
Group |
getLayoutSetPrototypeGroup(long companyId,
long layoutSetPrototypeId)
Returns the group associated with the layout set prototype. |
List<Group> |
getLayoutsGroups(long companyId,
long parentGroupId,
boolean site,
int start,
int end)
Deprecated. As of 6.2.0, replaced by getLayoutsGroups(long, long,
boolean, int, int, OrderByComparator) |
List<Group> |
getLayoutsGroups(long companyId,
long parentGroupId,
boolean site,
int start,
int end,
OrderByComparator<Group> obc)
Returns a range of all groups that are children of the parent group and that have at least one layout. |
int |
getLayoutsGroupsCount(long companyId,
long parentGroupId,
boolean site)
Returns the number of groups that are children or the parent group and that have at least one layout |
List<Group> |
getLiveGroups()
Returns all live groups. |
List<Group> |
getNoLayoutsGroups(String className,
boolean privateLayout,
int start,
int end)
Returns a range of all non-system groups of a specified type (className) that have no layouts. |
List<Group> |
getNullFriendlyURLGroups()
Returns all non-system groups having null or empty friendly
URLs. |
Group |
getOrganizationGroup(long companyId,
long organizationId)
Returns the specified organization group. |
List<Group> |
getOrganizationsGroups(List<Organization> organizations)
Returns the specified organization groups. |
List<Group> |
getOrganizationsRelatedGroups(List<Organization> organizations)
Returns all the groups related to the organizations. |
protected String |
getOrgGroupName(String name)
|
List<Group> |
getParentGroups(long groupId)
Returns the group followed by all its parent groups ordered by closest ancestor. |
protected List<PortletDataHandler> |
getPortletDataHandlers(Group group)
|
protected String[] |
getSearchNames(long companyId,
String name)
|
Group |
getStagingGroup(long liveGroupId)
Returns the staging group. |
Group |
getUserGroup(long companyId,
long userId)
Returns the group associated with the user. |
Group |
getUserGroupGroup(long companyId,
long userGroupId)
Returns the specified "user group" group. |
List<Group> |
getUserGroups(long userId,
boolean inherit)
Returns all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups. |
List<Group> |
getUserGroups(long userId,
boolean inherit,
int start,
int end)
Returns an ordered range of all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups. |
List<Group> |
getUserGroupsGroups(List<UserGroup> userGroups)
Returns the groups associated with the user groups. |
List<Group> |
getUserGroupsRelatedGroups(List<UserGroup> userGroups)
Returns all the groups related to the user groups. |
List<Group> |
getUserOrganizationsGroups(long userId,
int start,
int end)
Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property organizations.membership.strict is set to
true. |
Group |
getUserPersonalSiteGroup(long companyId)
Returns the default user's personal site group. |
List<Group> |
getUserSitesGroups(long userId)
|
List<Group> |
getUserSitesGroups(long userId,
boolean includeAdministrative)
|
boolean |
hasStagingGroup(long liveGroupId)
Returns true if the live group has a staging group. |
boolean |
hasUserGroup(long userId,
long groupId)
Returns true if the user is immediately associated with the
group, or associated with the group via the user's organizations,
inherited organizations, or user groups. |
boolean |
hasUserGroup(long userId,
long groupId,
boolean inherit)
Returns true if the user is immediately associated with the
group, or optionally if the user is associated with the group via the
user's organizations, inherited organizations, or user groups. |
protected void |
initImportLARFile()
|
protected void |
initUserPersonalSitePermissions(Group group)
|
protected boolean |
isParentGroup(long parentGroupId,
long groupId)
|
protected boolean |
isStaging(ServiceContext serviceContext)
|
protected boolean |
isUseComplexSQL(long[] classNameIds)
|
Group |
loadFetchGroup(long companyId,
String name)
Returns the group with the matching group name by first searching the system groups and then using the finder cache. |
Group |
loadGetGroup(long companyId,
String name)
Returns the group with the matching group name. |
protected boolean |
matches(String s,
String[] keywords)
|
void |
rebuildTree(long companyId)
Rebuilds the group tree. |
List<Group> |
search(long companyId,
LinkedHashMap<String,Object> params,
int start,
int end)
Returns an ordered range of all the company's groups, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups belonging to the parent group that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups that match the class name IDs and keywords, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the site groups belonging to the parent group and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the groups that match the keywords, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. |
List<Group> |
search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
Returns an ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. |
int |
searchCount(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params)
Returns the number of groups belonging to the parent group that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. |
int |
searchCount(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
Returns the number of groups belonging to the parent group that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. |
int |
searchCount(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params)
Returns the number of groups that match the class name IDs, and keywords, optionally including the user's inherited organization groups and user groups. |
int |
searchCount(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
Returns the number of groups that match the class name IDs, name, and description, optionally including the user's inherited organization groups and user groups. |
int |
searchCount(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params)
Returns the number of groups belonging to the parent group that match the keywords, optionally including the user's inherited organization groups and user groups. |
int |
searchCount(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
Returns the number of groups belonging to the parent group and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. |
int |
searchCount(long companyId,
String keywords,
LinkedHashMap<String,Object> params)
Returns the number of groups that match the keywords, optionally including the user's inherited organization groups and user groups. |
int |
searchCount(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
Returns the number of groups and immediate organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. |
protected void |
setCompanyPermissions(Role role,
String name,
String[] actionIds)
|
void |
setRoleGroups(long roleId,
long[] groupIds)
Sets the groups associated with the role, removing and adding associations as necessary. |
protected void |
setRolePermissions(Group group,
Role role,
String name)
|
protected void |
setRolePermissions(Group group,
Role role,
String name,
String[] actionIds)
|
protected List<Group> |
sort(Collection<Group> groups,
int start,
int end,
OrderByComparator<Group> obc)
|
protected void |
unscheduleStaging(Group group)
|
void |
unsetRoleGroups(long roleId,
long[] groupIds)
Removes the groups from the role. |
void |
unsetUserGroups(long userId,
long[] groupIds)
Removes the user from the groups. |
void |
updateAsset(long userId,
Group group,
long[] assetCategoryIds,
String[] assetTagNames)
Updates the group's asset replacing categories and tag names. |
Group |
updateFriendlyURL(long groupId,
String friendlyURL)
Updates the group's friendly URL. |
Group |
updateGroup(long groupId,
long parentGroupId,
String name,
String description,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean inheritContent,
boolean active,
ServiceContext serviceContext)
Updates the group. |
Group |
updateGroup(long groupId,
String typeSettings)
Updates the group's type settings. |
Group |
updateSite(long groupId,
boolean site)
Associates the group with a main site if the group is an organization. |
protected void |
validateFriendlyURL(long companyId,
long groupId,
long classNameId,
long classPK,
String friendlyURL)
|
protected void |
validateInheritContent(long parentGroupId,
boolean inheritContent)
|
protected void |
validateLanguageIds(String defaultLanguageId,
String languageIds)
|
protected void |
validateName(long groupId,
long companyId,
String name,
boolean site)
|
protected void |
validateParentGroup(long groupId,
long parentGroupId)
|
| 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 |
|---|
public static final String ORGANIZATION_NAME_SUFFIX
public static final String ORGANIZATION_STAGING_SUFFIX
protected File publicLARFile
| Constructor Detail |
|---|
public GroupLocalServiceImpl()
| Method Detail |
|---|
public Group addGroup(long userId,
long parentGroupId,
String className,
long classPK,
long liveGroupId,
String name,
String description,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean site,
boolean inheritContent,
boolean active,
ServiceContext serviceContext)
throws PortalException
PortalException
public Group addGroup(long userId,
long parentGroupId,
String className,
long classPK,
long liveGroupId,
String name,
String description,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
throws PortalException
userId - the primary key of the group's creator/ownerparentGroupId - the primary key of the parent groupclassName - the entity's class nameclassPK - the primary key of the entity's instanceliveGroupId - 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.manualMembership - whether manual membership is allowed for the
groupmembershipRestriction - the group's membership restriction. For
more information see GroupConstants.friendlyURL - the group's friendlyURL (optionally
null)site - whether the group is to be associated with a main 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 whether the group is for staging.
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
@Deprecated
public Group addGroup(long userId,
long parentGroupId,
String className,
long classPK,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
throws PortalException
addGroup(long, long, String,
long, long, String, String, int, boolean, int, String,
boolean, boolean, ServiceContext)
userId - the primary key of the group's creator/ownerparentGroupId - the primary key of the parent groupclassName - the entity's class nameclassPK - the primary key of the entity's instancename - 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 whether the group is for staging.
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
@Deprecated
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
addGroup(long, long, String,
long, long, String, String, int, boolean, int, String,
boolean, boolean, ServiceContext)
userId - the primary key of the group's creator/ownerclassName - the entity's class nameclassPK - the primary key of the entity's instanceliveGroupId - 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 asset category IDs and asset tag
names for the group, and whether the group is for staging.
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
@Deprecated
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
addGroup(long, long, String,
long, long, String, String, int, boolean, int, String,
boolean, boolean, ServiceContext)
userId - the primary key of the group's creator/ownerclassName - the entity's class nameclassPK - the primary key of the entity's instancename - 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 whether the group is for staging.
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
public void addRoleGroups(long roleId,
long[] groupIds)
addRoleGroups in interface GroupLocalServiceaddRoleGroups in class GroupLocalServiceBaseImplroleId - the primary key of the rolegroupIds - the primary keys of the groups
public void addUserGroups(long userId,
long[] groupIds)
addUserGroups in interface GroupLocalServiceaddUserGroups in class GroupLocalServiceBaseImpluserId - the primary key of the usergroupIds - the primary keys of the groups
@Transactional(propagation=SUPPORTS,
readOnly=true)
public void checkCompanyGroup(long companyId)
throws PortalException
companyId - the primary key of the company
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
@Transactional(propagation=SUPPORTS,
readOnly=true)
public void checkSystemGroups(long companyId)
throws PortalException
companyId - the primary key of the company
PortalException - if a new system group could not be created
public Group deleteGroup(Group group)
throws PortalException
The group is unstaged and its assets and resources including layouts, membership requests, subscriptions, teams, blogs, bookmarks, events, image gallery, journals, message boards, polls, shopping related entities, software catalog, and wikis are also deleted.
deleteGroup in interface GroupLocalServicedeleteGroup in class GroupLocalServiceBaseImplgroup - the group
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
public Group deleteGroup(long groupId)
throws PortalException
The group is unstaged and its assets and resources including layouts, membership requests, subscriptions, teams, blogs, bookmarks, events, image gallery, journals, message boards, polls, shopping related entities, software catalog, and wikis are also deleted.
deleteGroup in interface GroupLocalServicedeleteGroup in class GroupLocalServiceBaseImplgroupId - the primary key of the group
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
public void disableStaging(long groupId)
throws PortalException
PortalException
public void enableStaging(long groupId)
throws PortalException
PortalExceptionpublic Group fetchCompanyGroup(long companyId)
companyId - the primary key of the company
null if a matching group
could not be found
public Group fetchFriendlyURLGroup(long companyId,
String friendlyURL)
companyId - the primary key of the companyfriendlyURL - the friendly URL
null if a
matching group could not be found
@Skip
public Group fetchGroup(long companyId,
String name)
companyId - the primary key of the companyname - the group's name
null if a matching group could not be found
public Group fetchUserGroup(long companyId,
long userId)
throws PortalException
PortalException
public Group fetchUserPersonalSiteGroup(long companyId)
throws PortalException
companyId - the primary key of the company
null if a
matching group could not be found
PortalException - if a default user for the company could not be
found
public Group getCompanyGroup(long companyId)
throws PortalException
companyId - the primary key of the company
PortalException - if a matching group could not be found
public List<Group> getCompanyGroups(long companyId,
int start,
int end)
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.
companyId - the primary key of the companystart - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
public int getCompanyGroupsCount(long companyId)
companyId - the primary key of the company
public Group getFriendlyURLGroup(long companyId,
String friendlyURL)
throws PortalException
companyId - the primary key of the companyfriendlyURL - the group's friendlyURL
PortalException - if a matching group could not be found, or if the
friendly URL was invalid
@ThreadLocalCachable
public Group getGroup(long groupId)
throws PortalException
getGroup in interface GroupLocalServicegetGroup in class GroupLocalServiceBaseImplgroupId - the primary key of the group
PortalException - if a group with the primary key could not be
found
@Skip
public Group getGroup(long companyId,
String name)
throws PortalException
companyId - the primary key of the companyname - the group's name
PortalException - if a matching group could not be found
@Deprecated
public String getGroupDescriptiveName(Group group,
Locale locale)
throws PortalException
PortalException
@Deprecated
public String getGroupDescriptiveName(long groupId,
Locale locale)
throws PortalException
PortalException
public List<Group> getGroups(long companyId,
long parentGroupId,
boolean site)
companyId - the primary key of the companyparentGroupId - the primary key of the parent groupsite - whether the group is to be associated with a main site
null if no matches were
found
public List<Group> getGroups(long companyId,
long parentGroupId,
boolean site,
boolean inheritContent)
public List<Group> getGroups(long companyId,
String className,
long parentGroupId)
companyId - the primary key of the companyclassName - the class name of the groupparentGroupId - the primary key of the parent group
null if no matches were
found
public List<Group> getGroups(long companyId,
String className,
long parentGroupId,
int start,
int end)
companyId - the primary key of the companyclassName - the class name of the groupparentGroupId - the primary key of the parent groupstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
public List<Group> getGroups(long[] groupIds)
throws PortalException
groupIds - the primary keys of the groups
PortalException - if any one of the groups could not be found
public int getGroupsCount(long companyId,
long parentGroupId,
boolean site)
companyId - the primary key of the companyparentGroupId - the primary key of the parent groupsite - whether the group is to be associated with a main site
public int getGroupsCount(long companyId,
String className,
long parentGroupId)
companyId - the primary key of the companyclassName - the class name of the groupparentGroupId - the primary key of the parent group
public Group getLayoutGroup(long companyId,
long plid)
throws PortalException
companyId - the primary key of the companyplid - the primary key of the layout
PortalException - if a matching group could not be found
public Group getLayoutPrototypeGroup(long companyId,
long layoutPrototypeId)
throws PortalException
companyId - the primary key of the companylayoutPrototypeId - the primary key of the layout prototype
PortalException - if a matching group could not be found
public Group getLayoutSetPrototypeGroup(long companyId,
long layoutSetPrototypeId)
throws PortalException
companyId - the primary key of the companylayoutSetPrototypeId - the primary key of the layout set prototype
PortalException - if a matching group could not be found
@Deprecated
public List<Group> getLayoutsGroups(long companyId,
long parentGroupId,
boolean site,
int start,
int end)
getLayoutsGroups(long, long,
boolean, int, int, OrderByComparator)
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.
companyId - the primary key of the companyparentGroupId - the primary key of the parent groupsite - whether the group is to be associated with a main sitestart - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
public List<Group> getLayoutsGroups(long companyId,
long parentGroupId,
boolean site,
int start,
int end,
OrderByComparator<Group> obc)
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.
companyId - the primary key of the companyparentGroupId - the primary key of the parent groupsite - whether the group is to be associated with a main sitestart - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)obc - the comparator to order the groups (optionally
null)
obc
public int getLayoutsGroupsCount(long companyId,
long parentGroupId,
boolean site)
companyId - the primary key of the companyparentGroupId - the primary key of the parent groupsite - whether the group is to be associated with a main site
public List<Group> getLiveGroups()
public List<Group> getNoLayoutsGroups(String className,
boolean privateLayout,
int start,
int end)
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.
className - the entity's class nameprivateLayout - whether to include groups with private layout sets
or non-private layout setsstart - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
public List<Group> getNullFriendlyURLGroups()
null or empty friendly
URLs.
null or empty friendly
URLs
public Group getOrganizationGroup(long companyId,
long organizationId)
throws PortalException
companyId - the primary key of the companyorganizationId - the primary key of the organization
PortalException - if a matching group could not be foundpublic List<Group> getOrganizationsGroups(List<Organization> organizations)
organizations - the organizations
public List<Group> getOrganizationsRelatedGroups(List<Organization> organizations)
organizations - the organizations
public List<Group> getParentGroups(long groupId)
throws PortalException
groupId - the primary key of the group
PortalException - if a group with the primary key could not be
found
public Group getStagingGroup(long liveGroupId)
throws PortalException
liveGroupId - the primary key of the live group
PortalException - if a matching staging group could not be found
public Group getUserGroup(long companyId,
long userId)
throws PortalException
companyId - the primary key of the companyuserId - the primary key of the user
PortalException - if a matching group could not be found
public Group getUserGroupGroup(long companyId,
long userGroupId)
throws PortalException
UserGroup entity.
companyId - the primary key of the companyuserGroupId - the primary key of the user group
PortalException - if a matching group could not be found
public List<Group> getUserGroups(long userId,
boolean inherit)
throws PortalException
userId - the primary key of the userinherit - whether to include the user's inherited organization
groups and user groups
PortalException - if a user with the primary key could not be found
public List<Group> getUserGroups(long userId,
boolean inherit,
int start,
int end)
throws PortalException
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.
userId - the primary key of the userinherit - whether to include the user's inherited organization
groups and user groupsstart - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
PortalException - if a user with the primary key could not be found
public List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
throws PortalException
userGroups - the user groups
PortalException - if any one of the user group's group could not be
foundpublic List<Group> getUserGroupsRelatedGroups(List<UserGroup> userGroups)
userGroups - the user groups
public List<Group> getUserOrganizationsGroups(long userId,
int start,
int end)
throws PortalException
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.
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)
PortalException - if a user with the primary key could not be found
or if another portal exception occurred
public Group getUserPersonalSiteGroup(long companyId)
throws PortalException
companyId - the primary key of the company
PortalException - if a matching group or default user for the
company could not be found
public List<Group> getUserSitesGroups(long userId)
throws PortalException
PortalException
public List<Group> getUserSitesGroups(long userId,
boolean includeAdministrative)
throws PortalException
PortalExceptionpublic boolean hasStagingGroup(long liveGroupId)
true if the live group has a staging group.
liveGroupId - the primary key of the live group
true if the live group has a staging group;
false otherwise
public boolean hasUserGroup(long userId,
long groupId)
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.
hasUserGroup in interface GroupLocalServicehasUserGroup in class GroupLocalServiceBaseImpluserId - the primary key of the usergroupId - the primary key of the group
true if the user is associated with the group;
false otherwise
public boolean hasUserGroup(long userId,
long groupId,
boolean inherit)
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.
userId - the primary key of the usergroupId - the primary key of the groupinherit - whether to include organization groups and user groups to
which the user belongs in the determination
true if the user is associated with the group;
false otherwise
public Group loadFetchGroup(long companyId,
String name)
companyId - the primary key of the companyname - the group's name
null if a matching group could not be found
public Group loadGetGroup(long companyId,
String name)
throws PortalException
companyId - the primary key of the companyname - the group's name
PortalException - if a matching group could not be found
public void rebuildTree(long companyId)
throws PortalException
Only call this method if the tree has become stale through operations other than normal CRUD. Under normal circumstances the tree is automatically rebuilt whenever necessary.
companyId - the primary key of the group's company
PortalException - if a group with the primary key could not be
found
public List<Group> search(long companyId,
LinkedHashMap<String,Object> params,
int start,
int end)
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.
companyId - the primary key of the companyparams - 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 returnend - the upper bound of the range of groups to return (not
inclusive)
public List<Group> search(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
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.
companyId - the primary key of the companyparentGroupId - the primary key of the parent groupkeywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include the user's inherited organizations and user groups in the
search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
public List<Group> search(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
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.
companyId - the primary key of the companyparentGroupId - the primary key of the parent groupkeywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include the user's inherited organizations and user groups in the
search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)obc - the comparator to order the groups (optionally
null)
obc
public List<Group> search(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
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.
companyId - the primary key of the companyparentGroupId - the primary key of the parent groupname - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include the user's inherited organizations and user groups in the
search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.andOperator - whether every field must match its keywords, or just
one field.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
public List<Group> search(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
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.
companyId - the primary key of the companyparentGroupId - the primary key of the parent groupname - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include the user's inherited organizations and user groups in the
search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.andOperator - whether every field must match its keywords, or just
one field.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)obc - the comparator to order the groups (optionally
null)
obc
public List<Group> search(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
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.
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)parentGroupId - the primary key of the parent groupkeywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include a user's organizations, inherited organizations, and user
groups in the search, add an entry with key
"usersGroups" mapped to the user's ID and an entry with
key "inherit" mapped to a non-null object.
For more information see GroupFinder.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
public List<Group> search(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
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.
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)parentGroupId - the primary key of the parent groupkeywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include a user's organizations, inherited organizations, and user
groups in the search, add an entry with key
"usersGroups" mapped to the user's ID and an entry with
key "inherit" mapped to a non-null object.
For more information see GroupFinder.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)obc - the comparator to order the groups (optionally
null)
obc
public List<Group> search(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
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.
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)parentGroupId - the primary key of the parent groupname - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include a user's organizations, inherited organizations, and user
groups in the search, add an entry with key
"usersGroups" mapped to the user's ID and an entry with
key "inherit" mapped to a non-null object.
For more information see GroupFinder.andOperator - whether every field must match its keywords, or just
one field.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
public List<Group> search(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
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.
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)parentGroupId - the primary key of the parent groupname - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include a user's organizations, inherited organizations, and user
groups in the search, add an entry with key
"usersGroups" mapped to the user's ID and an entry with
key "inherit" mapped to a non-null object.
For more information see GroupFinder.andOperator - whether every field must match its keywords, or just
one field.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)obc - the comparator to order the groups (optionally
null)
obc
public List<Group> search(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
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.
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)keywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include a user's organizations, inherited organizations, and user
groups in the search, add an entry with key
"usersGroups" mapped to the user's ID and an entry with
key "inherit" mapped to a non-null object.
For more information see GroupFinder.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
public List<Group> search(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
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.
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)keywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include a user's organizations, inherited organizations, and user
groups in the search, add an entry with key
"usersGroups" mapped to the user's ID and an entry with
key "inherit" mapped to a non-null object.
For more information see GroupFinder.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)obc - the comparator to order the groups (optionally
null)
obc
public List<Group> search(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
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.
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)name - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include a user's organizations, inherited organizations, and user
groups in the search, add an entry with key
"usersGroups" mapped to the user's ID and an entry with
key "inherit" mapped to a non-null object.
For more information see GroupFinder.andOperator - whether every field must match its keywords, or just
one field.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
public List<Group> search(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
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.
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)name - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include a user's organizations, inherited organizations, and user
groups in the search, add an entry with key
"usersGroups" mapped to the user's ID and an entry with
key "inherit" mapped to a non-null object.
For more information see GroupFinder.andOperator - whether every field must match its keywords, or just
one field.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)obc - the comparator to order the groups (optionally
null)
obc
@ThreadLocalCachable
public List<Group> search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
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.
companyId - the primary key of the companykeywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include the user's inherited organizations and user groups in the
search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
public List<Group> search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<Group> obc)
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.
companyId - the primary key of the companykeywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include the user's inherited organizations and user groups in the
search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)obc - the comparator to order the groups (optionally
null)
obc
public List<Group> search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
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.
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.andOperator - whether every field must match its keywords, or just
one field.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
public List<Group> search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc)
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.
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.andOperator - whether every field must match its keywords, or just
one field.start - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)obc - the comparator to order the groups (optionally
null)
obc
@ThreadLocalCachable
public int searchCount(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params)
companyId - the primary key of the companyparentGroupId - the primary key of the parent groupkeywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include the user's inherited organization groups and user groups
in the search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.
@ThreadLocalCachable
public int searchCount(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
companyId - the primary key of the companyparentGroupId - the primary key of the parent groupname - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include the user's inherited organization groups and user groups
in the search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.andOperator - whether every field must match its keywords, or just
one field.
@ThreadLocalCachable
public int searchCount(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params)
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)parentGroupId - the primary key of the parent groupkeywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include the user's inherited organization groups and user groups
in the search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.
@ThreadLocalCachable
public int searchCount(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)parentGroupId - the primary key of the parent groupname - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include the user's inherited organization groups and user groups
in the search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.andOperator - whether every field must match its keywords, or just
one field.
@ThreadLocalCachable
public int searchCount(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params)
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)keywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include the user's inherited organization groups and user groups
in the search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.
@ThreadLocalCachable
public int searchCount(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
companyId - the primary key of the companyclassNameIds - the primary keys of the class names of the entities
the groups are related to (optionally null)name - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include the user's inherited organization groups and user groups
in the search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.andOperator - whether every field must match its keywords, or just
one field.
@ThreadLocalCachable
public int searchCount(long companyId,
String keywords,
LinkedHashMap<String,Object> params)
companyId - the primary key of the companykeywords - the keywords (space separated), which may occur in the
sites's name, or description (optionally null)params - the finder params (optionally null). To
include the user's inherited organization groups and user groups
in the search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.
@ThreadLocalCachable
public int searchCount(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
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 organization groups and user groups
in the search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinder.andOperator - whether every field must match its keywords, or just
one field.
public void setRoleGroups(long roleId,
long[] groupIds)
setRoleGroups in interface GroupLocalServicesetRoleGroups in class GroupLocalServiceBaseImplroleId - the primary key of the rolegroupIds - the primary keys of the groups
public void unsetRoleGroups(long roleId,
long[] groupIds)
roleId - the primary key of the rolegroupIds - the primary keys of the groups
public void unsetUserGroups(long userId,
long[] groupIds)
userId - the primary key of the usergroupIds - the primary keys of the groups
public void updateAsset(long userId,
Group group,
long[] assetCategoryIds,
String[] assetTagNames)
throws PortalException
userId - the primary key of the usergroup - the groupassetCategoryIds - the primary keys of the asset categories
(optionally null)assetTagNames - the asset tag names (optionally null)
PortalException - if a user with the primary key could not be found
public Group updateFriendlyURL(long groupId,
String friendlyURL)
throws PortalException
groupId - the primary key of the groupfriendlyURL - the group's new friendlyURL (optionally
null)
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
public Group updateGroup(long groupId,
long parentGroupId,
String name,
String description,
int type,
boolean manualMembership,
int membershipRestriction,
String friendlyURL,
boolean inheritContent,
boolean active,
ServiceContext serviceContext)
throws PortalException
groupId - the primary key of the groupparentGroupId - the primary key of the parent groupname - the group's new namedescription - the group's new description (optionally
null)type - the group's new type. For more information see GroupConstants.manualMembership - whether manual membership is allowed for the
groupmembershipRestriction - the group's membership restriction. 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 asset category IDs and asset tag
names for the group.
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
public Group updateGroup(long groupId,
String typeSettings)
throws PortalException
groupId - the primary key of the grouptypeSettings - the group's new type settings (optionally
null)
PortalException - if a group with the primary key could not be
found
public Group updateSite(long groupId,
boolean site)
throws PortalException
groupId - the primary key of the groupsite - whether the group is to be associated with a main site
PortalException - if a group with the primary key could not be
found
protected void addControlPanelLayouts(Group group)
throws PortalException
PortalException
protected void addDefaultGuestPublicLayoutByProperties(Group group)
throws PortalException
PortalException
protected void addDefaultGuestPublicLayouts(Group group)
throws PortalException
PortalException
protected void addDefaultGuestPublicLayoutsByLAR(Group group,
File larFile)
throws PortalException
PortalException
protected void addPortletDefaultData(Group group)
throws PortalException
PortalException
protected void deletePortletData(Group group)
throws PortalException
PortalException
protected Collection<Group> doSearch(long companyId,
long[] classNameIds,
long parentGroupId,
String[] names,
String[] descriptions,
LinkedHashMap<String,Object> params,
boolean andOperator)
protected long[] getClassNameIds()
protected String getFriendlyURL(long companyId,
long groupId,
long classNameId,
long classPK,
String friendlyName,
String friendlyURL)
throws PortalException
PortalExceptionprotected String getFriendlyURL(String friendlyURL)
protected String getOrgGroupName(String name)
protected List<PortletDataHandler> getPortletDataHandlers(Group group)
protected String[] getSearchNames(long companyId,
String name)
protected void initImportLARFile()
protected void initUserPersonalSitePermissions(Group group)
throws PortalException
PortalException
protected boolean isParentGroup(long parentGroupId,
long groupId)
throws PortalException
PortalExceptionprotected boolean isStaging(ServiceContext serviceContext)
protected boolean isUseComplexSQL(long[] classNameIds)
protected boolean matches(String s,
String[] keywords)
protected void setCompanyPermissions(Role role,
String name,
String[] actionIds)
throws PortalException
PortalException
protected void setRolePermissions(Group group,
Role role,
String name)
throws PortalException
PortalException
protected void setRolePermissions(Group group,
Role role,
String name,
String[] actionIds)
throws PortalException
PortalException
protected List<Group> sort(Collection<Group> groups,
int start,
int end,
OrderByComparator<Group> obc)
protected void unscheduleStaging(Group group)
protected void validateFriendlyURL(long companyId,
long groupId,
long classNameId,
long classPK,
String friendlyURL)
throws PortalException
PortalException
protected void validateInheritContent(long parentGroupId,
boolean inheritContent)
throws GroupInheritContentException
GroupInheritContentException
protected void validateLanguageIds(String defaultLanguageId,
String languageIds)
throws PortalException
PortalException
protected void validateName(long groupId,
long companyId,
String name,
boolean site)
throws PortalException
PortalException
protected void validateParentGroup(long groupId,
long parentGroupId)
throws PortalException
PortalException
|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||