Liferay 7.0-ce-b4

com.liferay.users.admin.kernel.util
Interface UsersAdmin


@ProviderType
public interface UsersAdmin


Field Summary
static String CUSTOM_QUESTION
           
static Accessor<Organization,String> ORGANIZATION_COUNTRY_NAME_ACCESSOR
           
static Accessor<Organization,String> ORGANIZATION_REGION_NAME_ACCESSOR
           
static Accessor<UserGroupGroupRole,Long> USER_GROUP_GROUP_ROLE_ID_ACCESSOR
           
static Accessor<UserGroupGroupRole,String> USER_GROUP_GROUP_ROLE_TITLE_ACCESSOR
           
static Accessor<UserGroupRole,Long> USER_GROUP_ROLE_ID_ACCESSOR
           
static Accessor<UserGroupRole,String> USER_GROUP_ROLE_TITLE_ACCESSOR
           
 
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<Group> getGroupOrderByComparator(String orderByCol, String orderByType)
           
 Long[] getOrganizationIds(List<Organization> organizations)
           
 long[] getOrganizationIds(PortletRequest portletRequest)
           
 OrderByComparator<Organization> getOrganizationOrderByComparator(String orderByCol, String orderByType)
           
 List<Organization> 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<Role> getRoleOrderByComparator(String orderByCol, String orderByType)
           
<T> String
getUserColumnText(Locale locale, List<? extends T> list, Accessor<T,String> accessor, int count)
           
 long[] getUserGroupIds(PortletRequest portletRequest)
           
 OrderByComparator<UserGroup> getUserGroupOrderByComparator(String orderByCol, String orderByType)
           
 List<UserGroupRole> getUserGroupRoles(PortletRequest portletRequest)
           
 List<UserGroup> getUserGroups(Hits hits)
           
 OrderByComparator<User> getUserOrderByComparator(String orderByCol, String orderByType)
           
 List<User> 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

ORGANIZATION_COUNTRY_NAME_ACCESSOR

static final Accessor<Organization,String> ORGANIZATION_COUNTRY_NAME_ACCESSOR

ORGANIZATION_REGION_NAME_ACCESSOR

static final Accessor<Organization,String> ORGANIZATION_REGION_NAME_ACCESSOR

USER_GROUP_GROUP_ROLE_ID_ACCESSOR

static final Accessor<UserGroupGroupRole,Long> USER_GROUP_GROUP_ROLE_ID_ACCESSOR

USER_GROUP_GROUP_ROLE_TITLE_ACCESSOR

static final Accessor<UserGroupGroupRole,String> USER_GROUP_GROUP_ROLE_TITLE_ACCESSOR

USER_GROUP_ROLE_ID_ACCESSOR

static final Accessor<UserGroupRole,Long> USER_GROUP_ROLE_ID_ACCESSOR

USER_GROUP_ROLE_TITLE_ACCESSOR

static final Accessor<UserGroupRole,String> USER_GROUP_ROLE_TITLE_ACCESSOR
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
Throws:
PortalException

addRequiredRoles

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

filterGroupRoles

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

filterGroups

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

filterOrganizations

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

filterRoles

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

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

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
Throws:
PortalException

getGroupOrderByComparator

OrderByComparator<Group> getGroupOrderByComparator(String orderByCol,
                                                   String orderByType)

getOrganizationIds

Long[] getOrganizationIds(List<Organization> organizations)

getOrganizationIds

long[] getOrganizationIds(PortletRequest portletRequest)
                          throws PortalException
Throws:
PortalException

getOrganizationOrderByComparator

OrderByComparator<Organization> getOrganizationOrderByComparator(String orderByCol,
                                                                 String orderByType)

getOrganizations

List<Organization> getOrganizations(Hits hits)
                                    throws PortalException
Throws:
PortalException

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
Throws:
PortalException

getRoleOrderByComparator

OrderByComparator<Role> getRoleOrderByComparator(String orderByCol,
                                                 String orderByType)

getUserColumnText

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

getUserGroupIds

long[] getUserGroupIds(PortletRequest portletRequest)
                       throws PortalException
Throws:
PortalException

getUserGroupOrderByComparator

OrderByComparator<UserGroup> getUserGroupOrderByComparator(String orderByCol,
                                                           String orderByType)

getUserGroupRoles

List<UserGroupRole> getUserGroupRoles(PortletRequest portletRequest)
                                      throws PortalException
Throws:
PortalException

getUserGroups

List<UserGroup> getUserGroups(Hits hits)
                              throws PortalException
Throws:
PortalException

getUserOrderByComparator

OrderByComparator<User> getUserOrderByComparator(String orderByCol,
                                                 String orderByType)

getUsers

List<User> getUsers(Hits hits)
                    throws PortalException
Throws:
PortalException

getWebsites

List<Website> getWebsites(ActionRequest actionRequest)

getWebsites

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

hasUpdateEmailAddress

@Deprecated
boolean hasUpdateEmailAddress(PermissionChecker permissionChecker,
                                         User user)
                              throws PortalException
Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)

Throws:
PortalException

hasUpdateFieldPermission

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

hasUpdateFieldPermission

@Deprecated
boolean hasUpdateFieldPermission(User user,
                                            String field)
                                 throws PortalException
Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)

Throws:
PortalException

hasUpdateScreenName

@Deprecated
boolean hasUpdateScreenName(PermissionChecker permissionChecker,
                                       User user)
                            throws PortalException
Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)

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(String className,
                     long classPK,
                     List<Address> addresses)
                     throws PortalException
Throws:
PortalException

updateEmailAddresses

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

updateOrgLabors

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

updatePhones

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

updateWebsites

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

Liferay 7.0-ce-b4