com.liferay.portlet.usersadmin.util
Interface UsersAdmin

public interface UsersAdmin

Field Summary

static String

CUSTOM_QUESTION

Method Summary

void	addPortletBreadcrumbEntries(Organization organization, javax.servlet.http.HttpServletRequest request, RenderResponse renderResponse)
long[]	addRequiredRoles(long userId, long[] roleIds)
long[]	addRequiredRoles(User user, long[] roleIds)
List<Role>	filterGroupRoles(PermissionChecker permissionChecker, long groupId, List<Role> roles)
List<Group>	filterGroups(PermissionChecker permissionChecker, List<Group> groups)
List<Organization>	filterOrganizations(PermissionChecker permissionChecker, List<Organization> organizations)
List<Role>	filterRoles(PermissionChecker permissionChecker, List<Role> roles)
long[]	filterUnsetGroupUserIds(PermissionChecker permissionChecker, long groupId, long[] userIds)
long[]	filterUnsetOrganizationUserIds(PermissionChecker permissionChecker, long organizationId, long[] userIds)
List<UserGroupRole>	filterUserGroupRoles(PermissionChecker permissionChecker, List<UserGroupRole> userGroupRoles)
List<UserGroup>	filterUserGroups(PermissionChecker permissionChecker, List<UserGroup> userGroups)
List<Address>	getAddresses(ActionRequest actionRequest)
List<Address>	getAddresses(ActionRequest actionRequest, List<Address> defaultAddresses)
List<EmailAddress>	getEmailAddresses(ActionRequest actionRequest)
List<EmailAddress>	getEmailAddresses(ActionRequest actionRequest, List<EmailAddress> defaultEmailAddresses)
long[]	getGroupIds(PortletRequest portletRequest)
OrderByComparator	getGroupOrderByComparator(String orderByCol, String orderByType)
Long[]	getOrganizationIds(List<Organization> organizations)
long[]	getOrganizationIds(PortletRequest portletRequest)
OrderByComparator	getOrganizationOrderByComparator(String orderByCol, String orderByType)
Tuple	getOrganizations(Hits hits)
List<OrgLabor>	getOrgLabors(ActionRequest actionRequest)
List<Phone>	getPhones(ActionRequest actionRequest)
List<Phone>	getPhones(ActionRequest actionRequest, List<Phone> defaultPhones)
long[]	getRoleIds(PortletRequest portletRequest)
OrderByComparator	getRoleOrderByComparator(String orderByCol, String orderByType)
long[]	getUserGroupIds(PortletRequest portletRequest)
OrderByComparator	getUserGroupOrderByComparator(String orderByCol, String orderByType)
List<UserGroupRole>	getUserGroupRoles(PortletRequest portletRequest)
Tuple	getUserGroups(Hits hits)
OrderByComparator	getUserOrderByComparator(String orderByCol, String orderByType)
Tuple	getUsers(Hits hits)
List<Website>	getWebsites(ActionRequest actionRequest)
List<Website>	getWebsites(ActionRequest actionRequest, List<Website> defaultWebsites)
boolean	hasUpdateEmailAddress(PermissionChecker permissionChecker, User user) Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)
boolean	hasUpdateFieldPermission(PermissionChecker permissionChecker, User updatingUser, User updatedUser, String field)
boolean	hasUpdateFieldPermission(User user, String field) Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)
boolean	hasUpdateScreenName(PermissionChecker permissionChecker, User user) Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)
long[]	removeRequiredRoles(long userId, long[] roleIds)
long[]	removeRequiredRoles(User user, long[] roleIds)
void	updateAddresses(String className, long classPK, List<Address> addresses)
void	updateEmailAddresses(String className, long classPK, List<EmailAddress> emailAddresses)
void	updateOrgLabors(long classPK, List<OrgLabor> orgLabors)
void	updatePhones(String className, long classPK, List<Phone> phones)
void	updateWebsites(String className, long classPK, List<Website> websites)

Field Detail

CUSTOM_QUESTION

static final String CUSTOM_QUESTION

See Also:

Constant Field Values

Method Detail

addPortletBreadcrumbEntries

void addPortletBreadcrumbEntries(Organization organization,
                                 javax.servlet.http.HttpServletRequest request,
                                 RenderResponse renderResponse)
                                 throws Exception

Throws:

Exception

addRequiredRoles

long[] addRequiredRoles(long userId,
                        long[] roleIds)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addRequiredRoles

long[] addRequiredRoles(User user,
                        long[] roleIds)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

filterGroupRoles

List<Role> filterGroupRoles(PermissionChecker permissionChecker,
                            long groupId,
                            List<Role> roles)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

filterGroups

List<Group> filterGroups(PermissionChecker permissionChecker,
                         List<Group> groups)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

filterOrganizations

List<Organization> filterOrganizations(PermissionChecker permissionChecker,
                                       List<Organization> organizations)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

filterRoles

List<Role> filterRoles(PermissionChecker permissionChecker,
                       List<Role> roles)

filterUnsetGroupUserIds

long[] filterUnsetGroupUserIds(PermissionChecker permissionChecker,
                               long groupId,
                               long[] userIds)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

filterUnsetOrganizationUserIds

long[] filterUnsetOrganizationUserIds(PermissionChecker permissionChecker,
                                      long organizationId,
                                      long[] userIds)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

filterUserGroupRoles

List<UserGroupRole> filterUserGroupRoles(PermissionChecker permissionChecker,
                                         List<UserGroupRole> userGroupRoles)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

filterUserGroups

List<UserGroup> filterUserGroups(PermissionChecker permissionChecker,
                                 List<UserGroup> userGroups)

getAddresses

List<Address> getAddresses(ActionRequest actionRequest)

getAddresses

List<Address> getAddresses(ActionRequest actionRequest,
                           List<Address> defaultAddresses)

getEmailAddresses

List<EmailAddress> getEmailAddresses(ActionRequest actionRequest)

getEmailAddresses

List<EmailAddress> getEmailAddresses(ActionRequest actionRequest,
                                     List<EmailAddress> defaultEmailAddresses)

getGroupIds

long[] getGroupIds(PortletRequest portletRequest)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getGroupOrderByComparator

OrderByComparator getGroupOrderByComparator(String orderByCol,
                                            String orderByType)

getOrganizationIds

Long[] getOrganizationIds(List<Organization> organizations)

getOrganizationIds

long[] getOrganizationIds(PortletRequest portletRequest)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getOrganizationOrderByComparator

OrderByComparator getOrganizationOrderByComparator(String orderByCol,
                                                   String orderByType)

getOrganizations

Tuple getOrganizations(Hits hits)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getOrgLabors

List<OrgLabor> getOrgLabors(ActionRequest actionRequest)

getPhones

List<Phone> getPhones(ActionRequest actionRequest)

getPhones

List<Phone> getPhones(ActionRequest actionRequest,
                      List<Phone> defaultPhones)

getRoleIds

long[] getRoleIds(PortletRequest portletRequest)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

getRoleOrderByComparator

OrderByComparator getRoleOrderByComparator(String orderByCol,
                                           String orderByType)

getUserGroupIds

long[] getUserGroupIds(PortletRequest portletRequest)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getUserGroupOrderByComparator

OrderByComparator getUserGroupOrderByComparator(String orderByCol,
                                                String orderByType)

getUserGroupRoles

List<UserGroupRole> getUserGroupRoles(PortletRequest portletRequest)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getUserGroups

Tuple getUserGroups(Hits hits)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

getUserOrderByComparator

OrderByComparator getUserOrderByComparator(String orderByCol,
                                           String orderByType)

getUsers

Tuple getUsers(Hits hits)
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

getWebsites

List<Website> getWebsites(ActionRequest actionRequest)

getWebsites

List<Website> getWebsites(ActionRequest actionRequest,
                          List<Website> defaultWebsites)

hasUpdateEmailAddress

boolean hasUpdateEmailAddress(PermissionChecker permissionChecker,
                              User user)
                              throws PortalException,
                                     SystemException

Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)

Throws:

PortalException

SystemException

hasUpdateFieldPermission

boolean hasUpdateFieldPermission(PermissionChecker permissionChecker,
                                 User updatingUser,
                                 User updatedUser,
                                 String field)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

hasUpdateFieldPermission

@Deprecated
boolean hasUpdateFieldPermission(User user,
                                            String field)
                                 throws PortalException,
                                        SystemException

Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)

Throws:

PortalException

SystemException

hasUpdateScreenName

boolean hasUpdateScreenName(PermissionChecker permissionChecker,
                            User user)
                            throws PortalException,
                                   SystemException

Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)

Throws:

PortalException

SystemException

removeRequiredRoles

long[] removeRequiredRoles(long userId,
                           long[] roleIds)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

removeRequiredRoles

long[] removeRequiredRoles(User user,
                           long[] roleIds)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateAddresses

void updateAddresses(String className,
                     long classPK,
                     List<Address> addresses)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

updateEmailAddresses

void updateEmailAddresses(String className,
                          long classPK,
                          List<EmailAddress> emailAddresses)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

updateOrgLabors

void updateOrgLabors(long classPK,
                     List<OrgLabor> orgLabors)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

updatePhones

void updatePhones(String className,
                  long classPK,
                  List<Phone> phones)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

updateWebsites

void updateWebsites(String className,
                    long classPK,
                    List<Website> websites)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException