Liferay 6.2-ce-ga5

com.liferay.portal.service
Class UserGroupLocalServiceWrapper

java.lang.Object
  extended by com.liferay.portal.service.UserGroupLocalServiceWrapper
All Implemented Interfaces:
BaseLocalService, PersistedModelLocalService, ServiceWrapper<UserGroupLocalService>, UserGroupLocalService

@ProviderType
public class UserGroupLocalServiceWrapper
extends Object
implements UserGroupLocalService, ServiceWrapper<UserGroupLocalService>

Provides a wrapper for UserGroupLocalService.

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

Constructor Summary
UserGroupLocalServiceWrapper(UserGroupLocalService userGroupLocalService)
           
 
Method Summary
 void addGroupUserGroup(long groupId, long userGroupId)
           
 void addGroupUserGroup(long groupId, UserGroup userGroup)
           
 void addGroupUserGroups(long groupId, List<UserGroup> UserGroups)
           
 void addGroupUserGroups(long groupId, long[] userGroupIds)
           
 void addTeamUserGroup(long teamId, long userGroupId)
           
 void addTeamUserGroup(long teamId, UserGroup userGroup)
           
 void addTeamUserGroups(long teamId, List<UserGroup> UserGroups)
           
 void addTeamUserGroups(long teamId, long[] userGroupIds)
           
 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.
 UserGroup addUserGroup(UserGroup userGroup)
          Adds the user group to the database.
 void addUserUserGroup(long userId, long userGroupId)
           
 void addUserUserGroup(long userId, UserGroup userGroup)
           
 void addUserUserGroups(long userId, List<UserGroup> UserGroups)
           
 void addUserUserGroups(long userId, long[] userGroupIds)
           
 void clearGroupUserGroups(long groupId)
           
 void clearTeamUserGroups(long teamId)
           
 void clearUserUserGroups(long userId)
           
 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 createUserGroup(long userGroupId)
          Creates a new user group with the primary key.
 void deleteGroupUserGroup(long groupId, long userGroupId)
           
 void deleteGroupUserGroup(long groupId, UserGroup userGroup)
           
 void deleteGroupUserGroups(long groupId, List<UserGroup> UserGroups)
           
 void deleteGroupUserGroups(long groupId, long[] userGroupIds)
           
 void deleteTeamUserGroup(long teamId, long userGroupId)
           
 void deleteTeamUserGroup(long teamId, UserGroup userGroup)
           
 void deleteTeamUserGroups(long teamId, List<UserGroup> UserGroups)
           
 void deleteTeamUserGroups(long teamId, long[] userGroupIds)
           
 UserGroup deleteUserGroup(long userGroupId)
          Deletes the user group with the primary key from the database.
 UserGroup deleteUserGroup(UserGroup userGroup)
          Deletes the user group from the database.
 void deleteUserGroups(long companyId)
           
 void deleteUserUserGroup(long userId, long userGroupId)
           
 void deleteUserUserGroup(long userId, UserGroup userGroup)
           
 void deleteUserUserGroups(long userId, List<UserGroup> UserGroups)
           
 void deleteUserUserGroups(long userId, long[] userGroupIds)
           
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 UserGroup fetchUserGroup(long userGroupId)
           
 UserGroup fetchUserGroup(long companyId, String name)
           
 UserGroup fetchUserGroupByUuidAndCompanyId(String uuid, long companyId)
          Returns the user group with the matching UUID and company.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<UserGroup> getGroupUserGroups(long groupId)
           
 List<UserGroup> getGroupUserGroups(long groupId, int start, int end)
           
 List<UserGroup> getGroupUserGroups(long groupId, int start, int end, OrderByComparator orderByComparator)
           
 int getGroupUserGroupsCount(long groupId)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<UserGroup> getTeamUserGroups(long teamId)
           
 List<UserGroup> getTeamUserGroups(long teamId, int start, int end)
           
 List<UserGroup> getTeamUserGroups(long teamId, int start, int end, OrderByComparator orderByComparator)
           
 int getTeamUserGroupsCount(long teamId)
           
 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.
 UserGroup getUserGroupByUuidAndCompanyId(String uuid, long companyId)
          Returns the user group with the matching UUID and company.
 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)
           
 List<UserGroup> getUserUserGroups(long userId, int start, int end)
           
 List<UserGroup> getUserUserGroups(long userId, int start, int end, OrderByComparator orderByComparator)
           
 int getUserUserGroupsCount(long userId)
           
 UserGroupLocalService getWrappedService()
           
 UserGroupLocalService getWrappedUserGroupLocalService()
          Deprecated. As of 6.1.0, replaced by getWrappedService()
 boolean hasGroupUserGroup(long groupId, long userGroupId)
           
 boolean hasGroupUserGroups(long groupId)
           
 boolean hasTeamUserGroup(long teamId, long userGroupId)
           
 boolean hasTeamUserGroups(long teamId)
           
 boolean hasUserUserGroup(long userId, long userGroupId)
           
 boolean hasUserUserGroups(long userId)
           
 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 setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setGroupUserGroups(long groupId, long[] userGroupIds)
           
 void setTeamUserGroups(long teamId, long[] userGroupIds)
           
 void setUserUserGroups(long userId, long[] userGroupIds)
           
 void setWrappedService(UserGroupLocalService userGroupLocalService)
           
 void setWrappedUserGroupLocalService(UserGroupLocalService userGroupLocalService)
          Deprecated. As of 6.1.0, replaced by 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)
          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.
 UserGroup updateUserGroup(UserGroup userGroup)
          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

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
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 UserGroup 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
Returns:
the user group that was removed
Throws:
PortalException - if a user group with the primary key could not be found
SystemException - if a system exception occurred

deleteUserGroup

public UserGroup deleteUserGroup(UserGroup userGroup)
                          throws PortalException,
                                 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
Returns:
the user group that was removed
Throws:
PortalException
SystemException - if a system exception occurred

dynamicQuery

public DynamicQuery dynamicQuery()
Specified by:
dynamicQuery in interface UserGroupLocalService

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
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserGroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:
dynamicQuery in interface UserGroupLocalService
Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserGroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

dynamicQueryCount

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

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

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

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

fetchUserGroup

public UserGroup fetchUserGroup(long userGroupId)
                         throws SystemException
Specified by:
fetchUserGroup in interface UserGroupLocalService
Throws:
SystemException

fetchUserGroupByUuidAndCompanyId

public UserGroup fetchUserGroupByUuidAndCompanyId(String uuid,
                                                  long companyId)
                                           throws SystemException
Returns the user group with the matching UUID and company.

Specified by:
fetchUserGroupByUuidAndCompanyId in interface UserGroupLocalService
Parameters:
uuid - the user group's UUID
companyId - the primary key of the company
Returns:
the matching user group, or null if a matching user group could not be found
Throws:
SystemException - if a system exception occurred

getUserGroup

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

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

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Specified by:
getPersistedModel in interface UserGroupLocalService
Throws:
PortalException
SystemException

getUserGroupByUuidAndCompanyId

public UserGroup getUserGroupByUuidAndCompanyId(String uuid,
                                                long companyId)
                                         throws PortalException,
                                                SystemException
Returns the user group with the matching UUID and company.

Specified by:
getUserGroupByUuidAndCompanyId in interface UserGroupLocalService
Parameters:
uuid - the user group's UUID
companyId - the primary key of the company
Returns:
the matching user group
Throws:
PortalException - if a matching user group could not be found
SystemException - if a system exception occurred

getUserGroups

public List<UserGroup> getUserGroups(int start,
                                     int end)
                              throws SystemException
Returns 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from UserGroupModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

getUserGroupsCount

public int getUserGroupsCount()
                       throws SystemException
Returns 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 or adds it if it does not yet exist. Also notifies the appropriate model listeners.

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

addGroupUserGroup

public void addGroupUserGroup(long groupId,
                              long userGroupId)
                       throws SystemException
Specified by:
addGroupUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

addGroupUserGroup

public void addGroupUserGroup(long groupId,
                              UserGroup userGroup)
                       throws SystemException
Specified by:
addGroupUserGroup in interface UserGroupLocalService
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 - if a system exception occurred

addGroupUserGroups

public void addGroupUserGroups(long groupId,
                               List<UserGroup> UserGroups)
                        throws SystemException
Specified by:
addGroupUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

clearGroupUserGroups

public void clearGroupUserGroups(long groupId)
                          throws SystemException
Specified by:
clearGroupUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroup

public void deleteGroupUserGroup(long groupId,
                                 long userGroupId)
                          throws SystemException
Specified by:
deleteGroupUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroup

public void deleteGroupUserGroup(long groupId,
                                 UserGroup userGroup)
                          throws SystemException
Specified by:
deleteGroupUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroups

public void deleteGroupUserGroups(long groupId,
                                  long[] userGroupIds)
                           throws SystemException
Specified by:
deleteGroupUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroups

public void deleteGroupUserGroups(long groupId,
                                  List<UserGroup> UserGroups)
                           throws SystemException
Specified by:
deleteGroupUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getGroupUserGroups

public List<UserGroup> getGroupUserGroups(long groupId)
                                   throws SystemException
Specified by:
getGroupUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getGroupUserGroups

public List<UserGroup> getGroupUserGroups(long groupId,
                                          int start,
                                          int end)
                                   throws SystemException
Specified by:
getGroupUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getGroupUserGroups

public List<UserGroup> getGroupUserGroups(long groupId,
                                          int start,
                                          int end,
                                          OrderByComparator orderByComparator)
                                   throws SystemException
Specified by:
getGroupUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getGroupUserGroupsCount

public int getGroupUserGroupsCount(long groupId)
                            throws SystemException
Specified by:
getGroupUserGroupsCount in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

hasGroupUserGroup

public boolean hasGroupUserGroup(long groupId,
                                 long userGroupId)
                          throws SystemException
Specified by:
hasGroupUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

hasGroupUserGroups

public boolean hasGroupUserGroups(long groupId)
                           throws SystemException
Specified by:
hasGroupUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

setGroupUserGroups

public void setGroupUserGroups(long groupId,
                               long[] userGroupIds)
                        throws SystemException
Specified by:
setGroupUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

addTeamUserGroup

public void addTeamUserGroup(long teamId,
                             long userGroupId)
                      throws SystemException
Specified by:
addTeamUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

addTeamUserGroup

public void addTeamUserGroup(long teamId,
                             UserGroup userGroup)
                      throws SystemException
Specified by:
addTeamUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

addTeamUserGroups

public void addTeamUserGroups(long teamId,
                              long[] userGroupIds)
                       throws SystemException
Specified by:
addTeamUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

addTeamUserGroups

public void addTeamUserGroups(long teamId,
                              List<UserGroup> UserGroups)
                       throws SystemException
Specified by:
addTeamUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

clearTeamUserGroups

public void clearTeamUserGroups(long teamId)
                         throws SystemException
Specified by:
clearTeamUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroup

public void deleteTeamUserGroup(long teamId,
                                long userGroupId)
                         throws SystemException
Specified by:
deleteTeamUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroup

public void deleteTeamUserGroup(long teamId,
                                UserGroup userGroup)
                         throws SystemException
Specified by:
deleteTeamUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroups

public void deleteTeamUserGroups(long teamId,
                                 long[] userGroupIds)
                          throws SystemException
Specified by:
deleteTeamUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroups

public void deleteTeamUserGroups(long teamId,
                                 List<UserGroup> UserGroups)
                          throws SystemException
Specified by:
deleteTeamUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getTeamUserGroups

public List<UserGroup> getTeamUserGroups(long teamId)
                                  throws SystemException
Specified by:
getTeamUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getTeamUserGroups

public List<UserGroup> getTeamUserGroups(long teamId,
                                         int start,
                                         int end)
                                  throws SystemException
Specified by:
getTeamUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getTeamUserGroups

public List<UserGroup> getTeamUserGroups(long teamId,
                                         int start,
                                         int end,
                                         OrderByComparator orderByComparator)
                                  throws SystemException
Specified by:
getTeamUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getTeamUserGroupsCount

public int getTeamUserGroupsCount(long teamId)
                           throws SystemException
Specified by:
getTeamUserGroupsCount in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

hasTeamUserGroup

public boolean hasTeamUserGroup(long teamId,
                                long userGroupId)
                         throws SystemException
Specified by:
hasTeamUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

hasTeamUserGroups

public boolean hasTeamUserGroups(long teamId)
                          throws SystemException
Specified by:
hasTeamUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

setTeamUserGroups

public void setTeamUserGroups(long teamId,
                              long[] userGroupIds)
                       throws SystemException
Specified by:
setTeamUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

addUserUserGroup

public void addUserUserGroup(long userId,
                             long userGroupId)
                      throws SystemException
Specified by:
addUserUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

addUserUserGroup

public void addUserUserGroup(long userId,
                             UserGroup userGroup)
                      throws SystemException
Specified by:
addUserUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

addUserUserGroups

public void addUserUserGroups(long userId,
                              long[] userGroupIds)
                       throws SystemException
Specified by:
addUserUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

addUserUserGroups

public void addUserUserGroups(long userId,
                              List<UserGroup> UserGroups)
                       throws SystemException
Specified by:
addUserUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

clearUserUserGroups

public void clearUserUserGroups(long userId)
                         throws SystemException
Specified by:
clearUserUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteUserUserGroup

public void deleteUserUserGroup(long userId,
                                long userGroupId)
                         throws SystemException
Specified by:
deleteUserUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteUserUserGroup

public void deleteUserUserGroup(long userId,
                                UserGroup userGroup)
                         throws SystemException
Specified by:
deleteUserUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteUserUserGroups

public void deleteUserUserGroups(long userId,
                                 long[] userGroupIds)
                          throws SystemException
Specified by:
deleteUserUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

deleteUserUserGroups

public void deleteUserUserGroups(long userId,
                                 List<UserGroup> UserGroups)
                          throws SystemException
Specified by:
deleteUserUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getUserUserGroups

public List<UserGroup> getUserUserGroups(long userId)
                                  throws SystemException
Specified by:
getUserUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getUserUserGroups

public List<UserGroup> getUserUserGroups(long userId,
                                         int start,
                                         int end)
                                  throws SystemException
Specified by:
getUserUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getUserUserGroups

public List<UserGroup> getUserUserGroups(long userId,
                                         int start,
                                         int end,
                                         OrderByComparator orderByComparator)
                                  throws SystemException
Specified by:
getUserUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

getUserUserGroupsCount

public int getUserUserGroupsCount(long userId)
                           throws SystemException
Specified by:
getUserUserGroupsCount in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

hasUserUserGroup

public boolean hasUserUserGroup(long userId,
                                long userGroupId)
                         throws SystemException
Specified by:
hasUserUserGroup in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

hasUserUserGroups

public boolean hasUserUserGroups(long userId)
                          throws SystemException
Specified by:
hasUserUserGroups in interface UserGroupLocalService
Throws:
SystemException - if a system exception occurred

setUserUserGroups

public void setUserUserGroups(long userId,
                              long[] userGroupIds)
                       throws PortalException,
                              SystemException
Specified by:
setUserUserGroups in interface UserGroupLocalService
Throws:
PortalException
SystemException - if a system exception occurred

getBeanIdentifier

public String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Specified by:
getBeanIdentifier in interface UserGroupLocalService
Returns:
the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Specified by:
setBeanIdentifier in interface UserGroupLocalService
Parameters:
beanIdentifier - the Spring bean ID for this bean

addUserGroup

public UserGroup addUserGroup(long userId,
                              long companyId,
                              String name,
                              String description)
                       throws PortalException,
                              SystemException
Deprecated. As of 6.2.0, replaced by addUserGroup(long, long, String, String, ServiceContext)

Adds a user group.

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.

Specified by:
addUserGroup in interface UserGroupLocalService
Parameters:
userId - the primary key of the user
companyId - the primary key of the user group's company
name - the user group's name
description - the user group's description
Returns:
the user group
Throws:
PortalException - if the user group's information was invalid
SystemException - if a system exception occurred

addUserGroup

public UserGroup addUserGroup(long userId,
                              long companyId,
                              String name,
                              String description,
                              ServiceContext serviceContext)
                       throws PortalException,
                              SystemException
Adds a user group.

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.

Specified by:
addUserGroup in interface UserGroupLocalService
Parameters:
userId - the primary key of the user
companyId - the primary key of the user group's company
name - the user group's name
description - the user group's description
serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user group.
Returns:
the user group
Throws:
PortalException - if the user group's information was invalid
SystemException - if a system exception occurred

copyUserGroupLayouts

public void copyUserGroupLayouts(long userGroupId,
                                 long userId)
                          throws PortalException,
                                 SystemException
Deprecated. As of 6.2.0

Copies the user group's layout to the user.

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

copyUserGroupLayouts

public void copyUserGroupLayouts(long userGroupId,
                                 long[] userIds)
                          throws PortalException,
                                 SystemException
Deprecated. As of 6.1.0

Copies the user group's layouts to the users who are not already members of the user group.

Specified by:
copyUserGroupLayouts in interface UserGroupLocalService
Parameters:
userGroupId - the primary key of the user group
userIds - the primary keys of the users
Throws:
PortalException - if any one of the users could not be found or if a portal exception occurred
SystemException - if a system exception occurred

copyUserGroupLayouts

public void copyUserGroupLayouts(long[] userGroupIds,
                                 long userId)
                          throws PortalException,
                                 SystemException
Deprecated. As of 6.1.0

Copies the user groups' layouts to the user.

Specified by:
copyUserGroupLayouts in interface UserGroupLocalService
Parameters:
userGroupIds - the primary keys of the user groups
userId - the primary key of the user
Throws:
PortalException - if a user with the primary key could not be found or if a portal exception occurred
SystemException - if a system exception occurred

deleteUserGroups

public void deleteUserGroups(long companyId)
                      throws PortalException,
                             SystemException
Specified by:
deleteUserGroups in interface UserGroupLocalService
Throws:
PortalException
SystemException

fetchUserGroup

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

getUserGroup

public UserGroup getUserGroup(long companyId,
                              String name)
                       throws PortalException,
                              SystemException
Returns the user group with the name.

Specified by:
getUserGroup in interface UserGroupLocalService
Parameters:
companyId - the primary key of the user group's company
name - the user group's name
Returns:
Returns the user group with the name
Throws:
PortalException - if a user group with the name could not be found
SystemException - if a system exception occurred

getUserGroups

public List<UserGroup> getUserGroups(long companyId)
                              throws SystemException
Returns all the user groups belonging to the company.

Specified by:
getUserGroups in interface UserGroupLocalService
Parameters:
companyId - the primary key of the user groups' company
Returns:
the user groups belonging to the company
Throws:
SystemException - if a system exception occurred

getUserGroups

public List<UserGroup> getUserGroups(long[] userGroupIds)
                              throws PortalException,
                                     SystemException
Returns all the user groups with the primary keys.

Specified by:
getUserGroups in interface UserGroupLocalService
Parameters:
userGroupIds - the primary keys of the user groups
Returns:
the user groups with the primary keys
Throws:
PortalException - if any one of the user groups could not be found
SystemException - if a system exception occurred

search

public List<UserGroup> search(long companyId,
                              String keywords,
                              LinkedHashMap<String,Object> params,
                              int start,
                              int end,
                              OrderByComparator obc)
                       throws SystemException
Returns an ordered range of all the user groups that match the keywords.

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:
search in interface UserGroupLocalService
Parameters:
companyId - the primary key of the user group's company
keywords - 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 return
end - the upper bound of the range of user groups to return (not inclusive)
obc - the comparator to order the user groups (optionally null)
Returns:
the matching user groups ordered by comparator obc
Throws:
SystemException - if a system exception occurred
See Also:
UserGroupFinder

search

public Hits search(long companyId,
                   String keywords,
                   LinkedHashMap<String,Object> params,
                   int start,
                   int end,
                   Sort sort)
            throws SystemException
Returns an ordered range of all the user groups that match the keywords, using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

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:
search in interface UserGroupLocalService
Parameters:
companyId - the primary key of the user group's company
keywords - 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 return
end - the upper bound of the range of user groups to return (not inclusive)
sort - the field and direction by which to sort (optionally null)
Returns:
the matching user groups ordered by sort
Throws:
SystemException - if a system exception occurred
See Also:
UserGroupIndexer

search

public Hits search(long companyId,
                   String name,
                   String description,
                   LinkedHashMap<String,Object> params,
                   boolean andSearch,
                   int start,
                   int end,
                   Sort sort)
            throws SystemException
Returns an ordered range of all the user groups that match the name and description. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

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:
search in interface UserGroupLocalService
Parameters:
companyId - the primary key of the user group's company
name - 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 field
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)
sort - the field and direction by which to sort (optionally null)
Returns:
the matching user groups ordered by sort
Throws:
SystemException - if a system exception occurred
See Also:
UserGroupFinder

searchCount

public int searchCount(long companyId,
                       String keywords,
                       LinkedHashMap<String,Object> params)
                throws SystemException
Returns the number of user groups that match the keywords

Specified by:
searchCount in interface UserGroupLocalService
Parameters:
companyId - the primary key of the user group's company
keywords - 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
Returns:
the number of matching user groups
Throws:
SystemException - if a system exception occurred
See Also:
UserGroupFinder

unsetGroupUserGroups

public void unsetGroupUserGroups(long groupId,
                                 long[] userGroupIds)
                          throws SystemException
Removes the user groups from the group.

Specified by:
unsetGroupUserGroups in interface UserGroupLocalService
Parameters:
groupId - the primary key of the group
userGroupIds - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

unsetTeamUserGroups

public void unsetTeamUserGroups(long teamId,
                                long[] userGroupIds)
                         throws SystemException
Removes the user groups from the team.

Specified by:
unsetTeamUserGroups in interface UserGroupLocalService
Parameters:
teamId - the primary key of the team
userGroupIds - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

updateUserGroup

public UserGroup updateUserGroup(long companyId,
                                 long userGroupId,
                                 String name,
                                 String description)
                          throws PortalException,
                                 SystemException
Deprecated. As of 6.2.0, replaced by updateUserGroup(long, long, String, String, ServiceContext)

Updates the user group.

Specified by:
updateUserGroup in interface UserGroupLocalService
Parameters:
companyId - the primary key of the user group's company
userGroupId - the primary key of the user group
name - the user group's name
description - the user group's description
Returns:
the user group
Throws:
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 occurred

updateUserGroup

public UserGroup updateUserGroup(long companyId,
                                 long userGroupId,
                                 String name,
                                 String description,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Updates the user group.

Specified by:
updateUserGroup in interface UserGroupLocalService
Parameters:
companyId - the primary key of the user group's company
userGroupId - the primary key of the user group
name - the user group's name
description - the user group's description
serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user group.
Returns:
the user group
Throws:
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 occurred

getWrappedUserGroupLocalService

public UserGroupLocalService getWrappedUserGroupLocalService()
Deprecated. As of 6.1.0, replaced by getWrappedService()


setWrappedUserGroupLocalService

public void setWrappedUserGroupLocalService(UserGroupLocalService userGroupLocalService)
Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.UserGroupLocalService)


getWrappedService

public UserGroupLocalService getWrappedService()
Specified by:
getWrappedService in interface ServiceWrapper<UserGroupLocalService>

setWrappedService

public void setWrappedService(UserGroupLocalService userGroupLocalService)
Specified by:
setWrappedService in interface ServiceWrapper<UserGroupLocalService>

Liferay 6.2-ce-ga5