Liferay 6.0.5

com.liferay.portal.service
Class UserGroupLocalServiceWrapper

java.lang.Object
  extended by com.liferay.portal.service.UserGroupLocalServiceWrapper
All Implemented Interfaces:
UserGroupLocalService

public class UserGroupLocalServiceWrapper
extends Object
implements UserGroupLocalService

This class is a wrapper for UserGroupLocalService.

See Also:
UserGroupLocalService
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
UserGroupLocalServiceWrapper(UserGroupLocalService userGroupLocalService)
           
 
Method Summary
 void addGroupUserGroups(long groupId, long[] userGroupIds)
           
 UserGroup addUserGroup(long userId, long companyId, String name, String description)
           
 UserGroup addUserGroup(UserGroup userGroup)
          Adds the user group to the database.
 void clearUserUserGroups(long userId)
           
 void copyUserGroupLayouts(long[] userGroupIds, long userId)
           
 void copyUserGroupLayouts(long userGroupId, long userId)
           
 void copyUserGroupLayouts(long userGroupId, long[] userIds)
           
 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)
          Counts the number of rows that match the dynamic query.
 UserGroup getUserGroup(long userGroupId)
          Gets the user group with the primary key.
 UserGroup getUserGroup(long companyId, String name)
           
 List<UserGroup> getUserGroups(int start, int end)
          Gets a range of all the user groups.
 List<UserGroup> getUserGroups(long companyId)
           
 List<UserGroup> getUserGroups(long[] userGroupIds)
           
 int getUserGroupsCount()
          Gets the number of user groups.
 List<UserGroup> getUserUserGroups(long userId)
           
 UserGroupLocalService getWrappedUserGroupLocalService()
           
 boolean hasGroupUserGroup(long groupId, long userGroupId)
           
 List<UserGroup> search(long companyId, String name, String description, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)
           
 int searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params)
           
 void setUserUserGroups(long userId, long[] userGroupIds)
           
 void unsetGroupUserGroups(long groupId, long[] userGroupIds)
           
 UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description)
           
 UserGroup updateUserGroup(UserGroup userGroup)
          Updates the user group in the database.
 UserGroup updateUserGroup(UserGroup userGroup, boolean merge)
          Updates the user group in the database.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserGroupLocalServiceWrapper

public UserGroupLocalServiceWrapper(UserGroupLocalService userGroupLocalService)
Method Detail

addUserGroup

public UserGroup addUserGroup(UserGroup userGroup)
                       throws SystemException
Adds the user group to the database. Also notifies the appropriate model listeners.

Specified by:
addUserGroup in interface UserGroupLocalService
Parameters:
userGroup - the user group to add
Returns:
the user group that was added
Throws:
SystemException - if a system exception occurred

createUserGroup

public UserGroup createUserGroup(long userGroupId)
Creates a new user group with the primary key. Does not add the user group to the database.

Specified by:
createUserGroup in interface UserGroupLocalService
Parameters:
userGroupId - the primary key for the new user group
Returns:
the new user group

deleteUserGroup

public void deleteUserGroup(long userGroupId)
                     throws PortalException,
                            SystemException
Deletes the user group with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:
deleteUserGroup in interface UserGroupLocalService
Parameters:
userGroupId - the primary key of the user group to delete
Throws:
PortalException - if a user group with the primary key could not be found
SystemException - if a system exception occurred

deleteUserGroup

public void deleteUserGroup(UserGroup userGroup)
                     throws SystemException
Deletes the user group from the database. Also notifies the appropriate model listeners.

Specified by:
deleteUserGroup in interface UserGroupLocalService
Parameters:
userGroup - the user group to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Specified by:
dynamicQuery in interface UserGroupLocalService
Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)
                  throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

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.

Specified by:
dynamicQuery in interface UserGroupLocalService
Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator orderByComparator)
                  throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

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.

Specified by:
dynamicQuery in interface UserGroupLocalService
Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Specified by:
dynamicQueryCount in interface UserGroupLocalService
Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getUserGroup

public UserGroup getUserGroup(long userGroupId)
                       throws PortalException,
                              SystemException
Gets the user group with the primary key.

Specified by:
getUserGroup in interface UserGroupLocalService
Parameters:
userGroupId - the primary key of the user group to get
Returns:
the user group
Throws:
PortalException - if a user group with the primary key could not be found
SystemException - if a system exception occurred

getUserGroups

public List<UserGroup> getUserGroups(int start,
                                     int end)
                              throws SystemException
Gets a range of all the user groups.

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.

Specified by:
getUserGroups in interface UserGroupLocalService
Parameters:
start - the lower bound of the range of user groups to return
end - the upper bound of the range of user groups to return (not inclusive)
Returns:
the range of user groups
Throws:
SystemException - if a system exception occurred

getUserGroupsCount

public int getUserGroupsCount()
                       throws SystemException
Gets the number of user groups.

Specified by:
getUserGroupsCount in interface UserGroupLocalService
Returns:
the number of user groups
Throws:
SystemException - if a system exception occurred

updateUserGroup

public UserGroup updateUserGroup(UserGroup userGroup)
                          throws SystemException
Updates the user group in the database. Also notifies the appropriate model listeners.

Specified by:
updateUserGroup in interface UserGroupLocalService
Parameters:
userGroup - the user group to update
Returns:
the user group that was updated
Throws:
SystemException - if a system exception occurred

updateUserGroup

public UserGroup updateUserGroup(UserGroup userGroup,
                                 boolean merge)
                          throws SystemException
Updates the user group in the database. Also notifies the appropriate model listeners.

Specified by:
updateUserGroup in interface UserGroupLocalService
Parameters:
userGroup - the user group to update
merge - 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.
Returns:
the user group that was updated
Throws:
SystemException - if a system exception occurred

addGroupUserGroups

public void addGroupUserGroups(long groupId,
                               long[] userGroupIds)
                        throws SystemException
Specified by:
addGroupUserGroups in interface UserGroupLocalService
Throws:
SystemException

addUserGroup

public UserGroup addUserGroup(long userId,
                              long companyId,
                              String name,
                              String description)
                       throws PortalException,
                              SystemException
Specified by:
addUserGroup in interface UserGroupLocalService
Throws:
PortalException
SystemException

clearUserUserGroups

public void clearUserUserGroups(long userId)
                         throws SystemException
Specified by:
clearUserUserGroups in interface UserGroupLocalService
Throws:
SystemException

copyUserGroupLayouts

public void copyUserGroupLayouts(long userGroupId,
                                 long[] userIds)
                          throws PortalException,
                                 SystemException
Specified by:
copyUserGroupLayouts in interface UserGroupLocalService
Throws:
PortalException
SystemException

copyUserGroupLayouts

public void copyUserGroupLayouts(long[] userGroupIds,
                                 long userId)
                          throws PortalException,
                                 SystemException
Specified by:
copyUserGroupLayouts in interface UserGroupLocalService
Throws:
PortalException
SystemException

copyUserGroupLayouts

public void copyUserGroupLayouts(long userGroupId,
                                 long userId)
                          throws PortalException,
                                 SystemException
Specified by:
copyUserGroupLayouts in interface UserGroupLocalService
Throws:
PortalException
SystemException

getUserGroup

public UserGroup getUserGroup(long companyId,
                              String name)
                       throws PortalException,
                              SystemException
Specified by:
getUserGroup in interface UserGroupLocalService
Throws:
PortalException
SystemException

getUserGroups

public List<UserGroup> getUserGroups(long companyId)
                              throws SystemException
Specified by:
getUserGroups in interface UserGroupLocalService
Throws:
SystemException

getUserGroups

public List<UserGroup> getUserGroups(long[] userGroupIds)
                              throws PortalException,
                                     SystemException
Specified by:
getUserGroups in interface UserGroupLocalService
Throws:
PortalException
SystemException

getUserUserGroups

public List<UserGroup> getUserUserGroups(long userId)
                                  throws SystemException
Specified by:
getUserUserGroups in interface UserGroupLocalService
Throws:
SystemException

hasGroupUserGroup

public boolean hasGroupUserGroup(long groupId,
                                 long userGroupId)
                          throws SystemException
Specified by:
hasGroupUserGroup in interface UserGroupLocalService
Throws:
SystemException

search

public List<UserGroup> search(long companyId,
                              String name,
                              String description,
                              LinkedHashMap<String,Object> params,
                              int start,
                              int end,
                              OrderByComparator obc)
                       throws SystemException
Specified by:
search in interface UserGroupLocalService
Throws:
SystemException

searchCount

public int searchCount(long companyId,
                       String name,
                       String description,
                       LinkedHashMap<String,Object> params)
                throws SystemException
Specified by:
searchCount in interface UserGroupLocalService
Throws:
SystemException

setUserUserGroups

public void setUserUserGroups(long userId,
                              long[] userGroupIds)
                       throws PortalException,
                              SystemException
Specified by:
setUserUserGroups in interface UserGroupLocalService
Throws:
PortalException
SystemException

unsetGroupUserGroups

public void unsetGroupUserGroups(long groupId,
                                 long[] userGroupIds)
                          throws SystemException
Specified by:
unsetGroupUserGroups in interface UserGroupLocalService
Throws:
SystemException

updateUserGroup

public UserGroup updateUserGroup(long companyId,
                                 long userGroupId,
                                 String name,
                                 String description)
                          throws PortalException,
                                 SystemException
Specified by:
updateUserGroup in interface UserGroupLocalService
Throws:
PortalException
SystemException

getWrappedUserGroupLocalService

public UserGroupLocalService getWrappedUserGroupLocalService()

Liferay 6.0.5