com.liferay.users.admin.kernel.util

Interface UsersAdmin

@ProviderType
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
static Accessor<Organization,java.lang.String>	ORGANIZATION_COUNTRY_NAME_ACCESSOR
static Accessor<Organization,java.lang.String>	ORGANIZATION_REGION_NAME_ACCESSOR
static Accessor<UserGroupGroupRole,java.lang.Long>	USER_GROUP_GROUP_ROLE_ID_ACCESSOR
static Accessor<UserGroupGroupRole,java.lang.String>	USER_GROUP_GROUP_ROLE_TITLE_ACCESSOR
static Accessor<UserGroupRole,java.lang.Long>	USER_GROUP_ROLE_ID_ACCESSOR
static Accessor<UserGroupRole,java.lang.String>	USER_GROUP_ROLE_TITLE_ACCESSOR

Method Summary

Modifier and Type	Method and Description
void	addPortletBreadcrumbEntries(Organization organization, javax.servlet.http.HttpServletRequest httpServletRequest, 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)
long[]	getGroupIds(javax.portlet.PortletRequest portletRequest)
OrderByComparator<Group>	getGroupOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
java.lang.Long[]	getOrganizationIds(java.util.List<Organization> organizations)
long[]	getOrganizationIds(javax.portlet.PortletRequest portletRequest)
OrderByComparator<Organization>	getOrganizationOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
java.util.List<Organization>	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)
long[]	getRoleIds(javax.portlet.PortletRequest portletRequest)
OrderByComparator<Role>	getRoleOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
<T> java.lang.String	getUserColumnText(java.util.Locale locale, java.util.List<? extends T> list, Accessor<T,java.lang.String> accessor, int count)
long[]	getUserGroupIds(javax.portlet.PortletRequest portletRequest)
OrderByComparator<UserGroup>	getUserGroupOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
java.util.List<UserGroupRole>	getUserGroupRoles(javax.portlet.PortletRequest portletRequest)
java.util.List<UserGroup>	getUserGroups(Hits hits)
OrderByComparator<User>	getUserOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
java.util.List<User>	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	hasUpdateFieldPermission(PermissionChecker permissionChecker, User updatingUser, User updatedUser, java.lang.String field)
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

ORGANIZATION_COUNTRY_NAME_ACCESSOR

static final Accessor<Organization,java.lang.String> ORGANIZATION_COUNTRY_NAME_ACCESSOR

ORGANIZATION_REGION_NAME_ACCESSOR

static final Accessor<Organization,java.lang.String> ORGANIZATION_REGION_NAME_ACCESSOR

USER_GROUP_GROUP_ROLE_ID_ACCESSOR

static final Accessor<UserGroupGroupRole,java.lang.Long> USER_GROUP_GROUP_ROLE_ID_ACCESSOR

USER_GROUP_GROUP_ROLE_TITLE_ACCESSOR

static final Accessor<UserGroupGroupRole,java.lang.String> USER_GROUP_GROUP_ROLE_TITLE_ACCESSOR

USER_GROUP_ROLE_ID_ACCESSOR

static final Accessor<UserGroupRole,java.lang.Long> USER_GROUP_ROLE_ID_ACCESSOR

USER_GROUP_ROLE_TITLE_ACCESSOR

static final Accessor<UserGroupRole,java.lang.String> USER_GROUP_ROLE_TITLE_ACCESSOR

Method Detail

addPortletBreadcrumbEntries

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

Throws:

java.lang.Exception

addRequiredRoles

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

Throws:

PortalException

addRequiredRoles

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

Throws:

PortalException

filterGroupRoles

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

Throws:

PortalException

filterGroups

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

Throws:

PortalException

filterOrganizations

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

Throws:

PortalException

filterRoles

java.util.List<Role> filterRoles(PermissionChecker permissionChecker,
                                 java.util.List<Role> roles)

filterUnsetGroupUserIds

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

Throws:

PortalException

filterUnsetOrganizationUserIds

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

Throws:

PortalException

filterUserGroupRoles

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

Throws:

PortalException

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)

getGroupIds

long[] getGroupIds(javax.portlet.PortletRequest portletRequest)
            throws PortalException

Throws:

PortalException

getGroupOrderByComparator

OrderByComparator<Group> getGroupOrderByComparator(java.lang.String orderByCol,
                                                   java.lang.String orderByType)

getOrganizationIds

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

getOrganizationIds

long[] getOrganizationIds(javax.portlet.PortletRequest portletRequest)
                   throws PortalException

Throws:

PortalException

getOrganizationOrderByComparator

OrderByComparator<Organization> getOrganizationOrderByComparator(java.lang.String orderByCol,
                                                                 java.lang.String orderByType)

getOrganizations

java.util.List<Organization> getOrganizations(Hits hits)
                                       throws PortalException

Throws:

PortalException

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)

getRoleIds

long[] getRoleIds(javax.portlet.PortletRequest portletRequest)
           throws PortalException

Throws:

PortalException

getRoleOrderByComparator

OrderByComparator<Role> getRoleOrderByComparator(java.lang.String orderByCol,
                                                 java.lang.String orderByType)

getUserColumnText

<T> java.lang.String getUserColumnText(java.util.Locale locale,
                                       java.util.List<? extends T> list,
                                       Accessor<T,java.lang.String> accessor,
                                       int count)

getUserGroupIds

long[] getUserGroupIds(javax.portlet.PortletRequest portletRequest)
                throws PortalException

Throws:

PortalException

getUserGroupOrderByComparator

OrderByComparator<UserGroup> getUserGroupOrderByComparator(java.lang.String orderByCol,
                                                           java.lang.String orderByType)

getUserGroupRoles

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

Throws:

PortalException

getUserGroups

java.util.List<UserGroup> getUserGroups(Hits hits)
                                 throws PortalException

Throws:

PortalException

getUserOrderByComparator

OrderByComparator<User> getUserOrderByComparator(java.lang.String orderByCol,
                                                 java.lang.String orderByType)

getUsers

java.util.List<User> getUsers(Hits hits)
                       throws PortalException

Throws:

PortalException

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)

hasUpdateFieldPermission

boolean hasUpdateFieldPermission(PermissionChecker permissionChecker,
                                 User updatingUser,
                                 User updatedUser,
                                 java.lang.String field)
                          throws PortalException

Throws:

PortalException

removeRequiredRoles

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

Throws:

PortalException

removeRequiredRoles

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

Throws:

PortalException

updateAddresses

void updateAddresses(java.lang.String className,
                     long classPK,
                     java.util.List<Address> addresses)
              throws PortalException

Throws:

PortalException

updateEmailAddresses

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

Throws:

PortalException

updateOrgLabors

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

Throws:

PortalException

updatePhones

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

Throws:

PortalException

updateWebsites

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

Throws:

PortalException