com.liferay.portlet.usersadmin.util

Interface UsersAdmin

public interface UsersAdmin

Author:

Brian Wing Shun Chan, Jorge Ferrer, Julio Camarero

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUSTOM_QUESTION

Method Summary

Methods

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

Field Detail

CUSTOM_QUESTION

static final java.lang.String CUSTOM_QUESTION

See Also:

Constant Field Values

Method Detail

addPortletBreadcrumbEntries

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

Throws:

java.lang.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

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

Throws:

PortalException

SystemException

filterGroups

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

Throws:

PortalException

SystemException

filterOrganizations

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

Throws:

PortalException

SystemException

filterRoles

java.util.List<Role> filterRoles(PermissionChecker permissionChecker,
                               java.util.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

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

Throws:

PortalException

SystemException

filterUserGroups

java.util.List<UserGroup> filterUserGroups(PermissionChecker permissionChecker,
                                         java.util.List<UserGroup> userGroups)

getAddresses

java.util.List<Address> getAddresses(javax.portlet.ActionRequest actionRequest)

getAddresses

java.util.List<Address> getAddresses(javax.portlet.ActionRequest actionRequest,
                                   java.util.List<Address> defaultAddresses)

getEmailAddresses

java.util.List<EmailAddress> getEmailAddresses(javax.portlet.ActionRequest actionRequest)

getEmailAddresses

java.util.List<EmailAddress> getEmailAddresses(javax.portlet.ActionRequest actionRequest,
                                             java.util.List<EmailAddress> defaultEmailAddresses)

getGroupOrderByComparator

OrderByComparator getGroupOrderByComparator(java.lang.String orderByCol,
                                          java.lang.String orderByType)

getOrganizationIds

java.lang.Long[] getOrganizationIds(java.util.List<Organization> organizations)

getOrganizationOrderByComparator

OrderByComparator getOrganizationOrderByComparator(java.lang.String orderByCol,
                                                 java.lang.String orderByType)

getOrganizations

Tuple getOrganizations(Hits hits)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getOrgLabors

java.util.List<OrgLabor> getOrgLabors(javax.portlet.ActionRequest actionRequest)

getPhones

java.util.List<Phone> getPhones(javax.portlet.ActionRequest actionRequest)

getPhones

java.util.List<Phone> getPhones(javax.portlet.ActionRequest actionRequest,
                              java.util.List<Phone> defaultPhones)

getRoleOrderByComparator

OrderByComparator getRoleOrderByComparator(java.lang.String orderByCol,
                                         java.lang.String orderByType)

getUserGroupOrderByComparator

OrderByComparator getUserGroupOrderByComparator(java.lang.String orderByCol,
                                              java.lang.String orderByType)

getUserGroupRoles

java.util.List<UserGroupRole> getUserGroupRoles(javax.portlet.PortletRequest portletRequest)
                                                throws PortalException,
                                                       SystemException

Throws:

PortalException

SystemException

getUserGroups

Tuple getUserGroups(Hits hits)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

getUserOrderByComparator

OrderByComparator getUserOrderByComparator(java.lang.String orderByCol,
                                         java.lang.String orderByType)

getUsers

Tuple getUsers(Hits hits)
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

getWebsites

java.util.List<Website> getWebsites(javax.portlet.ActionRequest actionRequest)

getWebsites

java.util.List<Website> getWebsites(javax.portlet.ActionRequest actionRequest,
                                  java.util.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,
                               java.lang.String field)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

hasUpdateFieldPermission

@Deprecated
boolean hasUpdateFieldPermission(User user,
                                          java.lang.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(java.lang.String className,
                   long classPK,
                   java.util.List<Address> addresses)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

updateEmailAddresses

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

Throws:

PortalException

SystemException

updateOrgLabors

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

Throws:

PortalException

SystemException

updatePhones

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

Throws:

PortalException

SystemException

updateWebsites

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

Throws:

PortalException

SystemException