Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Liferay 6.2-ce-ga5
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.service
Interface UserGroupLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
UserGroupLocalServiceBaseImpl, UserGroupLocalServiceImpl, UserGroupLocalServiceWrapper
@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface UserGroupLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for UserGroup. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
UserGroupLocalServiceUtil, UserGroupLocalServiceBaseImpl, UserGroupLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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)
           
 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 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.
 

Method Detail

addUserGroup

@Indexable(type=REINDEX)
UserGroup addUserGroup(UserGroup userGroup)
                       throws SystemException
Adds the user group to the database. Also notifies the appropriate model listeners.

Parameters:
userGroup - the user group
Returns:
the user group that was added
Throws:
SystemException - if a system exception occurred

createUserGroup

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

Parameters:
userGroupId - the primary key for the new user group
Returns:
the new user group

deleteUserGroup

@Indexable(type=DELETE)
UserGroup deleteUserGroup(long userGroupId)
                          throws PortalException,
                                 SystemException
Deletes the user group with the primary key from the database. Also notifies the appropriate model listeners.

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

@Indexable(type=DELETE)
UserGroup deleteUserGroup(UserGroup userGroup)
                          throws PortalException,
                                 SystemException
Deletes the user group from the database. Also notifies the appropriate model listeners.

Parameters:
userGroup - the user group
Returns:
the user group that was removed
Throws:
PortalException
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

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

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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.

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

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.

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

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

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup fetchUserGroup(long userGroupId)
                         throws SystemException
Throws:
SystemException

fetchUserGroupByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup fetchUserGroupByUuidAndCompanyId(String uuid,
                                                                                    long companyId)
                                           throws SystemException
Returns the user group with the matching UUID and company.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup getUserGroup(long userGroupId)
                       throws PortalException,
                              SystemException
Returns the user group with the primary key.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getUserGroupByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup getUserGroupByUuidAndCompanyId(String uuid,
                                                                                  long companyId)
                                         throws PortalException,
                                                SystemException
Returns the user group with the matching UUID and company.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupsCount()
                       throws SystemException
Returns the number of user groups.

Returns:
the number of user groups
Throws:
SystemException - if a system exception occurred

updateUserGroup

@Indexable(type=REINDEX)
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.

Parameters:
userGroup - the user group
Returns:
the user group that was updated
Throws:
SystemException - if a system exception occurred

addGroupUserGroup

void addGroupUserGroup(long groupId,
                       long userGroupId)
                       throws SystemException
Throws:
SystemException - if a system exception occurred

addGroupUserGroup

void addGroupUserGroup(long groupId,
                       UserGroup userGroup)
                       throws SystemException
Throws:
SystemException - if a system exception occurred

addGroupUserGroups

void addGroupUserGroups(long groupId,
                        long[] userGroupIds)
                        throws SystemException
Throws:
SystemException - if a system exception occurred

addGroupUserGroups

void addGroupUserGroups(long groupId,
                        List<UserGroup> UserGroups)
                        throws SystemException
Throws:
SystemException - if a system exception occurred

clearGroupUserGroups

void clearGroupUserGroups(long groupId)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroup

void deleteGroupUserGroup(long groupId,
                          long userGroupId)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroup

void deleteGroupUserGroup(long groupId,
                          UserGroup userGroup)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroups

void deleteGroupUserGroups(long groupId,
                           long[] userGroupIds)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

deleteGroupUserGroups

void deleteGroupUserGroups(long groupId,
                           List<UserGroup> UserGroups)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getGroupUserGroups(long groupId)
                                   throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getGroupUserGroups(long groupId,
                                                                            int start,
                                                                            int end)
                                   throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getGroupUserGroups(long groupId,
                                                                            int start,
                                                                            int end,
                                                                            OrderByComparator orderByComparator)
                                   throws SystemException
Throws:
SystemException - if a system exception occurred

getGroupUserGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupUserGroupsCount(long groupId)
                            throws SystemException
Throws:
SystemException - if a system exception occurred

hasGroupUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupUserGroup(long groupId,
                                                                   long userGroupId)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

hasGroupUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupUserGroups(long groupId)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

setGroupUserGroups

void setGroupUserGroups(long groupId,
                        long[] userGroupIds)
                        throws SystemException
Throws:
SystemException - if a system exception occurred

addTeamUserGroup

void addTeamUserGroup(long teamId,
                      long userGroupId)
                      throws SystemException
Throws:
SystemException - if a system exception occurred

addTeamUserGroup

void addTeamUserGroup(long teamId,
                      UserGroup userGroup)
                      throws SystemException
Throws:
SystemException - if a system exception occurred

