|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.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. |
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)
|
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)
|
List<UserGroup> |
search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator 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. |
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 |
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, getLayoutURL, getLayoutURL |
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) throws SystemException
addGroupUserGroups
in interface UserGroupLocalService
addGroupUserGroups
in class UserGroupLocalServiceBaseImpl
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups
SystemException
- if a system exception occurredpublic void addTeamUserGroups(long teamId, long[] userGroupIds) throws SystemException
addTeamUserGroups
in interface UserGroupLocalService
addTeamUserGroups
in class UserGroupLocalServiceBaseImpl
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups
SystemException
- if a system exception occurredpublic UserGroup addUserGroup(long userId, long companyId, String name, String description) throws PortalException, SystemException
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
- if the user group's information was invalid
SystemException
- if a system exception occurredpublic UserGroup addUserGroup(long userId, long companyId, String name, String description, ServiceContext serviceContext) throws PortalException, SystemException
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.
PortalException
- if the user group's information was invalid
SystemException
- if a system exception occurredpublic void clearUserUserGroups(long userId) throws SystemException
This method is called from deleteUserGroup(UserGroup)
.
clearUserUserGroups
in interface UserGroupLocalService
clearUserUserGroups
in class UserGroupLocalServiceBaseImpl
userId
- the primary key of the user
SystemException
- if a system exception occurredpublic void copyUserGroupLayouts(long userGroupId, long userId) throws PortalException, SystemException
userGroupId
- the primary key of the user groupuserId
- the primary key of the user
PortalException
- if a user with the primary key could not be
found or if a portal exception occurred
SystemException
- if a system exception occurredpublic void copyUserGroupLayouts(long userGroupId, long[] userIds) throws PortalException, SystemException
userGroupId
- the primary key of the user groupuserIds
- the primary keys of the users
PortalException
- if any one of the users could not be found or
if a portal exception occurred
SystemException
- if a system exception occurredpublic void copyUserGroupLayouts(long[] userGroupIds, long userId) throws PortalException, SystemException
userGroupIds
- the primary keys of the user groupsuserId
- the primary key of the user
PortalException
- if a user with the primary key could not be
found or if a portal exception occurred
SystemException
- if a system exception occurredpublic UserGroup deleteUserGroup(long userGroupId) throws PortalException, SystemException
deleteUserGroup
in interface UserGroupLocalService
deleteUserGroup
in class UserGroupLocalServiceBaseImpl
userGroupId
- the primary key of the user group
PortalException
- if a user group with the primary key could not be
found or if the user group had a workflow in approved status
SystemException
- if a system exception occurred@SystemEvent(action=1, type=1) public UserGroup deleteUserGroup(UserGroup userGroup) throws PortalException, SystemException
deleteUserGroup
in interface UserGroupLocalService
deleteUserGroup
in class UserGroupLocalServiceBaseImpl
userGroup
- the user group
PortalException
- if the organization had a workflow in approved
status
SystemException
- if a system exception occurredpublic void deleteUserGroups(long companyId) throws PortalException, SystemException
PortalException
SystemException
public UserGroup fetchUserGroup(long companyId, String name) throws SystemException
SystemException
public UserGroup getUserGroup(long companyId, String name) throws PortalException, SystemException
companyId
- the primary key of the user group's companyname
- the user group's name
PortalException
- if a user group with the name could not be found
SystemException
- if a system exception occurredpublic List<UserGroup> getUserGroups(long companyId) throws SystemException
companyId
- the primary key of the user groups' company
SystemException
- if a system exception occurredpublic List<UserGroup> getUserGroups(long[] userGroupIds) throws PortalException, SystemException
userGroupIds
- the primary keys of the user groups
PortalException
- if any one of the user groups could not be found
SystemException
- if a system exception occurredpublic List<UserGroup> 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 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
start
- 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
)
obc
SystemException
- if a system exception occurredUserGroupFinder
public Hits search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, Sort sort) 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 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 UserGroupIndexer
start
- 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
)
SystemException
- if a system exception occurredUserGroupIndexer
public Hits search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, Sort sort) 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 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 UserGroupIndexer
andSearch
- 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
)
SystemException
- if a system exception occurredUserGroupFinder
public int searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params) throws SystemException
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
SystemException
- if a system exception occurredUserGroupFinder
public void setUserUserGroups(long userId, long[] userGroupIds) throws PortalException, SystemException
setUserUserGroups
in interface UserGroupLocalService
setUserUserGroups
in class UserGroupLocalServiceBaseImpl
userId
- the primary key of the useruserGroupIds
- the primary keys of the user groups
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic void unsetGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups
SystemException
- if a system exception occurredpublic void unsetTeamUserGroups(long teamId, long[] userGroupIds) throws SystemException
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups
SystemException
- if a system exception occurredpublic UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description) throws PortalException, SystemException
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
- if a user group with the primary key could
not be found or if the new information was invalid
SystemException
- if a system exception occurredpublic UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description, ServiceContext serviceContext) throws PortalException, SystemException
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
- if a user group with the primary key could not be
found or if the new information was invalid
SystemException
- if a system exception occurredprotected File[] exportLayouts(long userGroupId, Map<String,String[]> parameterMap) throws PortalException, SystemException
PortalException
SystemException
protected Map<String,String[]> getLayoutTemplatesParameters()
protected void importLayouts(long userId, Map<String,String[]> parameterMap, File privateLayoutsFile, File publicLayoutsFile) throws PortalException, SystemException
PortalException
SystemException
protected void validate(long userGroupId, long companyId, String name) throws PortalException, SystemException
PortalException
SystemException
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |