|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.UserGroupLocalServiceWrapper
@ProviderType public class UserGroupLocalServiceWrapper
Provides a wrapper for UserGroupLocalService
.
UserGroupLocalService
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 |
---|
public UserGroupLocalServiceWrapper(UserGroupLocalService userGroupLocalService)
Method Detail |
---|
public UserGroup addUserGroup(UserGroup userGroup) throws SystemException
addUserGroup
in interface UserGroupLocalService
userGroup
- the user group
SystemException
- if a system exception occurredpublic UserGroup createUserGroup(long userGroupId)
createUserGroup
in interface UserGroupLocalService
userGroupId
- the primary key for the new user group
public UserGroup deleteUserGroup(long userGroupId) throws PortalException, SystemException
deleteUserGroup
in interface UserGroupLocalService
userGroupId
- the primary key of the user group
PortalException
- if a user group with the primary key could not be found
SystemException
- if a system exception occurredpublic UserGroup deleteUserGroup(UserGroup userGroup) throws PortalException, SystemException
deleteUserGroup
in interface UserGroupLocalService
userGroup
- the user group
PortalException
SystemException
- if a system exception occurredpublic DynamicQuery dynamicQuery()
dynamicQuery
in interface UserGroupLocalService
public List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
in interface UserGroupLocalService
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set. 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.
dynamicQuery
in interface UserGroupLocalService
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)
SystemException
- if a system exception occurredpublic List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set. 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.
dynamicQuery
in interface UserGroupLocalService
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)
SystemException
- if a system exception occurredpublic long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQueryCount
in interface UserGroupLocalService
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) throws SystemException
dynamicQueryCount
in interface UserGroupLocalService
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query
SystemException
- if a system exception occurredpublic UserGroup fetchUserGroup(long userGroupId) throws SystemException
fetchUserGroup
in interface UserGroupLocalService
SystemException
public UserGroup fetchUserGroupByUuidAndCompanyId(String uuid, long companyId) throws SystemException
fetchUserGroupByUuidAndCompanyId
in interface UserGroupLocalService
uuid
- the user group's UUIDcompanyId
- the primary key of the company
null
if a matching user group could not be found
SystemException
- if a system exception occurredpublic UserGroup getUserGroup(long userGroupId) throws PortalException, SystemException
getUserGroup
in interface UserGroupLocalService
userGroupId
- the primary key of the user group
PortalException
- if a user group with the primary key could not be found
SystemException
- if a system exception occurredpublic PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
getPersistedModel
in interface PersistedModelLocalService
getPersistedModel
in interface UserGroupLocalService
PortalException
SystemException
public UserGroup getUserGroupByUuidAndCompanyId(String uuid, long companyId) throws PortalException, SystemException
getUserGroupByUuidAndCompanyId
in interface UserGroupLocalService
uuid
- the user group's UUIDcompanyId
- the primary key of the company
PortalException
- if a matching user group could not be found
SystemException
- if a system exception occurredpublic List<UserGroup> getUserGroups(int start, int end) throws SystemException
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set. 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.
getUserGroups
in interface UserGroupLocalService
start
- the lower bound of the range of user groupsend
- the upper bound of the range of user groups (not inclusive)
SystemException
- if a system exception occurredpublic int getUserGroupsCount() throws SystemException
getUserGroupsCount
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic UserGroup updateUserGroup(UserGroup userGroup) throws SystemException
updateUserGroup
in interface UserGroupLocalService
userGroup
- the user group
SystemException
- if a system exception occurredpublic void addGroupUserGroup(long groupId, long userGroupId) throws SystemException
addGroupUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void addGroupUserGroup(long groupId, UserGroup userGroup) throws SystemException
addGroupUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void addGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
addGroupUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void addGroupUserGroups(long groupId, List<UserGroup> UserGroups) throws SystemException
addGroupUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void clearGroupUserGroups(long groupId) throws SystemException
clearGroupUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteGroupUserGroup(long groupId, long userGroupId) throws SystemException
deleteGroupUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteGroupUserGroup(long groupId, UserGroup userGroup) throws SystemException
deleteGroupUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
deleteGroupUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteGroupUserGroups(long groupId, List<UserGroup> UserGroups) throws SystemException
deleteGroupUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic List<UserGroup> getGroupUserGroups(long groupId) throws SystemException
getGroupUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic List<UserGroup> getGroupUserGroups(long groupId, int start, int end) throws SystemException
getGroupUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic List<UserGroup> getGroupUserGroups(long groupId, int start, int end, OrderByComparator orderByComparator) throws SystemException
getGroupUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic int getGroupUserGroupsCount(long groupId) throws SystemException
getGroupUserGroupsCount
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic boolean hasGroupUserGroup(long groupId, long userGroupId) throws SystemException
hasGroupUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic boolean hasGroupUserGroups(long groupId) throws SystemException
hasGroupUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void setGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
setGroupUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void addTeamUserGroup(long teamId, long userGroupId) throws SystemException
addTeamUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void addTeamUserGroup(long teamId, UserGroup userGroup) throws SystemException
addTeamUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void addTeamUserGroups(long teamId, long[] userGroupIds) throws SystemException
addTeamUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void addTeamUserGroups(long teamId, List<UserGroup> UserGroups) throws SystemException
addTeamUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void clearTeamUserGroups(long teamId) throws SystemException
clearTeamUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteTeamUserGroup(long teamId, long userGroupId) throws SystemException
deleteTeamUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteTeamUserGroup(long teamId, UserGroup userGroup) throws SystemException
deleteTeamUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteTeamUserGroups(long teamId, long[] userGroupIds) throws SystemException
deleteTeamUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteTeamUserGroups(long teamId, List<UserGroup> UserGroups) throws SystemException
deleteTeamUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic List<UserGroup> getTeamUserGroups(long teamId) throws SystemException
getTeamUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic List<UserGroup> getTeamUserGroups(long teamId, int start, int end) throws SystemException
getTeamUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic List<UserGroup> getTeamUserGroups(long teamId, int start, int end, OrderByComparator orderByComparator) throws SystemException
getTeamUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic int getTeamUserGroupsCount(long teamId) throws SystemException
getTeamUserGroupsCount
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic boolean hasTeamUserGroup(long teamId, long userGroupId) throws SystemException
hasTeamUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic boolean hasTeamUserGroups(long teamId) throws SystemException
hasTeamUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void setTeamUserGroups(long teamId, long[] userGroupIds) throws SystemException
setTeamUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void addUserUserGroup(long userId, long userGroupId) throws SystemException
addUserUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void addUserUserGroup(long userId, UserGroup userGroup) throws SystemException
addUserUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void addUserUserGroups(long userId, long[] userGroupIds) throws SystemException
addUserUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void addUserUserGroups(long userId, List<UserGroup> UserGroups) throws SystemException
addUserUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void clearUserUserGroups(long userId) throws SystemException
clearUserUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteUserUserGroup(long userId, long userGroupId) throws SystemException
deleteUserUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteUserUserGroup(long userId, UserGroup userGroup) throws SystemException
deleteUserUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteUserUserGroups(long userId, long[] userGroupIds) throws SystemException
deleteUserUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void deleteUserUserGroups(long userId, List<UserGroup> UserGroups) throws SystemException
deleteUserUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic List<UserGroup> getUserUserGroups(long userId) throws SystemException
getUserUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic List<UserGroup> getUserUserGroups(long userId, int start, int end) throws SystemException
getUserUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic List<UserGroup> getUserUserGroups(long userId, int start, int end, OrderByComparator orderByComparator) throws SystemException
getUserUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic int getUserUserGroupsCount(long userId) throws SystemException
getUserUserGroupsCount
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic boolean hasUserUserGroup(long userId, long userGroupId) throws SystemException
hasUserUserGroup
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic boolean hasUserUserGroups(long userId) throws SystemException
hasUserUserGroups
in interface UserGroupLocalService
SystemException
- if a system exception occurredpublic void setUserUserGroups(long userId, long[] userGroupIds) throws PortalException, SystemException
setUserUserGroups
in interface UserGroupLocalService
PortalException
SystemException
- if a system exception occurredpublic String getBeanIdentifier()
getBeanIdentifier
in interface UserGroupLocalService
public void setBeanIdentifier(String beanIdentifier)
setBeanIdentifier
in interface UserGroupLocalService
beanIdentifier
- the Spring bean ID for this beanpublic UserGroup addUserGroup(long userId, long companyId, String name, String description) throws PortalException, SystemException
addUserGroup(long, long,
String, String, ServiceContext)
This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to setup default groups and resources for the user group.
addUserGroup
in interface UserGroupLocalService
userId
- the primary key of the usercompanyId
- the primary key of the user group's companyname
- the user group's namedescription
- the user group's description
PortalException
- if the user group's information was invalid
SystemException
- if a system exception occurredpublic UserGroup addUserGroup(long userId, long companyId, String name, String description, ServiceContext serviceContext) throws PortalException, SystemException
This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to setup default groups and resources for the user group.
addUserGroup
in interface UserGroupLocalService
userId
- the primary key of the usercompanyId
- the primary key of the user group's companyname
- the user group's namedescription
- the user group's descriptionserviceContext
- the service context to be applied (optionally
null
). Can set expando bridge attributes for the
user group.
PortalException
- if the user group's information was invalid
SystemException
- if a system exception occurredpublic void copyUserGroupLayouts(long userGroupId, long userId) throws PortalException, SystemException
copyUserGroupLayouts
in interface UserGroupLocalService
userGroupId
- the primary key of the user groupuserId
- the primary key of the user
PortalException
- if a user with the primary key could not be
found or if a portal exception occurred
SystemException
- if a system exception occurredpublic void copyUserGroupLayouts(long userGroupId, long[] userIds) throws PortalException, SystemException
copyUserGroupLayouts
in interface UserGroupLocalService
userGroupId
- the primary key of the user groupuserIds
- the primary keys of the users
PortalException
- if any one of the users could not be found or
if a portal exception occurred
SystemException
- if a system exception occurredpublic void copyUserGroupLayouts(long[] userGroupIds, long userId) throws PortalException, SystemException
copyUserGroupLayouts
in interface UserGroupLocalService
userGroupIds
- the primary keys of the user groupsuserId
- the primary key of the user
PortalException
- if a user with the primary key could not be
found or if a portal exception occurred
SystemException
- if a system exception occurredpublic void deleteUserGroups(long companyId) throws PortalException, SystemException
deleteUserGroups
in interface UserGroupLocalService
PortalException
SystemException
public UserGroup fetchUserGroup(long companyId, String name) throws SystemException
fetchUserGroup
in interface UserGroupLocalService
SystemException
public UserGroup getUserGroup(long companyId, String name) throws PortalException, SystemException
getUserGroup
in interface UserGroupLocalService
companyId
- the primary key of the user group's companyname
- the user group's name
PortalException
- if a user group with the name could not be found
SystemException
- if a system exception occurredpublic List<UserGroup> getUserGroups(long companyId) throws SystemException
getUserGroups
in interface UserGroupLocalService
companyId
- the primary key of the user groups' company
SystemException
- if a system exception occurredpublic List<UserGroup> getUserGroups(long[] userGroupIds) throws PortalException, SystemException
getUserGroups
in interface UserGroupLocalService
userGroupIds
- the primary keys of the user groups
PortalException
- if any one of the user groups could not be found
SystemException
- if a system exception occurredpublic List<UserGroup> search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc) throws SystemException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
search
in interface UserGroupLocalService
companyId
- the primary key of the user group's companykeywords
- the keywords (space separated), which may occur in the
user group's name or description (optionally null
)params
- the finder params (optionally null
). For more
information see UserGroupFinder
start
- the lower bound of the range of user groups to returnend
- the upper bound of the range of user groups to return (not
inclusive)obc
- the comparator to order the user groups (optionally
null
)
obc
SystemException
- if a system exception occurredUserGroupFinder
public Hits search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, Sort sort) throws SystemException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
search
in interface UserGroupLocalService
companyId
- the primary key of the user group's companykeywords
- the keywords (space separated), which may occur in the
user group's name or description (optionally null
)params
- the finder params (optionally null
). For more
information see com.liferay.portlet.usergroupsadmin.util.UserGroupIndexer
start
- the lower bound of the range of user groups to returnend
- the upper bound of the range of user groups to return (not
inclusive)sort
- the field and direction by which to sort (optionally
null
)
SystemException
- if a system exception occurredcom.liferay.portlet.usergroupsadmin.util.UserGroupIndexer
public Hits search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, Sort sort) throws SystemException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
search
in interface UserGroupLocalService
companyId
- the primary key of the user group's companyname
- the user group's name (optionally null
)description
- the user group's description (optionally
null
)params
- the finder params (optionally null
). For more
information see com.liferay.portlet.usergroupsadmin.util.UserGroupIndexer
andSearch
- whether every field must match its keywords or just one
fieldstart
- the lower bound of the range of user groups to returnend
- the upper bound of the range of user groups to return (not
inclusive)sort
- the field and direction by which to sort (optionally
null
)
SystemException
- if a system exception occurredUserGroupFinder
public int searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params) throws SystemException
searchCount
in interface UserGroupLocalService
companyId
- the primary key of the user group's companykeywords
- the keywords (space separated), which may occur in the
user group's name or description (optionally null
)params
- the finder params (optionally null
). For more
information see UserGroupFinder
SystemException
- if a system exception occurredUserGroupFinder
public void unsetGroupUserGroups(long groupId, long[] userGroupIds) throws SystemException
unsetGroupUserGroups
in interface UserGroupLocalService
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups
SystemException
- if a system exception occurredpublic void unsetTeamUserGroups(long teamId, long[] userGroupIds) throws SystemException
unsetTeamUserGroups
in interface UserGroupLocalService
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups
SystemException
- if a system exception occurredpublic UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description) throws PortalException, SystemException
updateUserGroup(long, long,
String, String, ServiceContext)
updateUserGroup
in interface UserGroupLocalService
companyId
- the primary key of the user group's companyuserGroupId
- the primary key of the user groupname
- the user group's namedescription
- the user group's description
PortalException
- if a user group with the primary key could
not be found or if the new information was invalid
SystemException
- if a system exception occurredpublic UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description, ServiceContext serviceContext) throws PortalException, SystemException
updateUserGroup
in interface UserGroupLocalService
companyId
- the primary key of the user group's companyuserGroupId
- the primary key of the user groupname
- the user group's namedescription
- the user group's descriptionserviceContext
- the service context to be applied (optionally
null
). Can set expando bridge attributes for the
user group.
PortalException
- if a user group with the primary key could not be
found or if the new information was invalid
SystemException
- if a system exception occurredpublic UserGroupLocalService getWrappedUserGroupLocalService()
getWrappedService()
public void setWrappedUserGroupLocalService(UserGroupLocalService userGroupLocalService)
setWrappedService(com.liferay.portal.service.UserGroupLocalService)
public UserGroupLocalService getWrappedService()
getWrappedService
in interface ServiceWrapper<UserGroupLocalService>
public void setWrappedService(UserGroupLocalService userGroupLocalService)
setWrappedService
in interface ServiceWrapper<UserGroupLocalService>
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |