com.dotmarketing.business
Interface UserProxyAPI

All Known Implementing Classes:

UserProxyAPIImpl

public interface UserProxyAPI

Method Summary

java.util.List<java.lang.String>	findUsersTitle() This method return all the possible title set by the users.
UserProxy	getUserProxy(java.lang.String userId, com.liferay.portal.model.User user, boolean respectFrontEndRoles)
UserProxy	getUserProxy(com.liferay.portal.model.User userToGetProxyFor, com.liferay.portal.model.User user, boolean respectFrontEndRoles)
UserProxy	getUserProxyByLongLiveCookie(java.lang.String dotCMSID, com.liferay.portal.model.User user, boolean respectFrontEndRoles)
void	saveUserProxy(UserProxy userProxy, com.liferay.portal.model.User user, boolean respectFrontEndRoles)
java.util.HashMap<java.lang.String,java.lang.Object>	searchUsersAndUsersProxy(java.lang.String firstName, java.lang.String lastName, java.lang.String title, boolean showUserGroups, java.util.List<Role> roles, boolean showUserRoles, java.lang.String orderBy, int page, int pageSize) Deprecated.

Method Detail

getUserProxy

UserProxy getUserProxy(java.lang.String userId,
                       com.liferay.portal.model.User user,
                       boolean respectFrontEndRoles)
                       throws DotRuntimeException,
                              DotSecurityException,
                              DotDataException

Throws:

DotRuntimeException

DotSecurityException

DotDataException

getUserProxy

UserProxy getUserProxy(com.liferay.portal.model.User userToGetProxyFor,
                       com.liferay.portal.model.User user,
                       boolean respectFrontEndRoles)
                       throws DotRuntimeException,
                              DotSecurityException,
                              DotDataException

Throws:

DotRuntimeException

DotSecurityException

DotDataException

getUserProxyByLongLiveCookie

UserProxy getUserProxyByLongLiveCookie(java.lang.String dotCMSID,
                                       com.liferay.portal.model.User user,
                                       boolean respectFrontEndRoles)
                                       throws DotRuntimeException,
                                              DotSecurityException,
                                              DotDataException

Throws:

DotRuntimeException

DotSecurityException

DotDataException

saveUserProxy

void saveUserProxy(UserProxy userProxy,
                   com.liferay.portal.model.User user,
                   boolean respectFrontEndRoles)
                   throws DotRuntimeException,
                          DotDataException,
                          DotSecurityException

Throws:

DotRuntimeException

DotDataException

DotSecurityException

findUsersTitle

java.util.List<java.lang.String> findUsersTitle()
                                                throws DotDataException

This method return all the possible title set by the users. This method will ALWAYS hit the DB

Returns:

List of titles.

Throws:

DotDataException

searchUsersAndUsersProxy

java.util.HashMap<java.lang.String,java.lang.Object> searchUsersAndUsersProxy(java.lang.String firstName,
                                                                              java.lang.String lastName,
                                                                              java.lang.String title,
                                                                              boolean showUserGroups,
                                                                              java.util.List<Role> roles,
                                                                              boolean showUserRoles,
                                                                              java.lang.String orderBy,
                                                                              int page,
                                                                              int pageSize)
                                                                              throws DotDataException

Deprecated.

This method return a paginated list of the info of user and user proxy that have a firstname, lastname, user proxy title, groups and roles. This method will ALWAYS Hit DB

Parameters:

firstName - compare string

lastName - compare string

title - compare string

groups - list of groups

showUserGroups - boolean. If true then a list of group names will returned in the result. This value will be automatically set to true if the parameter group list is greater than 0 or the order by parameter is ordered by group name.

roles - list of roles

showUserRoles - boolean. If true then a list of role names will returned in the result. This value will be automatically set to true if the parameter role list is greater than 0 or the order by parameter is ordered by role name.

orderBy - how will be ordered the result

page - page to display

pageSize - number of element to show in the page

Returns:

HashMap: The list of users found will be associated to the key 'users'. The list of users proxy found will be associated to the key 'usersProxy'. The total number of items returned is associated to the key 'total'. A list of group names can be found and associated to the key 'groupNames' if a group list is passed in. A list of role names can be found and associated to the key 'roleNames' if a role list is passed in.

Throws:

DotDataException