|
Liferay 6.2.0-ce-m4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface UserGroupLocalServiceThe interface for the user group local service.
This is a local service. 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.
UserGroupLocalServiceUtil,
UserGroupLocalServiceBaseImpl,
UserGroupLocalServiceImpl| Method Summary | |
|---|---|
void |
addGroupUserGroups(long groupId,
long[] userGroupIds)
Adds the user groups to the group. |
void |
addTeamUserGroups(long teamId,
long[] userGroupIds)
Adds the user groups to the team. |
UserGroup |
addUserGroup(long userId,
long companyId,
String name,
String description)
Deprecated. 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 |
checkMembershipPolicy(User user)
Removes the user from any forbidden user groups and adds the user to all mandatory user groups, if the user does not belong to them. |
void |
clearUserUserGroups(long userId)
Clears all associations between the user and its user groups and clears the permissions cache. |
void |
copyUserGroupLayouts(long[] userGroupIds,
long userId)
Deprecated. |
void |
copyUserGroupLayouts(long userGroupId,
long userId)
Deprecated. |
void |
copyUserGroupLayouts(long userGroupId,
long[] userIds)
Deprecated. |
UserGroup |
createUserGroup(long userGroupId)
Creates a new user group with the primary key. |
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. |
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. |
UserGroup |
fetchUserGroup(long userGroupId)
|
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
UserGroup |
getUserGroup(long userGroupId)
Returns the user group with the primary key. |
UserGroup |
getUserGroup(long companyId,
String name)
Returns the user group with the name. |
List<UserGroup> |
getUserGroups(int start,
int end)
Returns a range of all the user groups. |
List<UserGroup> |
getUserGroups(long companyId)
Returns all the user groups belonging to the company. |
List<UserGroup> |
getUserGroups(long[] userGroupIds)
Returns all the user groups with the primary keys. |
int |
getUserGroupsCount()
Returns the number of user groups. |
List<UserGroup> |
getUserUserGroups(long userId)
Returns all the user groups to which the user belongs. |
boolean |
hasGroupUserGroup(long groupId,
long userGroupId)
Returns true if the user group is associated with the group. |
boolean |
hasTeamUserGroup(long teamId,
long userGroupId)
Returns true if the user group belongs to the team. |
List<UserGroup> |
search(long companyId,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
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 |
setUserUserGroups(long userId,
long[] userGroupIds)
Sets the user groups associated with the user copying the user group layouts and removing and adding user group associations for the user as necessary. |
void |
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. 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 |
|---|
UserGroup addUserGroup(UserGroup userGroup)
throws SystemException
userGroup - the user group
SystemException - if a system exception occurredUserGroup createUserGroup(long userGroupId)
userGroupId - the primary key for the new user group
UserGroup deleteUserGroup(long userGroupId)
throws PortalException,
SystemException
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 occurred
UserGroup deleteUserGroup(UserGroup userGroup)
throws PortalException,
SystemException
userGroup - the user group
PortalException
SystemException - if a system exception occurredDynamicQuery dynamicQuery()
List dynamicQuery(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
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 - 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 occurred
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 - 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 occurred
long dynamicQueryCount(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
UserGroup fetchUserGroup(long userGroupId)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
UserGroup getUserGroup(long userGroupId)
throws PortalException,
SystemException
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 occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException,
SystemException
getPersistedModel in interface PersistedModelLocalServicePortalException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
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.
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 occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getUserGroupsCount()
throws SystemException
SystemException - if a system exception occurred
UserGroup updateUserGroup(UserGroup userGroup)
throws SystemException
userGroup - the user group
SystemException - if a system exception occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
void addGroupUserGroups(long groupId,
long[] userGroupIds)
throws SystemException
groupId - the primary key of the groupuserGroupIds - the primary keys of the user groups
SystemException - if a system exception occurred
void addTeamUserGroups(long teamId,
long[] userGroupIds)
throws SystemException
teamId - the primary key of the teamuserGroupIds - the primary keys of the user groups
SystemException - if a system exception occurred
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.
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 occurred
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.
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 user group's service context (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 occurred
void checkMembershipPolicy(User user)
throws PortalException,
SystemException
user - the user
PortalException - if the user cannot be added or removed from any
user groups.
SystemException - if a system exception occurredMembershipPolicyAction
void clearUserUserGroups(long userId)
throws SystemException
This method is called from deleteUserGroup(UserGroup).
userId - the primary key of the user
SystemException - if a system exception occurred
void copyUserGroupLayouts(long userGroupId,
long[] userIds)
throws PortalException,
SystemException
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 occurred
void copyUserGroupLayouts(long[] userGroupIds,
long userId)
throws PortalException,
SystemException
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 occurred
void copyUserGroupLayouts(long userGroupId,
long userId)
throws PortalException,
SystemException
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 occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
UserGroup getUserGroup(long companyId,
String name)
throws PortalException,
SystemException
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 occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserGroup> getUserGroups(long companyId)
throws SystemException
companyId - the primary key of the user groups' company
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserGroup> getUserGroups(long[] userGroupIds)
throws PortalException,
SystemException
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 occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserGroup> getUserUserGroups(long userId)
throws SystemException
userId - the primary key of the user
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasGroupUserGroup(long groupId,
long userGroupId)
throws SystemException
true if the user group is associated with the group.
groupId - the primary key of the groupuserGroupId - the primary key of the user group
true if the user group belongs to the group;
false otherwise
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasTeamUserGroup(long teamId,
long userGroupId)
throws SystemException
true if the user group belongs to the team.
teamId - the primary key of the teamuserGroupId - the primary key of the user group
true if the user group belongs to the team;
false otherwise
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
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.
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 UserGroupFinderstart - 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
@Transactional(propagation=SUPPORTS,
readOnly=true)
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.
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 UserGroupIndexerstart - 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 occurredUserGroupIndexer
@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
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.
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 UserGroupIndexerandSearch - 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
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
String keywords,
LinkedHashMap<String,Object> params)
throws SystemException
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
void setUserUserGroups(long userId,
long[] userGroupIds)
throws PortalException,
SystemException
userId - the primary key of the useruserGroupIds - the primary keys of the user groups
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
void unsetGroupUserGroups(long groupId,
long[] userGroupIds)
throws SystemException
groupId - the primary key of the groupuserGroupIds - the primary keys of the user groups
SystemException - if a system exception occurred
void unsetTeamUserGroups(long teamId,
long[] userGroupIds)
throws SystemException
teamId - the primary key of the teamuserGroupIds - the primary keys of the user groups
SystemException - if a system exception occurred
UserGroup updateUserGroup(long companyId,
long userGroupId,
String name,
String description)
throws PortalException,
SystemException
updateUserGroup(long, long, String, String,
ServiceContext)
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 occurred
UserGroup updateUserGroup(long companyId,
long userGroupId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException,
SystemException
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 user group's service context (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 occurred
|
Liferay 6.2.0-ce-m4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||