addTeamUserGroups

void addTeamUserGroups(long teamId,
                       long[] userGroupIds)
                       throws SystemException
Throws:
SystemException - if a system exception occurred

addTeamUserGroups

void addTeamUserGroups(long teamId,
                       List<UserGroup> UserGroups)
                       throws SystemException
Throws:
SystemException - if a system exception occurred

clearTeamUserGroups

void clearTeamUserGroups(long teamId)
                         throws SystemException
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroup

void deleteTeamUserGroup(long teamId,
                         long userGroupId)
                         throws SystemException
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroup

void deleteTeamUserGroup(long teamId,
                         UserGroup userGroup)
                         throws SystemException
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroups

void deleteTeamUserGroups(long teamId,
                          long[] userGroupIds)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

deleteTeamUserGroups

void deleteTeamUserGroups(long teamId,
                          List<UserGroup> UserGroups)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

getTeamUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getTeamUserGroups(long teamId)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

getTeamUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getTeamUserGroups(long teamId,
                                                                           int start,
                                                                           int end)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

getTeamUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getTeamUserGroups(long teamId,
                                                                           int start,
                                                                           int end,
                                                                           OrderByComparator orderByComparator)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

getTeamUserGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTeamUserGroupsCount(long teamId)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

hasTeamUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasTeamUserGroup(long teamId,
                                                                  long userGroupId)
                         throws SystemException
Throws:
SystemException - if a system exception occurred

hasTeamUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasTeamUserGroups(long teamId)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

setTeamUserGroups

void setTeamUserGroups(long teamId,
                       long[] userGroupIds)
                       throws SystemException
Throws:
SystemException - if a system exception occurred

addUserUserGroup

void addUserUserGroup(long userId,
                      long userGroupId)
                      throws SystemException
Throws:
SystemException - if a system exception occurred

addUserUserGroup

void addUserUserGroup(long userId,
                      UserGroup userGroup)
                      throws SystemException
Throws:
SystemException - if a system exception occurred

addUserUserGroups

void addUserUserGroups(long userId,
                       long[] userGroupIds)
                       throws SystemException
Throws:
SystemException - if a system exception occurred

addUserUserGroups

void addUserUserGroups(long userId,
                       List<UserGroup> UserGroups)
                       throws SystemException
Throws:
SystemException - if a system exception occurred

clearUserUserGroups

void clearUserUserGroups(long userId)
                         throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserUserGroup

void deleteUserUserGroup(long userId,
                         long userGroupId)
                         throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserUserGroup

void deleteUserUserGroup(long userId,
                         UserGroup userGroup)
                         throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserUserGroups

void deleteUserUserGroups(long userId,
                          long[] userGroupIds)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

deleteUserUserGroups

void deleteUserUserGroups(long userId,
                          List<UserGroup> UserGroups)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

getUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserUserGroups(long userId)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

getUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserUserGroups(long userId,
                                                                           int start,
                                                                           int end)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

getUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserUserGroups(long userId,
                                                                           int start,
                                                                           int end,
                                                                           OrderByComparator orderByComparator)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

getUserUserGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserUserGroupsCount(long userId)
                           throws SystemException
Throws:
SystemException - if a system exception occurred

hasUserUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserUserGroup(long userId,
                                                                  long userGroupId)
                         throws SystemException
Throws:
SystemException - if a system exception occurred

hasUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserUserGroups(long userId)
                          throws SystemException
Throws:
SystemException - if a system exception occurred

setUserUserGroups

void setUserUserGroups(long userId,
                       long[] userGroupIds)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException - if a system exception occurred

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addUserGroup

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.

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

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.

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

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

Copies the user group's layout to the user.

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

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.

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

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

Copies the user groups' layouts to the user.

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

void deleteUserGroups(long companyId)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

fetchUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup fetchUserGroup(long companyId,
                                                                  String name)
                         throws SystemException
Throws:
SystemException

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup getUserGroup(long companyId,
                                                                String name)
                       throws PortalException,
                              SystemException
Returns the user group with the name.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserGroups(long companyId)
                              throws SystemException
Returns all the user groups belonging to the company.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserGroups(long[] userGroupIds)
                              throws PortalException,
                                     SystemException
Returns all the user groups with the primary keys.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         String keywords,
                                                         LinkedHashMap<String,Object> params)
                throws SystemException
Returns the number of user groups that match the keywords

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

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

Parameters:
groupId - the primary key of the group
userGroupIds - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

unsetTeamUserGroups

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

Parameters:
teamId - the primary key of the team
userGroupIds - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

updateUserGroup

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.

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

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

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
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Liferay 6.2-ce-ga5
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD