|
Liferay 6.2.0-ce-m1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface GroupLocalServiceThe interface for the group local service.
This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
GroupLocalServiceUtil,
GroupLocalServiceBaseImpl,
GroupLocalServiceImpl| Method Summary | |
|---|---|
Group |
addGroup(Group group)
Adds the group to the database. |
Group |
addGroup(long userId,
long parentGroupId,
String className,
long classPK,
long liveGroupId,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Adds a group. |
Group |
addGroup(long userId,
long parentGroupId,
String className,
long classPK,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Deprecated. addGroup(long, long, String, long, long, String,
String, int, String, boolean, boolean, ServiceContext) |
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 |
createGroup(long groupId)
Creates a new group with the primary key. |
Group |
deleteGroup(Group group)
Deletes the group from the database. |
Group |
deleteGroup(long groupId)
Deletes the group with the primary key from the database. |
DynamicQuery |
dynamicQuery()
|
List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
Group |
fetchFriendlyURLGroup(long companyId,
String friendlyURL)
Returns the group with the matching friendly URL. |
Group |
fetchGroup(long groupId)
|
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. |
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
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. |
Group |
getFriendlyURLGroup(long companyId,
String friendlyURL)
Returns the group with the matching friendly URL. |
Group |
getGroup(long groupId)
Returns the group with the primary key. |
Group |
getGroup(long companyId,
String name)
Returns the group with the matching group name. |
String |
getGroupDescriptiveName(Group group,
Locale locale)
|
String |
getGroupDescriptiveName(long groupId,
Locale locale)
|
List<Group> |
getGroups(int start,
int end)
Returns a range of all the groups. |
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 sites that are children of the parent group. |
int |
getGroupsCount()
Returns the number of groups. |
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)
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. |
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
List<Group> |
getRoleGroups(long roleId)
Returns all the groups associated with the role. |
Group |
getStagingGroup(long liveGroupId)
Returns the staging group. |
Group |
getUserGroup(long companyId,
long userId)
Returns the group associated with the user. |
Group |
getUserGroupGroup(long companyId,
long userGroupId)
Returns the specified "user group" group. |
List<Group> |
getUserGroups(long userId)
Returns all the user's site groups and immediate organization groups. |
List<Group> |
getUserGroups(long userId,
boolean inherit)
Returns all the user's site groups and immediate organization groups, optionally including the user's inherited organization groups and user groups. |
List<Group> |
getUserGroups(long userId,
boolean inherit,
int start,
int end)
Returns 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> |
getUserGroups(long userId,
int start,
int end)
Returns an ordered range of all the user's site groups and immediate organization groups. |
List<Group> |
getUserGroupsGroups(List<UserGroup> userGroups)
Returns the groups associated with the user groups. |
List<Group> |
getUserGroupsRelatedGroups(List<UserGroup> userGroups)
Returns all the groups related to the user groups. |
List<Group> |
getUserOrganizationsGroups(long userId,
int start,
int end)
Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property organizations.membership.strict is set to
true. |
boolean |
hasRoleGroup(long roleId,
long groupId)
Returns true if the group is associated with the role. |
boolean |
hasStagingGroup(long liveGroupId)
Returns true if the live group has a staging group. |
boolean |
hasUserGroup(long userId,
long groupId)
Returns true if the user is immediately associated with the
group, or associated with the group via the user's organizations,
inherited organizations, or user groups. |
boolean |
hasUserGroup(long userId,
long groupId,
boolean inherit)
Returns true if the user is immediately associated with the
group, or optionally if the user is associated with the group via the
user's organizations, inherited organizations, or user groups. |
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. |
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 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 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 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 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 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 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 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 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. |
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
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. |
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(Group group)
Updates the group in the database or adds it if it does not yet exist. |
Group |
updateGroup(long groupId,
long parentGroupId,
String name,
String description,
int type,
String friendlyURL,
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. |
| Method Detail |
|---|
Group addGroup(Group group)
throws SystemException
group - the group
SystemException - if a system exception occurredGroup createGroup(long groupId)
groupId - the primary key for the new group
Group deleteGroup(long groupId)
throws PortalException,
SystemException
groupId - the primary key of the group
PortalException - if a group with the primary key could not be found
SystemException - if a system exception occurred
Group deleteGroup(Group group)
throws PortalException,
SystemException
group - the group
PortalException
SystemException - if a system exception occurredDynamicQuery dynamicQuery()
List dynamicQuery(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
throws SystemException
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.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
SystemException - if a system exception occurred
List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
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.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)orderByComparator - the comparator to order the results by (optionally null)
SystemException - if a system exception occurred
long dynamicQueryCount(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group fetchGroup(long groupId)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group getGroup(long groupId)
throws PortalException,
SystemException
groupId - the primary key of the group
PortalException - if a group with the primary key could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException,
SystemException
getPersistedModel in interface PersistedModelLocalServicePortalException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getGroups(int start,
int end)
throws SystemException
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.
start - the lower bound of the range of groupsend - the upper bound of the range of groups (not inclusive)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getGroupsCount()
throws SystemException
SystemException - if a system exception occurred
Group updateGroup(Group group)
throws SystemException
group - the group
SystemException - if a system exception occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
Group addGroup(long userId,
long parentGroupId,
String className,
long classPK,
long liveGroupId,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
throws PortalException,
SystemException
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 GroupConstantsfriendlyURL - 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
SystemException - if a system exception occurred
Group addGroup(long userId,
long parentGroupId,
String className,
long classPK,
String name,
String description,
int type,
String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
throws PortalException,
SystemException
addGroup(long, long, String, long, long, String,
String, 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 GroupConstantsfriendlyURL - 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
SystemException - if a system exception occurred
void addRoleGroups(long roleId,
long[] groupIds)
throws SystemException
roleId - the primary key of the rolegroupIds - the primary keys of the groups
SystemException - if a system exception occurred
void addUserGroups(long userId,
long[] groupIds)
throws SystemException
userId - the primary key of the usergroupIds - the primary keys of the groups
SystemException - if a system exception occurred
void checkCompanyGroup(long companyId)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
void checkSystemGroups(long companyId)
throws PortalException,
SystemException
companyId - the primary key of the company
PortalException - if a new system group could not be created
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group fetchFriendlyURLGroup(long companyId,
String friendlyURL)
throws SystemException
companyId - the primary key of the companyfriendlyURL - the friendly URL
null if a
matching group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group fetchGroup(long companyId,
String name)
throws SystemException
companyId - the primary key of the companyname - the group's name
null if a matching group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group getCompanyGroup(long companyId)
throws PortalException,
SystemException
companyId - the primary key of the company
PortalException - if a matching group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getCompanyGroups(long companyId,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getCompanyGroupsCount(long companyId)
throws SystemException
companyId - the primary key of the company
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group getFriendlyURLGroup(long companyId,
String friendlyURL)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group getGroup(long companyId,
String name)
throws PortalException,
SystemException
companyId - the primary key of the companyname - the group's name
PortalException - if a matching group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
String getGroupDescriptiveName(Group group,
Locale locale)
throws PortalException,
SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
String getGroupDescriptiveName(long groupId,
Locale locale)
throws PortalException,
SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getGroups(long companyId,
long parentGroupId,
boolean site)
throws SystemException
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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getGroups(long[] groupIds)
throws PortalException,
SystemException
groupIds - the primary keys of the groups
PortalException - if any one of the groups could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group getLayoutGroup(long companyId,
long plid)
throws PortalException,
SystemException
companyId - the primary key of the companyplid - the primary key of the layout
PortalException - if a matching group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group getLayoutPrototypeGroup(long companyId,
long layoutPrototypeId)
throws PortalException,
SystemException
companyId - the primary key of the companylayoutPrototypeId - the primary key of the layout prototype
PortalException - if a matching group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group getLayoutSetPrototypeGroup(long companyId,
long layoutSetPrototypeId)
throws PortalException,
SystemException
companyId - the primary key of the companylayoutSetPrototypeId - the primary key of the layout set prototype
PortalException - if a matching group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getLayoutsGroups(long companyId,
long parentGroupId,
boolean site,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getLayoutsGroupsCount(long companyId,
long parentGroupId,
boolean site)
throws SystemException
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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getLiveGroups()
throws SystemException
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getNoLayoutsGroups(String className,
boolean privateLayout,
int start,
int end)
throws SystemException
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)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getNullFriendlyURLGroups()
throws SystemException
null or empty friendly
URLs.
null or empty friendly
URLs
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group getOrganizationGroup(long companyId,
long organizationId)
throws PortalException,
SystemException
companyId - the primary key of the companyorganizationId - the primary key of the organization
PortalException - if a matching group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getOrganizationsGroups(List<Organization> organizations)
organizations - the organizations
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getOrganizationsRelatedGroups(List<Organization> organizations)
throws SystemException
organizations - the organizations
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getRoleGroups(long roleId)
throws SystemException
roleId - the primary key of the role
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group getStagingGroup(long liveGroupId)
throws PortalException,
SystemException
liveGroupId - the primary key of the live group
PortalException - if a matching staging group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group getUserGroup(long companyId,
long userId)
throws PortalException,
SystemException
companyId - the primary key of the companyuserId - the primary key of the user
PortalException - if a matching group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group getUserGroupGroup(long companyId,
long userGroupId)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getUserGroups(long userId)
throws PortalException,
SystemException
userId - the primary key of the user
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getUserGroups(long userId,
boolean inherit)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getUserGroups(long userId,
boolean inherit,
int start,
int end)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getUserGroups(long userId,
int start,
int end)
throws PortalException,
SystemException
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 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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
throws PortalException,
SystemException
userGroups - the user groups
PortalException - if any one of the user group's group could not be
found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getUserGroupsRelatedGroups(List<UserGroup> userGroups)
throws SystemException
userGroups - the user groups
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> getUserOrganizationsGroups(long userId,
int start,
int end)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasRoleGroup(long roleId,
long groupId)
throws SystemException
true if the group is associated with the role.
roleId - the primary key of the rolegroupId - the primary key of the group
true if the group is associated with the role;
false otherwise
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasStagingGroup(long liveGroupId)
throws SystemException
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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasUserGroup(long userId,
long groupId)
throws SystemException
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.
userId - the primary key of the usergroupId - the primary key of the group
true if the user is associated with the group;
false otherwise
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasUserGroup(long userId,
long groupId,
boolean inherit)
throws SystemException
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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group loadFetchGroup(long companyId,
String name)
throws SystemException
companyId - the primary key of the companyname - the group's name
null if a matching group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Group loadGetGroup(long companyId,
String name)
throws PortalException,
SystemException
companyId - the primary key of the companyname - the group's name
PortalException - if a matching group could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
LinkedHashMap<String,Object> params,
int start,
int end)
throws SystemException
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 GroupFinderstart - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
throws SystemException
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 GroupFinderstart - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
throws SystemException
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 GroupFinderstart - 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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
throws SystemException
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 GroupFinderandOperator - 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)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator obc)
throws SystemException
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 GroupFinderandOperator - 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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
throws SystemException
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 class names of entities to include in the search
(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 GroupFinderstart - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
throws SystemException
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 group's class name IDs (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 GroupFinderstart - 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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
throws SystemException
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 class names of entities to include in the search
(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 GroupFinderandOperator - 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)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator obc)
throws SystemException
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 group's class name IDs (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 GroupFinderandOperator - 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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
throws SystemException
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 class names of entities to include in the search
(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 GroupFinderstart - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
throws SystemException
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 group's class name IDs (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 GroupFinderstart - 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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
throws SystemException
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 class names of entities to include in the search
(optionally null)name - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include a user's organizations, inherited organizations, and user
groups in the search, add an entry with key
"usersGroups" mapped to the user's ID and an entry with
key "inherit" mapped to a non-null object.
For more information see GroupFinderandOperator - 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)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator obc)
throws SystemException
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 group's class name IDs (optionally
null)name - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include a user's organizations, inherited organizations, and user
groups in the search, add an entry with key
"usersGroups" mapped to the user's ID and an entry with
key "inherit" mapped to a non-null object.
For more information see GroupFinderandOperator - 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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end)
throws SystemException
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 GroupFinderstart - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
throws SystemException
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 GroupFinderstart - 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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end)
throws SystemException
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 GroupFinderandOperator - 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)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Group> search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator obc)
throws SystemException
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 GroupFinderandOperator - 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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params)
throws SystemException
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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
throws SystemException
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 GroupFinderandOperator - whether every field must match its keywords, or just
one field.
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
long[] classNameIds,
long parentGroupId,
String keywords,
LinkedHashMap<String,Object> params)
throws SystemException
companyId - the primary key of the companyclassNameIds - the class names of entities to include in the search
(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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
long[] classNameIds,
long parentGroupId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
throws SystemException
companyId - the primary key of the companyclassNameIds - the class names of entities to include in the search
(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 GroupFinderandOperator - whether every field must match its keywords, or just
one field.
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
long[] classNameIds,
String keywords,
LinkedHashMap<String,Object> params)
throws SystemException
companyId - the primary key of the companyclassNameIds - the class names of entities to include in the search
(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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
long[] classNameIds,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
throws SystemException
companyId - the primary key of the companyclassNameIds - the class names of entities to include in the search
(optionally null)name - the group's name (optionally null)description - the group's description (optionally
null)params - the finder params (optionally null). To
include the user's inherited organization groups and user groups
in the search, add entries having "usersGroups" and
"inherit" as keys mapped to the the user's ID. For more
information see GroupFinderandOperator - whether every field must match its keywords, or just
one field.
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
String keywords,
LinkedHashMap<String,Object> params)
throws SystemException
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
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
throws SystemException
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 GroupFinderandOperator - whether every field must match its keywords, or just
one field.
SystemException - if a system exception occurred
void setRoleGroups(long roleId,
long[] groupIds)
throws SystemException
roleId - the primary key of the rolegroupIds - the primary keys of the groups
SystemException - if a system exception occurred
void unsetRoleGroups(long roleId,
long[] groupIds)
throws SystemException
roleId - the primary key of the rolegroupIds - the primary keys of the groups
SystemException - if a system exception occurred
void unsetUserGroups(long userId,
long[] groupIds)
throws SystemException
userId - the primary key of the usergroupIds - the primary keys of the groups
SystemException - if a system exception occurred
void updateAsset(long userId,
Group group,
long[] assetCategoryIds,
String[] assetTagNames)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
Group updateFriendlyURL(long groupId,
String friendlyURL)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
Group updateGroup(long groupId,
long parentGroupId,
String name,
String description,
int type,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
throws PortalException,
SystemException
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 GroupConstantsfriendlyURL - 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
SystemException - if a system exception occurred
Group updateGroup(long groupId,
String typeSettings)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
Group updateSite(long groupId,
boolean site)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
|
Liferay 6.2.0-ce-m1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||