|
Liferay 6.1.10-ee-ga1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.liferay.portal.service.UserGroupLocalServiceWrapper
public class UserGroupLocalServiceWrapper
This class is a wrapper for UserGroupLocalService
.
UserGroupLocalService
Constructor Summary | |
---|---|
UserGroupLocalServiceWrapper(UserGroupLocalService userGroupLocalService)
|
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)
Adds a user group. |
UserGroup |
addUserGroup(UserGroup userGroup)
Adds the user group to the database. |
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. |
void |
copyUserGroupLayouts(long userGroupId,
long userId)
Deprecated. |
void |
copyUserGroupLayouts(long userGroupId,
long[] userIds)
Deprecated. |
UserGroup |
createUserGroup(long userGroupId)
Creates a new user group with the primary key. |
void |
deleteUserGroup(long userGroupId)
Deletes the user group with the primary key from the database. |
void |
deleteUserGroup(UserGroup userGroup)
Deletes the user group from the database. |
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. |
UserGroup |
fetchUserGroup(long userGroupId)
|
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
UserGroup |
getUserGroup(long userGroupId)
Returns the user group with the primary key. |
UserGroup |
getUserGroup(long companyId,
String name)
Returns the user group with the name. |
List<UserGroup> |
getUserGroups(int start,
int end)
Returns a range of all the user groups. |
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. |
int |
getUserGroupsCount()
Returns the number of user groups. |
List<UserGroup> |
getUserUserGroups(long userId)
Returns all the user groups to which the user belongs. |
UserGroupLocalService |
getWrappedService()
|
UserGroupLocalService |
getWrappedUserGroupLocalService()
Deprecated. Renamed to getWrappedService() |
boolean |
hasGroupUserGroup(long groupId,
long userGroupId)
Returns true if the user group is associated with the group. |
boolean |
hasTeamUserGroup(long teamId,
long userGroupId)
Returns true if the user group belongs to the team. |
List<UserGroup> |
search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
|
List<UserGroup> |
search(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
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)
|
int |
searchCount(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params)
Returns the number of user groups that match the name and description. |
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
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 |
setWrappedService(UserGroupLocalService userGroupLocalService)
|
void |
setWrappedUserGroupLocalService(UserGroupLocalService userGroupLocalService)
Deprecated. Renamed to setWrappedService(com.liferay.portal.service.UserGroupLocalService) |
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)
Updates the user group. |
UserGroup |
updateUserGroup(UserGroup userGroup)
Updates the user group in the database or adds it if it does not yet exist. |
UserGroup |
updateUserGroup(UserGroup userGroup,
boolean merge)
Updates the user group in the database or adds it if it does not yet exist. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UserGroupLocalServiceWrapper(UserGroupLocalService userGroupLocalService)
Method Detail |
---|
public UserGroup addUserGroup(UserGroup userGroup) throws SystemException
addUserGroup
in interface UserGroupLocalService
userGroup
- the user group
SystemException
- if a system exception occurredpublic UserGroup createUserGroup(long userGroupId)
createUserGroup
in interface UserGroupLocalService
userGroupId
- the primary key for the new user group
public void deleteUserGroup(long userGroupId) throws PortalException, SystemException
deleteUserGroup
in interface UserGroupLocalService
userGroupId
- the primary key of the user group
PortalException
- if a user group with the primary key could not be found
SystemException
- if a system exception occurredpublic void deleteUserGroup(UserGroup userGroup) throws PortalException, SystemException
deleteUserGroup
in interface UserGroupLocalService
userGroup
- the user group
PortalException
SystemException
- if a system exception occurredpublic List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
in interface UserGroupLocalService
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic 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
in interface UserGroupLocalService
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 occurredpublic 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
in interface UserGroupLocalService
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 occurredpublic long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQueryCount
in interface UserGroupLocalService
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic UserGroup fetchUserGroup(long userGroupId) throws SystemException
fetchUserGroup
in interface UserGroupLocalService
SystemException
public UserGroup getUserGroup(long userGroupId) throws PortalException, SystemException
getUserGroup
in interface UserGroupLocalService
userGroupId
- the primary key of the user group
PortalException
- if a user group with the primary key could not be found
SystemException
- if a system exception occurredpublic PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
getPersistedModel
in interface PersistedModelLocalService
getPersistedModel
in interface UserGroupLocalService
PortalException
SystemException
public List<UserGroup> getUserGroups(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.
getUserGroups
in interface UserGroupLocalService
start
- the lower bound of the range of user groupsend
- the upper bound of the range of user groups (not inclusive)
SystemException
- if a system exception occurredpublic int getUserGroupsCount() throws SystemException
getUserGroupsCount
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic UserGroup updateUserGroup(UserGroup userGroup) throws SystemException
updateUserGroup
in interface UserGroupLocalService
userGroup
- the user group
SystemException
- if a system exception occurredpublic UserGroup updateUserGroup(UserGroup userGroup, boolean merge) throws SystemException
updateUserGroup
in interface UserGroupLocalService
userGroup
- the user groupmerge
- whether to merge the user group with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)
for an explanation.
SystemException
- if a system exception occurredpublic String getBeanIdentifier()
getBeanIdentifier
in interface UserGroupLocalService
public void setBeanIdentifier(String beanIdentifier)
setBeanIdentifier
in interface UserGroupLocalService
beanIdentifier
- the Spring bean ID for this beanpublic void addGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
addGroupUserGroups
in interface UserGroupLocalService
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
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
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.
addUserGroup
in interface UserGroupLocalService
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 void clearUserUserGroups(long userId) throws SystemException
This method is called from deleteUserGroup(UserGroup)
.
clearUserUserGroups
in interface UserGroupLocalService
userId
- the primary key of the user
SystemException
- if a system exception occurredpublic void copyUserGroupLayouts(long userGroupId, long[] userIds) throws PortalException, SystemException
copyUserGroupLayouts
in interface UserGroupLocalService
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
copyUserGroupLayouts
in interface UserGroupLocalService
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 void copyUserGroupLayouts(long userGroupId, long userId) throws PortalException, SystemException
copyUserGroupLayouts
in interface UserGroupLocalService
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 UserGroup getUserGroup(long companyId, String name) throws PortalException, SystemException
getUserGroup
in interface UserGroupLocalService
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
getUserGroups
in interface UserGroupLocalService
companyId
- the primary key of the user groups' company
SystemException
- if a system exception occurredpublic List<UserGroup> getUserGroups(long[] userGroupIds) throws PortalException, SystemException
getUserGroups
in interface UserGroupLocalService
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> getUserUserGroups(long userId) throws SystemException
getUserUserGroups
in interface UserGroupLocalService
userId
- the primary key of the user
SystemException
- if a system exception occurredpublic boolean hasGroupUserGroup(long groupId, long userGroupId) throws SystemException
true
if the user group is associated with the group.
hasGroupUserGroup
in interface UserGroupLocalService
groupId
- the primary key of the groupuserGroupId
- the primary key of the user group
true
if the user group belongs to the group;
false
otherwise
SystemException
- if a system exception occurredpublic boolean hasTeamUserGroup(long teamId, long userGroupId) throws SystemException
true
if the user group belongs to the team.
hasTeamUserGroup
in interface UserGroupLocalService
teamId
- the primary key of the teamuserGroupId
- the primary key of the user group
true
if the user group belongs to the team;
false
otherwise
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
search
in interface UserGroupLocalService
SystemException
public List<UserGroup> search(long companyId, String name, String description, 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.
search
in interface UserGroupLocalService
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 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 int searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params) throws SystemException
searchCount
in interface UserGroupLocalService
SystemException
public int searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params) throws SystemException
searchCount
in interface UserGroupLocalService
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 UserGroupFinder
SystemException
- if a system exception occurredUserGroupFinder
public void setUserUserGroups(long userId, long[] userGroupIds) throws PortalException, SystemException
setUserUserGroups
in interface UserGroupLocalService
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
unsetGroupUserGroups
in interface UserGroupLocalService
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
unsetTeamUserGroups
in interface UserGroupLocalService
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
in interface UserGroupLocalService
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 UserGroupLocalService getWrappedUserGroupLocalService()
getWrappedService()
public void setWrappedUserGroupLocalService(UserGroupLocalService userGroupLocalService)
setWrappedService(com.liferay.portal.service.UserGroupLocalService)
public UserGroupLocalService getWrappedService()
getWrappedService
in interface ServiceWrapper<UserGroupLocalService>
public void setWrappedService(UserGroupLocalService userGroupLocalService)
setWrappedService
in interface ServiceWrapper<UserGroupLocalService>
|
Liferay 6.1.10-ee-ga1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |