com.liferay.portlet.usersadmin.util
Interface UsersAdmin

All Known Implementing Classes:

UsersAdminImpl

public interface UsersAdmin

Field Summary

static String

CUSTOM_QUESTION

Method Summary

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

getGroupOrderByComparator

OrderByComparator getGroupOrderByComparator(String orderByCol,
                                            String orderByType)

getOrganizationIds

Long[] getOrganizationIds(List<Organization> organizations)

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)

getRoleOrderByComparator

OrderByComparator getRoleOrderByComparator(String orderByCol,
                                           String orderByType)

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(User, String)

Throws:

PortalException

SystemException

hasUpdateFieldPermission

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

Throws:

PortalException

SystemException

hasUpdateScreenName

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

Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(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