|
Liferay 7.0-ce-b4 | |||||||||
| 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.UserGroupLocalServiceBaseImpl
com.liferay.portal.service.impl.UserGroupLocalServiceImpl
public class UserGroupLocalServiceImpl
Provides the local service for accessing, adding, deleting, and updating user groups.
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
UserGroupLocalServiceImpl()
|
|
| Method Summary | |
|---|---|
void |
addGroupUserGroups(long groupId,
long[] userGroupIds)
Adds the user groups to the group. |
void |
addTeamUserGroups(long teamId,
long[] userGroupIds)
Adds the user groups to the team. |
UserGroup |
addUserGroup(long userId,
long companyId,
String name,
String description)
Deprecated. As of 6.2.0, replaced by addUserGroup(long, long,
String, String, ServiceContext) |
UserGroup |
addUserGroup(long userId,
long companyId,
String name,
String description,
ServiceContext serviceContext)
Adds a user group. |
protected SearchContext |
buildSearchContext(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
|
void |
clearUserUserGroups(long userId)
Clears all associations between the user and its user groups and clears the permissions cache. |
void |
copyUserGroupLayouts(long[] userGroupIds,
long userId)
Deprecated. As of 6.1.0 |
void |
copyUserGroupLayouts(long userGroupId,
long userId)
Deprecated. As of 6.2.0 |
void |
copyUserGroupLayouts(long userGroupId,
long[] userIds)
Deprecated. As of 6.1.0 |
UserGroup |
deleteUserGroup(long userGroupId)
Deletes the user group. |
UserGroup |
deleteUserGroup(UserGroup userGroup)
Deletes the user group. |
void |
deleteUserGroups(long companyId)
|
protected File[] |
exportLayouts(long userGroupId,
Map<String,String[]> parameterMap)
|
UserGroup |
fetchUserGroup(long companyId,
String name)
|
List<UserGroup> |
getGroupUserUserGroups(long groupId,
long userId)
|
protected Map<String,String[]> |
getLayoutTemplatesParameters()
|
UserGroup |
getUserGroup(long companyId,
String name)
Returns the user group with the name. |
List<UserGroup> |
getUserGroups(long companyId)
Returns all the user groups belonging to the company. |
List<UserGroup> |
getUserGroups(long[] userGroupIds)
Returns all the user groups with the primary keys. |
protected void |
importLayouts(long userId,
Map<String,String[]> parameterMap,
File privateLayoutsFile,
File publicLayoutsFile)
|
protected boolean |
isUseCustomSQL(LinkedHashMap<String,Object> params)
|
List<UserGroup> |
search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<UserGroup> obc)
Returns an ordered range of all the user groups that match the keywords. |
Hits |
search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort sort)
Returns an ordered range of all the user groups that match the keywords, using the indexer. |
List<UserGroup> |
search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<UserGroup> obc)
Returns an ordered range of all the user groups that match the name and description. |
Hits |
search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
Returns an ordered range of all the user groups that match the name and description. |
int |
searchCount(long companyId,
String keywords,
LinkedHashMap<String,Object> params)
Returns the number of user groups that match the keywords |
int |
searchCount(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
Returns the number of user groups that match the name and description. |
BaseModelSearchResult<UserGroup> |
searchUserGroups(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort sort)
|
BaseModelSearchResult<UserGroup> |
searchUserGroups(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
|
void |
setUserUserGroups(long userId,
long[] userGroupIds)
Sets the user groups associated with the user copying the user group layouts and removing and adding user group associations for the user as necessary. |
void |
unsetGroupUserGroups(long groupId,
long[] userGroupIds)
Removes the user groups from the group. |
void |
unsetTeamUserGroups(long teamId,
long[] userGroupIds)
Removes the user groups from the team. |
UserGroup |
updateUserGroup(long companyId,
long userGroupId,
String name,
String description)
Deprecated. As of 6.2.0, replaced by updateUserGroup(long, long,
String, String, ServiceContext) |
UserGroup |
updateUserGroup(long companyId,
long userGroupId,
String name,
String description,
ServiceContext serviceContext)
Updates the user group. |
protected void |
validate(long userGroupId,
long companyId,
String name)
|
| Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
|---|
getClassLoader, getLocalizationMap |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public UserGroupLocalServiceImpl()
| Method Detail |
|---|
public void addGroupUserGroups(long groupId,
long[] userGroupIds)
addGroupUserGroups in interface UserGroupLocalServiceaddGroupUserGroups in class UserGroupLocalServiceBaseImplgroupId - the primary key of the groupuserGroupIds - the primary keys of the user groups
public void addTeamUserGroups(long teamId,
long[] userGroupIds)
addTeamUserGroups in interface UserGroupLocalServiceaddTeamUserGroups in class UserGroupLocalServiceBaseImplteamId - the primary key of the teamuserGroupIds - the primary keys of the user groups
@Deprecated
public UserGroup addUserGroup(long userId,
long companyId,
String name,
String description)
throws PortalException
addUserGroup(long, long,
String, String, ServiceContext)
This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to setup default groups and resources for the user group.
userId - the primary key of the usercompanyId - the primary key of the user group's companyname - the user group's namedescription - the user group's description
PortalException
public UserGroup addUserGroup(long userId,
long companyId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException
This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to setup default groups and resources for the user group.
userId - the primary key of the usercompanyId - the primary key of the user group's companyname - the user group's namedescription - the user group's descriptionserviceContext - the service context to be applied (optionally
null). Can set expando bridge attributes for the
user group.
PortalExceptionpublic void clearUserUserGroups(long userId)
clearUserUserGroups in interface UserGroupLocalServiceclearUserUserGroups in class UserGroupLocalServiceBaseImpluserId - the primary key of the user
@Deprecated
public void copyUserGroupLayouts(long userGroupId,
long userId)
throws PortalException
userGroupId - the primary key of the user groupuserId - the primary key of the user
PortalException
@Deprecated
public void copyUserGroupLayouts(long userGroupId,
long[] userIds)
throws PortalException
userGroupId - the primary key of the user groupuserIds - the primary keys of the users
PortalException
@Deprecated
public void copyUserGroupLayouts(long[] userGroupIds,
long userId)
throws PortalException
userGroupIds - the primary keys of the user groupsuserId - the primary key of the user
PortalException
public UserGroup deleteUserGroup(long userGroupId)
throws PortalException
deleteUserGroup in interface UserGroupLocalServicedeleteUserGroup in class UserGroupLocalServiceBaseImpluserGroupId - the primary key of the user group
PortalException - if a user group with the primary key could not be found
@SystemEvent(action=1,
type=1)
public UserGroup deleteUserGroup(UserGroup userGroup)
throws PortalException
deleteUserGroup in interface UserGroupLocalServicedeleteUserGroup in class UserGroupLocalServiceBaseImpluserGroup - the user group
PortalException
public void deleteUserGroups(long companyId)
throws PortalException
PortalException
public UserGroup fetchUserGroup(long companyId,
String name)
public List<UserGroup> getGroupUserUserGroups(long groupId,
long userId)
throws PortalException
PortalException
public UserGroup getUserGroup(long companyId,
String name)
throws PortalException
companyId - the primary key of the user group's companyname - the user group's name
PortalExceptionpublic List<UserGroup> getUserGroups(long companyId)
companyId - the primary key of the user groups' company
public List<UserGroup> getUserGroups(long[] userGroupIds)
throws PortalException
userGroupIds - the primary keys of the user groups
PortalException
public List<UserGroup> search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator<UserGroup> 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 user group's companykeywords - the keywords (space separated), which may occur in the
user group's name or description (optionally null)params - the finder params (optionally null). For more
information see UserGroupFinderstart - the lower bound of the range of user groups to returnend - the upper bound of the range of user groups to return (not
inclusive)obc - the comparator to order the user groups (optionally
null)
obcUserGroupFinder
public Hits search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort sort)
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 user group's companykeywords - the keywords (space separated), which may occur in the
user group's name or description (optionally null)params - the finder params (optionally null). For more
information see com.liferay.portlet.usergroupsadmin.util.UserGroupIndexerstart - the lower bound of the range of user groups to returnend - the upper bound of the range of user groups to return (not
inclusive)sort - the field and direction by which to sort (optionally
null)
com.liferay.portlet.usergroupsadmin.util.UserGroupIndexer
public List<UserGroup> search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<UserGroup> 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 user group's companyname - the user group's name (optionally null)description - the user group's description (optionally
null)params - the finder params (optionally null). For more
information see UserGroupFinderandOperator - whether every field must match its keywords or just
one fieldstart - the lower bound of the range of user groups to returnend - the upper bound of the range of user groups to return (not
inclusive)obc - the comparator to order the user groups (optionally
null)
obcUserGroupFinder
public Hits search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
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 user group's companyname - the user group's name (optionally null)description - the user group's description (optionally
null)params - the finder params (optionally null). For more
information see com.liferay.portlet.usergroupsadmin.util.UserGroupIndexerandSearch - whether every field must match its keywords or just one
fieldstart - the lower bound of the range of user groups to returnend - the upper bound of the range of user groups to return (not
inclusive)sort - the field and direction by which to sort (optionally
null)
UserGroupFinder
public int searchCount(long companyId,
String keywords,
LinkedHashMap<String,Object> params)
companyId - the primary key of the user group's companykeywords - the keywords (space separated), which may occur in the
user group's name or description (optionally null)params - the finder params (optionally null). For more
information see UserGroupFinder
UserGroupFinder
public int searchCount(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
companyId - the primary key of the user group's companyname - the user group's name (optionally null)description - the user group's description (optionally
null)params - the finder params (optionally null). For more
information see UserGroupFinderandOperator - whether every field must match its keywords or just
one field
UserGroupFinder
public BaseModelSearchResult<UserGroup> searchUserGroups(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort sort)
throws PortalException
PortalException
public BaseModelSearchResult<UserGroup> searchUserGroups(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
throws PortalException
PortalException
public void setUserUserGroups(long userId,
long[] userGroupIds)
throws PortalException
setUserUserGroups in interface UserGroupLocalServicesetUserUserGroups in class UserGroupLocalServiceBaseImpluserId - the primary key of the useruserGroupIds - the primary keys of the user groups
PortalException
public void unsetGroupUserGroups(long groupId,
long[] userGroupIds)
groupId - the primary key of the groupuserGroupIds - the primary keys of the user groups
public void unsetTeamUserGroups(long teamId,
long[] userGroupIds)
teamId - the primary key of the teamuserGroupIds - the primary keys of the user groups
@Deprecated
public UserGroup updateUserGroup(long companyId,
long userGroupId,
String name,
String description)
throws PortalException
updateUserGroup(long, long,
String, String, ServiceContext)
companyId - the primary key of the user group's companyuserGroupId - the primary key of the user groupname - the user group's namedescription - the user group's description
PortalException
public UserGroup updateUserGroup(long companyId,
long userGroupId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException
companyId - the primary key of the user group's companyuserGroupId - the primary key of the user groupname - the user group's namedescription - the user group's descriptionserviceContext - the service context to be applied (optionally
null). Can set expando bridge attributes for the
user group.
PortalException
protected SearchContext buildSearchContext(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
protected File[] exportLayouts(long userGroupId,
Map<String,String[]> parameterMap)
throws PortalException
PortalExceptionprotected Map<String,String[]> getLayoutTemplatesParameters()
protected void importLayouts(long userId,
Map<String,String[]> parameterMap,
File privateLayoutsFile,
File publicLayoutsFile)
throws PortalException
PortalExceptionprotected boolean isUseCustomSQL(LinkedHashMap<String,Object> params)
protected void validate(long userGroupId,
long companyId,
String name)
throws PortalException
PortalException
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||