Liferay 6.0-ee

com.liferay.portal.service.persistence
Interface UserPersistence

All Superinterfaces:
BasePersistence<User>
All Known Implementing Classes:
UserPersistenceImpl

public interface UserPersistence
extends BasePersistence<User>

The persistence interface for the user service.

Never modify or reference this interface directly. Always use UserUtil to access the user persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.

Caching information and settings can be found in portal.properties

See Also:
UserPersistenceImpl, UserUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 void addGroup(long pk, Group group)
          Adds an association between the user and the group.
 void addGroup(long pk, long groupPK)
          Adds an association between the user and the group.
 void addGroups(long pk, List<Group> groups)
          Adds an association between the user and the groups.
 void addGroups(long pk, long[] groupPKs)
          Adds an association between the user and the groups.
 void addOrganization(long pk, long organizationPK)
          Adds an association between the user and the organization.
 void addOrganization(long pk, Organization organization)
          Adds an association between the user and the organization.
 void addOrganizations(long pk, List<Organization> organizations)
          Adds an association between the user and the organizations.
 void addOrganizations(long pk, long[] organizationPKs)
          Adds an association between the user and the organizations.
 void addPermission(long pk, long permissionPK)
          Adds an association between the user and the permission.
 void addPermission(long pk, Permission permission)
          Adds an association between the user and the permission.
 void addPermissions(long pk, List<Permission> permissions)
          Adds an association between the user and the permissions.
 void addPermissions(long pk, long[] permissionPKs)
          Adds an association between the user and the permissions.
 void addRole(long pk, long rolePK)
          Adds an association between the user and the role.
 void addRole(long pk, Role role)
          Adds an association between the user and the role.
 void addRoles(long pk, List<Role> roles)
          Adds an association between the user and the roles.
 void addRoles(long pk, long[] rolePKs)
          Adds an association between the user and the roles.
 void addTeam(long pk, long teamPK)
          Adds an association between the user and the team.
 void addTeam(long pk, Team team)
          Adds an association between the user and the team.
 void addTeams(long pk, List<Team> teams)
          Adds an association between the user and the teams.
 void addTeams(long pk, long[] teamPKs)
          Adds an association between the user and the teams.
 void addUserGroup(long pk, long userGroupPK)
          Adds an association between the user and the user group.
 void addUserGroup(long pk, UserGroup userGroup)
          Adds an association between the user and the user group.
 void addUserGroups(long pk, List<UserGroup> userGroups)
          Adds an association between the user and the user groups.
 void addUserGroups(long pk, long[] userGroupPKs)
          Adds an association between the user and the user groups.
 void cacheResult(List<User> users)
          Caches the users in the entity cache if it is enabled.
 void cacheResult(User user)
          Caches the user in the entity cache if it is enabled.
 void clearGroups(long pk)
          Clears all associations between the user and its groups.
 void clearOrganizations(long pk)
          Clears all associations between the user and its organizations.
 void clearPermissions(long pk)
          Clears all associations between the user and its permissions.
 void clearRoles(long pk)
          Clears all associations between the user and its roles.
 void clearTeams(long pk)
          Clears all associations between the user and its teams.
 void clearUserGroups(long pk)
          Clears all associations between the user and its user groups.
 boolean containsGroup(long pk, long groupPK)
          Determines whether the group is associated with the user.
 boolean containsGroups(long pk)
          Determines whether the user has any groups associated with it.
 boolean containsOrganization(long pk, long organizationPK)
          Determines whether the organization is associated with the user.
 boolean containsOrganizations(long pk)
          Determines whether the user has any organizations associated with it.
 boolean containsPermission(long pk, long permissionPK)
          Determines whether the permission is associated with the user.
 boolean containsPermissions(long pk)
          Determines whether the user has any permissions associated with it.
 boolean containsRole(long pk, long rolePK)
          Determines whether the role is associated with the user.
 boolean containsRoles(long pk)
          Determines whether the user has any roles associated with it.
 boolean containsTeam(long pk, long teamPK)
          Determines whether the team is associated with the user.
 boolean containsTeams(long pk)
          Determines whether the user has any teams associated with it.
 boolean containsUserGroup(long pk, long userGroupPK)
          Determines whether the user group is associated with the user.
 boolean containsUserGroups(long pk)
          Determines whether the user has any user groups associated with it.
 int countAll()
          Counts all the users.
 int countByC_A(long companyId, boolean active)
          Counts all the users where companyId = ? and active = ?.
 int countByC_DU(long companyId, boolean defaultUser)
          Counts all the users where companyId = ? and defaultUser = ?.
 int countByC_EA(long companyId, String emailAddress)
          Counts all the users where companyId = ? and emailAddress = ?.
 int countByC_FID(long companyId, long facebookId)
          Counts all the users where companyId = ? and facebookId = ?.
 int countByC_O(long companyId, String openId)
          Counts all the users where companyId = ? and openId = ?.
 int countByC_SN(long companyId, String screenName)
          Counts all the users where companyId = ? and screenName = ?.
 int countByC_U(long companyId, long userId)
          Counts all the users where companyId = ? and userId = ?.
 int countByCompanyId(long companyId)
          Counts all the users where companyId = ?.
 int countByContactId(long contactId)
          Counts all the users where contactId = ?.
 int countByEmailAddress(String emailAddress)
          Counts all the users where emailAddress = ?.
 int countByPortraitId(long portraitId)
          Counts all the users where portraitId = ?.
 int countByUuid(String uuid)
          Counts all the users where uuid = ?.
 User create(long userId)
          Creates a new user with the primary key.
 User fetchByC_DU(long companyId, boolean defaultUser)
          Finds the user where companyId = ? and defaultUser = ? or returns null if it could not be found.
 User fetchByC_DU(long companyId, boolean defaultUser, boolean retrieveFromCache)
          Finds the user where companyId = ? and defaultUser = ? or returns null if it could not be found, optionally using the finder cache.
 User fetchByC_EA(long companyId, String emailAddress)
          Finds the user where companyId = ? and emailAddress = ? or returns null if it could not be found.
 User fetchByC_EA(long companyId, String emailAddress, boolean retrieveFromCache)
          Finds the user where companyId = ? and emailAddress = ? or returns null if it could not be found, optionally using the finder cache.
 User fetchByC_FID(long companyId, long facebookId)
          Finds the user where companyId = ? and facebookId = ? or returns null if it could not be found.
 User fetchByC_FID(long companyId, long facebookId, boolean retrieveFromCache)
          Finds the user where companyId = ? and facebookId = ? or returns null if it could not be found, optionally using the finder cache.
 User fetchByC_O(long companyId, String openId)
          Finds the user where companyId = ? and openId = ? or returns null if it could not be found.
 User fetchByC_O(long companyId, String openId, boolean retrieveFromCache)
          Finds the user where companyId = ? and openId = ? or returns null if it could not be found, optionally using the finder cache.
 User fetchByC_SN(long companyId, String screenName)
          Finds the user where companyId = ? and screenName = ? or returns null if it could not be found.
 User fetchByC_SN(long companyId, String screenName, boolean retrieveFromCache)
          Finds the user where companyId = ? and screenName = ? or returns null if it could not be found, optionally using the finder cache.
 User fetchByC_U(long companyId, long userId)
          Finds the user where companyId = ? and userId = ? or returns null if it could not be found.
 User fetchByC_U(long companyId, long userId, boolean retrieveFromCache)
          Finds the user where companyId = ? and userId = ? or returns null if it could not be found, optionally using the finder cache.
 User fetchByContactId(long contactId)
          Finds the user where contactId = ? or returns null if it could not be found.
 User fetchByContactId(long contactId, boolean retrieveFromCache)
          Finds the user where contactId = ? or returns null if it could not be found, optionally using the finder cache.
 User fetchByPortraitId(long portraitId)
          Finds the user where portraitId = ? or returns null if it could not be found.
 User fetchByPortraitId(long portraitId, boolean retrieveFromCache)
          Finds the user where portraitId = ? or returns null if it could not be found, optionally using the finder cache.
 User fetchByPrimaryKey(long userId)
          Finds the user with the primary key or returns null if it could not be found.
 List<User> findAll()
          Finds all the users.
 List<User> findAll(int start, int end)
          Finds a range of all the users.
 List<User> findAll(int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the users.
 User findByC_A_First(long companyId, boolean active, OrderByComparator orderByComparator)
          Finds the first user in the ordered set where companyId = ? and active = ?.
 User findByC_A_Last(long companyId, boolean active, OrderByComparator orderByComparator)
          Finds the last user in the ordered set where companyId = ? and active = ?.
 User[] findByC_A_PrevAndNext(long userId, long companyId, boolean active, OrderByComparator orderByComparator)
          Finds the users before and after the current user in the ordered set where companyId = ? and active = ?.
 List<User> findByC_A(long companyId, boolean active)
          Finds all the users where companyId = ? and active = ?.
 List<User> findByC_A(long companyId, boolean active, int start, int end)
          Finds a range of all the users where companyId = ? and active = ?.
 List<User> findByC_A(long companyId, boolean active, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the users where companyId = ? and active = ?.
 User findByC_DU(long companyId, boolean defaultUser)
          Finds the user where companyId = ? and defaultUser = ? or throws a NoSuchUserException if it could not be found.
 User findByC_EA(long companyId, String emailAddress)
          Finds the user where companyId = ? and emailAddress = ? or throws a NoSuchUserException if it could not be found.
 User findByC_FID(long companyId, long facebookId)
          Finds the user where companyId = ? and facebookId = ? or throws a NoSuchUserException if it could not be found.
 User findByC_O(long companyId, String openId)
          Finds the user where companyId = ? and openId = ? or throws a NoSuchUserException if it could not be found.
 User findByC_SN(long companyId, String screenName)
          Finds the user where companyId = ? and screenName = ? or throws a NoSuchUserException if it could not be found.
 User findByC_U(long companyId, long userId)
          Finds the user where companyId = ? and userId = ? or throws a NoSuchUserException if it could not be found.
 User findByCompanyId_First(long companyId, OrderByComparator orderByComparator)
          Finds the first user in the ordered set where companyId = ?.
 User findByCompanyId_Last(long companyId, OrderByComparator orderByComparator)
          Finds the last user in the ordered set where companyId = ?.
 User[] findByCompanyId_PrevAndNext(long userId, long companyId, OrderByComparator orderByComparator)
          Finds the users before and after the current user in the ordered set where companyId = ?.
 List<User> findByCompanyId(long companyId)
          Finds all the users where companyId = ?.
 List<User> findByCompanyId(long companyId, int start, int end)
          Finds a range of all the users where companyId = ?.
 List<User> findByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the users where companyId = ?.
 User findByContactId(long contactId)
          Finds the user where contactId = ? or throws a NoSuchUserException if it could not be found.
 User findByEmailAddress_First(String emailAddress, OrderByComparator orderByComparator)
          Finds the first user in the ordered set where emailAddress = ?.
 User findByEmailAddress_Last(String emailAddress, OrderByComparator orderByComparator)
          Finds the last user in the ordered set where emailAddress = ?.
 User[] findByEmailAddress_PrevAndNext(long userId, String emailAddress, OrderByComparator orderByComparator)
          Finds the users before and after the current user in the ordered set where emailAddress = ?.
 List<User> findByEmailAddress(String emailAddress)
          Finds all the users where emailAddress = ?.
 List<User> findByEmailAddress(String emailAddress, int start, int end)
          Finds a range of all the users where emailAddress = ?.
 List<User> findByEmailAddress(String emailAddress, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the users where emailAddress = ?.
 User findByPortraitId(long portraitId)
          Finds the user where portraitId = ? or throws a NoSuchUserException if it could not be found.
 User findByPrimaryKey(long userId)
          Finds the user with the primary key or throws a NoSuchUserException if it could not be found.
 User findByUuid_First(String uuid, OrderByComparator orderByComparator)
          Finds the first user in the ordered set where uuid = ?.
 User findByUuid_Last(String uuid, OrderByComparator orderByComparator)
          Finds the last user in the ordered set where uuid = ?.
 User[] findByUuid_PrevAndNext(long userId, String uuid, OrderByComparator orderByComparator)
          Finds the users before and after the current user in the ordered set where uuid = ?.
 List<User> findByUuid(String uuid)
          Finds all the users where uuid = ?.
 List<User> findByUuid(String uuid, int start, int end)
          Finds a range of all the users where uuid = ?.
 List<User> findByUuid(String uuid, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the users where uuid = ?.
 List<Group> getGroups(long pk)
          Gets all the groups associated with the user.
 List<Group> getGroups(long pk, int start, int end)
          Gets a range of all the groups associated with the user.
 List<Group> getGroups(long pk, int start, int end, OrderByComparator orderByComparator)
          Gets an ordered range of all the groups associated with the user.
 int getGroupsSize(long pk)
          Gets the number of groups associated with the user.
 List<Organization> getOrganizations(long pk)
          Gets all the organizations associated with the user.
 List<Organization> getOrganizations(long pk, int start, int end)
          Gets a range of all the organizations associated with the user.
 List<Organization> getOrganizations(long pk, int start, int end, OrderByComparator orderByComparator)
          Gets an ordered range of all the organizations associated with the user.
 int getOrganizationsSize(long pk)
          Gets the number of organizations associated with the user.
 List<Permission> getPermissions(long pk)
          Gets all the permissions associated with the user.
 List<Permission> getPermissions(long pk, int start, int end)
          Gets a range of all the permissions associated with the user.
 List<Permission> getPermissions(long pk, int start, int end, OrderByComparator orderByComparator)
          Gets an ordered range of all the permissions associated with the user.
 int getPermissionsSize(long pk)
          Gets the number of permissions associated with the user.
 List<Role> getRoles(long pk)
          Gets all the roles associated with the user.
 List<Role> getRoles(long pk, int start, int end)
          Gets a range of all the roles associated with the user.
 List<Role> getRoles(long pk, int start, int end, OrderByComparator orderByComparator)
          Gets an ordered range of all the roles associated with the user.
 int getRolesSize(long pk)
          Gets the number of roles associated with the user.
 List<Team> getTeams(long pk)
          Gets all the teams associated with the user.
 List<Team> getTeams(long pk, int start, int end)
          Gets a range of all the teams associated with the user.
 List<Team> getTeams(long pk, int start, int end, OrderByComparator orderByComparator)
          Gets an ordered range of all the teams associated with the user.
 int getTeamsSize(long pk)
          Gets the number of teams associated with the user.
 List<UserGroup> getUserGroups(long pk)
          Gets all the user groups associated with the user.
 List<UserGroup> getUserGroups(long pk, int start, int end)
          Gets a range of all the user groups associated with the user.
 List<UserGroup> getUserGroups(long pk, int start, int end, OrderByComparator orderByComparator)
          Gets an ordered range of all the user groups associated with the user.
 int getUserGroupsSize(long pk)
          Gets the number of user groups associated with the user.
 User remove(long userId)
          Removes the user with the primary key from the database.
 void removeAll()
          Removes all the users from the database.
 void removeByC_A(long companyId, boolean active)
          Removes all the users where companyId = ? and active = ? from the database.
 void removeByC_DU(long companyId, boolean defaultUser)
          Removes the user where companyId = ? and defaultUser = ? from the database.
 void removeByC_EA(long companyId, String emailAddress)
          Removes the user where companyId = ? and emailAddress = ? from the database.
 void removeByC_FID(long companyId, long facebookId)
          Removes the user where companyId = ? and facebookId = ? from the database.
 void removeByC_O(long companyId, String openId)
          Removes the user where companyId = ? and openId = ? from the database.
 void removeByC_SN(long companyId, String screenName)
          Removes the user where companyId = ? and screenName = ? from the database.
 void removeByC_U(long companyId, long userId)
          Removes the user where companyId = ? and userId = ? from the database.
 void removeByCompanyId(long companyId)
          Removes all the users where companyId = ? from the database.
 void removeByContactId(long contactId)
          Removes the user where contactId = ? from the database.
 void removeByEmailAddress(String emailAddress)
          Removes all the users where emailAddress = ? from the database.
 void removeByPortraitId(long portraitId)
          Removes the user where portraitId = ? from the database.
 void removeByUuid(String uuid)
          Removes all the users where uuid = ? from the database.
 void removeGroup(long pk, Group group)
          Removes the association between the user and the group.
 void removeGroup(long pk, long groupPK)
          Removes the association between the user and the group.
 void removeGroups(long pk, List<Group> groups)
          Removes the association between the user and the groups.
 void removeGroups(long pk, long[] groupPKs)
          Removes the association between the user and the groups.
 void removeOrganization(long pk, long organizationPK)
          Removes the association between the user and the organization.
 void removeOrganization(long pk, Organization organization)
          Removes the association between the user and the organization.
 void removeOrganizations(long pk, List<Organization> organizations)
          Removes the association between the user and the organizations.
 void removeOrganizations(long pk, long[] organizationPKs)
          Removes the association between the user and the organizations.
 void removePermission(long pk, long permissionPK)
          Removes the association between the user and the permission.
 void removePermission(long pk, Permission permission)
          Removes the association between the user and the permission.
 void removePermissions(long pk, List<Permission> permissions)
          Removes the association between the user and the permissions.
 void removePermissions(long pk, long[] permissionPKs)
          Removes the association between the user and the permissions.
 void removeRole(long pk, long rolePK)
          Removes the association between the user and the role.
 void removeRole(long pk, Role role)
          Removes the association between the user and the role.
 void removeRoles(long pk, List<Role> roles)
          Removes the association between the user and the roles.
 void removeRoles(long pk, long[] rolePKs)
          Removes the association between the user and the roles.
 void removeTeam(long pk, long teamPK)
          Removes the association between the user and the team.
 void removeTeam(long pk, Team team)
          Removes the association between the user and the team.
 void removeTeams(long pk, List<Team> teams)
          Removes the association between the user and the teams.
 void removeTeams(long pk, long[] teamPKs)
          Removes the association between the user and the teams.
 void removeUserGroup(long pk, long userGroupPK)
          Removes the association between the user and the user group.
 void removeUserGroup(long pk, UserGroup userGroup)
          Removes the association between the user and the user group.
 void removeUserGroups(long pk, List<UserGroup> userGroups)
          Removes the association between the user and the user groups.
 void removeUserGroups(long pk, long[] userGroupPKs)
          Removes the association between the user and the user groups.
 void setGroups(long pk, List<Group> groups)
          Sets the groups associated with the user, removing and adding associations as necessary.
 void setGroups(long pk, long[] groupPKs)
          Sets the groups associated with the user, removing and adding associations as necessary.
 void setOrganizations(long pk, List<Organization> organizations)
          Sets the organizations associated with the user, removing and adding associations as necessary.
 void setOrganizations(long pk, long[] organizationPKs)
          Sets the organizations associated with the user, removing and adding associations as necessary.
 void setPermissions(long pk, List<Permission> permissions)
          Sets the permissions associated with the user, removing and adding associations as necessary.
 void setPermissions(long pk, long[] permissionPKs)
          Sets the permissions associated with the user, removing and adding associations as necessary.
 void setRoles(long pk, List<Role> roles)
          Sets the roles associated with the user, removing and adding associations as necessary.
 void setRoles(long pk, long[] rolePKs)
          Sets the roles associated with the user, removing and adding associations as necessary.
 void setTeams(long pk, List<Team> teams)
          Sets the teams associated with the user, removing and adding associations as necessary.
 void setTeams(long pk, long[] teamPKs)
          Sets the teams associated with the user, removing and adding associations as necessary.
 void setUserGroups(long pk, List<UserGroup> userGroups)
          Sets the user groups associated with the user, removing and adding associations as necessary.
 void setUserGroups(long pk, long[] userGroupPKs)
          Sets the user groups associated with the user, removing and adding associations as necessary.
 User updateImpl(User user, boolean merge)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, registerListener, remove, remove, setDataSource, unregisterListener, update, update
 

Method Detail

cacheResult

void cacheResult(User user)
Caches the user in the entity cache if it is enabled.

Parameters:
user - the user to cache

cacheResult

void cacheResult(List<User> users)
Caches the users in the entity cache if it is enabled.

Parameters:
users - the users to cache

create

User create(long userId)
Creates a new user with the primary key. Does not add the user to the database.

Parameters:
userId - the primary key for the new user
Returns:
the new user

remove

User remove(long userId)
            throws NoSuchUserException,
                   SystemException
Removes the user with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
userId - the primary key of the user to remove
Returns:
the user that was removed
Throws:
NoSuchUserException - if a user with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

User updateImpl(User user,
                boolean merge)
                throws SystemException
Throws:
SystemException

findByPrimaryKey

User findByPrimaryKey(long userId)
                      throws NoSuchUserException,
                             SystemException
Finds the user with the primary key or throws a NoSuchUserException if it could not be found.

Parameters:
userId - the primary key of the user to find
Returns:
the user
Throws:
NoSuchUserException - if a user with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

User fetchByPrimaryKey(long userId)
                       throws SystemException
Finds the user with the primary key or returns null if it could not be found.

Parameters:
userId - the primary key of the user to find
Returns:
the user, or null if a user with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findByUuid

List<User> findByUuid(String uuid)
                      throws SystemException
Finds all the users where uuid = ?.

Parameters:
uuid - the uuid to search with
Returns:
the matching users
Throws:
SystemException - if a system exception occurred

findByUuid

List<User> findByUuid(String uuid,
                      int start,
                      int end)
                      throws SystemException
Finds a range of all the users where uuid = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
uuid - the uuid to search with
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
Returns:
the range of matching users
Throws:
SystemException - if a system exception occurred

findByUuid

List<User> findByUuid(String uuid,
                      int start,
                      int end,
                      OrderByComparator orderByComparator)
                      throws SystemException
Finds an ordered range of all the users where uuid = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
uuid - the uuid to search with
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching users
Throws:
SystemException - if a system exception occurred

findByUuid_First

User findByUuid_First(String uuid,
                      OrderByComparator orderByComparator)
                      throws NoSuchUserException,
                             SystemException
Finds the first user in the ordered set where uuid = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
uuid - the uuid to search with
orderByComparator - the comparator to order the set by
Returns:
the first matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

findByUuid_Last

User findByUuid_Last(String uuid,
                     OrderByComparator orderByComparator)
                     throws NoSuchUserException,
                            SystemException
Finds the last user in the ordered set where uuid = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
uuid - the uuid to search with
orderByComparator - the comparator to order the set by
Returns:
the last matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

findByUuid_PrevAndNext

User[] findByUuid_PrevAndNext(long userId,
                              String uuid,
                              OrderByComparator orderByComparator)
                              throws NoSuchUserException,
                                     SystemException
Finds the users before and after the current user in the ordered set where uuid = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
userId - the primary key of the current user
uuid - the uuid to search with
orderByComparator - the comparator to order the set by
Returns:
the previous, current, and next user
Throws:
NoSuchUserException - if a user with the primary key could not be found
SystemException - if a system exception occurred

findByCompanyId

List<User> findByCompanyId(long companyId)
                           throws SystemException
Finds all the users where companyId = ?.

Parameters:
companyId - the company id to search with
Returns:
the matching users
Throws:
SystemException - if a system exception occurred

findByCompanyId

List<User> findByCompanyId(long companyId,
                           int start,
                           int end)
                           throws SystemException
Finds a range of all the users where companyId = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the company id to search with
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
Returns:
the range of matching users
Throws:
SystemException - if a system exception occurred

findByCompanyId

List<User> findByCompanyId(long companyId,
                           int start,
                           int end,
                           OrderByComparator orderByComparator)
                           throws SystemException
Finds an ordered range of all the users where companyId = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the company id to search with
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching users
Throws:
SystemException - if a system exception occurred

findByCompanyId_First

User findByCompanyId_First(long companyId,
                           OrderByComparator orderByComparator)
                           throws NoSuchUserException,
                                  SystemException
Finds the first user in the ordered set where companyId = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the company id to search with
orderByComparator - the comparator to order the set by
Returns:
the first matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

findByCompanyId_Last

User findByCompanyId_Last(long companyId,
                          OrderByComparator orderByComparator)
                          throws NoSuchUserException,
                                 SystemException
Finds the last user in the ordered set where companyId = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the company id to search with
orderByComparator - the comparator to order the set by
Returns:
the last matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

findByCompanyId_PrevAndNext

User[] findByCompanyId_PrevAndNext(long userId,
                                   long companyId,
                                   OrderByComparator orderByComparator)
                                   throws NoSuchUserException,
                                          SystemException
Finds the users before and after the current user in the ordered set where companyId = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
userId - the primary key of the current user
companyId - the company id to search with
orderByComparator - the comparator to order the set by
Returns:
the previous, current, and next user
Throws:
NoSuchUserException - if a user with the primary key could not be found
SystemException - if a system exception occurred

findByContactId

User findByContactId(long contactId)
                     throws NoSuchUserException,
                            SystemException
Finds the user where contactId = ? or throws a NoSuchUserException if it could not be found.

Parameters:
contactId - the contact id to search with
Returns:
the matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

fetchByContactId

User fetchByContactId(long contactId)
                      throws SystemException
Finds the user where contactId = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
contactId - the contact id to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

fetchByContactId

User fetchByContactId(long contactId,
                      boolean retrieveFromCache)
                      throws SystemException
Finds the user where contactId = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
contactId - the contact id to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

findByEmailAddress

List<User> findByEmailAddress(String emailAddress)
                              throws SystemException
Finds all the users where emailAddress = ?.

Parameters:
emailAddress - the email address to search with
Returns:
the matching users
Throws:
SystemException - if a system exception occurred

findByEmailAddress

List<User> findByEmailAddress(String emailAddress,
                              int start,
                              int end)
                              throws SystemException
Finds a range of all the users where emailAddress = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
emailAddress - the email address to search with
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
Returns:
the range of matching users
Throws:
SystemException - if a system exception occurred

findByEmailAddress

List<User> findByEmailAddress(String emailAddress,
                              int start,
                              int end,
                              OrderByComparator orderByComparator)
                              throws SystemException
Finds an ordered range of all the users where emailAddress = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
emailAddress - the email address to search with
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching users
Throws:
SystemException - if a system exception occurred

findByEmailAddress_First

User findByEmailAddress_First(String emailAddress,
                              OrderByComparator orderByComparator)
                              throws NoSuchUserException,
                                     SystemException
Finds the first user in the ordered set where emailAddress = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
emailAddress - the email address to search with
orderByComparator - the comparator to order the set by
Returns:
the first matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

findByEmailAddress_Last

User findByEmailAddress_Last(String emailAddress,
                             OrderByComparator orderByComparator)
                             throws NoSuchUserException,
                                    SystemException
Finds the last user in the ordered set where emailAddress = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
emailAddress - the email address to search with
orderByComparator - the comparator to order the set by
Returns:
the last matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

findByEmailAddress_PrevAndNext

User[] findByEmailAddress_PrevAndNext(long userId,
                                      String emailAddress,
                                      OrderByComparator orderByComparator)
                                      throws NoSuchUserException,
                                             SystemException
Finds the users before and after the current user in the ordered set where emailAddress = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
userId - the primary key of the current user
emailAddress - the email address to search with
orderByComparator - the comparator to order the set by
Returns:
the previous, current, and next user
Throws:
NoSuchUserException - if a user with the primary key could not be found
SystemException - if a system exception occurred

findByPortraitId

User findByPortraitId(long portraitId)
                      throws NoSuchUserException,
                             SystemException
Finds the user where portraitId = ? or throws a NoSuchUserException if it could not be found.

Parameters:
portraitId - the portrait id to search with
Returns:
the matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

fetchByPortraitId

User fetchByPortraitId(long portraitId)
                       throws SystemException
Finds the user where portraitId = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
portraitId - the portrait id to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

fetchByPortraitId

User fetchByPortraitId(long portraitId,
                       boolean retrieveFromCache)
                       throws SystemException
Finds the user where portraitId = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
portraitId - the portrait id to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

findByC_U

User findByC_U(long companyId,
               long userId)
               throws NoSuchUserException,
                      SystemException
Finds the user where companyId = ? and userId = ? or throws a NoSuchUserException if it could not be found.

Parameters:
companyId - the company id to search with
userId - the user id to search with
Returns:
the matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

fetchByC_U

User fetchByC_U(long companyId,
                long userId)
                throws SystemException
Finds the user where companyId = ? and userId = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company id to search with
userId - the user id to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_U

User fetchByC_U(long companyId,
                long userId,
                boolean retrieveFromCache)
                throws SystemException
Finds the user where companyId = ? and userId = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company id to search with
userId - the user id to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

findByC_DU

User findByC_DU(long companyId,
                boolean defaultUser)
                throws NoSuchUserException,
                       SystemException
Finds the user where companyId = ? and defaultUser = ? or throws a NoSuchUserException if it could not be found.

Parameters:
companyId - the company id to search with
defaultUser - the default user to search with
Returns:
the matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

fetchByC_DU

User fetchByC_DU(long companyId,
                 boolean defaultUser)
                 throws SystemException
Finds the user where companyId = ? and defaultUser = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company id to search with
defaultUser - the default user to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_DU

User fetchByC_DU(long companyId,
                 boolean defaultUser,
                 boolean retrieveFromCache)
                 throws SystemException
Finds the user where companyId = ? and defaultUser = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company id to search with
defaultUser - the default user to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

findByC_SN

User findByC_SN(long companyId,
                String screenName)
                throws NoSuchUserException,
                       SystemException
Finds the user where companyId = ? and screenName = ? or throws a NoSuchUserException if it could not be found.

Parameters:
companyId - the company id to search with
screenName - the screen name to search with
Returns:
the matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

fetchByC_SN

User fetchByC_SN(long companyId,
                 String screenName)
                 throws SystemException
Finds the user where companyId = ? and screenName = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company id to search with
screenName - the screen name to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_SN

User fetchByC_SN(long companyId,
                 String screenName,
                 boolean retrieveFromCache)
                 throws SystemException
Finds the user where companyId = ? and screenName = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company id to search with
screenName - the screen name to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

findByC_EA

User findByC_EA(long companyId,
                String emailAddress)
                throws NoSuchUserException,
                       SystemException
Finds the user where companyId = ? and emailAddress = ? or throws a NoSuchUserException if it could not be found.

Parameters:
companyId - the company id to search with
emailAddress - the email address to search with
Returns:
the matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

fetchByC_EA

User fetchByC_EA(long companyId,
                 String emailAddress)
                 throws SystemException
Finds the user where companyId = ? and emailAddress = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company id to search with
emailAddress - the email address to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_EA

User fetchByC_EA(long companyId,
                 String emailAddress,
                 boolean retrieveFromCache)
                 throws SystemException
Finds the user where companyId = ? and emailAddress = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company id to search with
emailAddress - the email address to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

findByC_FID

User findByC_FID(long companyId,
                 long facebookId)
                 throws NoSuchUserException,
                        SystemException
Finds the user where companyId = ? and facebookId = ? or throws a NoSuchUserException if it could not be found.

Parameters:
companyId - the company id to search with
facebookId - the facebook id to search with
Returns:
the matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

fetchByC_FID

User fetchByC_FID(long companyId,
                  long facebookId)
                  throws SystemException
Finds the user where companyId = ? and facebookId = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company id to search with
facebookId - the facebook id to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_FID

User fetchByC_FID(long companyId,
                  long facebookId,
                  boolean retrieveFromCache)
                  throws SystemException
Finds the user where companyId = ? and facebookId = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company id to search with
facebookId - the facebook id to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

findByC_O

User findByC_O(long companyId,
               String openId)
               throws NoSuchUserException,
                      SystemException
Finds the user where companyId = ? and openId = ? or throws a NoSuchUserException if it could not be found.

Parameters:
companyId - the company id to search with
openId - the open id to search with
Returns:
the matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

fetchByC_O

User fetchByC_O(long companyId,
                String openId)
                throws SystemException
Finds the user where companyId = ? and openId = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company id to search with
openId - the open id to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_O

User fetchByC_O(long companyId,
                String openId,
                boolean retrieveFromCache)
                throws SystemException
Finds the user where companyId = ? and openId = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company id to search with
openId - the open id to search with
Returns:
the matching user, or null if a matching user could not be found
Throws:
SystemException - if a system exception occurred

findByC_A

List<User> findByC_A(long companyId,
                     boolean active)
                     throws SystemException
Finds all the users where companyId = ? and active = ?.

Parameters:
companyId - the company id to search with
active - the active to search with
Returns:
the matching users
Throws:
SystemException - if a system exception occurred

findByC_A

List<User> findByC_A(long companyId,
                     boolean active,
                     int start,
                     int end)
                     throws SystemException
Finds a range of all the users where companyId = ? and active = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the company id to search with
active - the active to search with
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
Returns:
the range of matching users
Throws:
SystemException - if a system exception occurred

findByC_A

List<User> findByC_A(long companyId,
                     boolean active,
                     int start,
                     int end,
                     OrderByComparator orderByComparator)
                     throws SystemException
Finds an ordered range of all the users where companyId = ? and active = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the company id to search with
active - the active to search with
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching users
Throws:
SystemException - if a system exception occurred

findByC_A_First

User findByC_A_First(long companyId,
                     boolean active,
                     OrderByComparator orderByComparator)
                     throws NoSuchUserException,
                            SystemException
Finds the first user in the ordered set where companyId = ? and active = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the company id to search with
active - the active to search with
orderByComparator - the comparator to order the set by
Returns:
the first matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

findByC_A_Last

User findByC_A_Last(long companyId,
                    boolean active,
                    OrderByComparator orderByComparator)
                    throws NoSuchUserException,
                           SystemException
Finds the last user in the ordered set where companyId = ? and active = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the company id to search with
active - the active to search with
orderByComparator - the comparator to order the set by
Returns:
the last matching user
Throws:
NoSuchUserException - if a matching user could not be found
SystemException - if a system exception occurred

findByC_A_PrevAndNext

User[] findByC_A_PrevAndNext(long userId,
                             long companyId,
                             boolean active,
                             OrderByComparator orderByComparator)
                             throws NoSuchUserException,
                                    SystemException
Finds the users before and after the current user in the ordered set where companyId = ? and active = ?.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
userId - the primary key of the current user
companyId - the company id to search with
active - the active to search with
orderByComparator - the comparator to order the set by
Returns:
the previous, current, and next user
Throws:
NoSuchUserException - if a user with the primary key could not be found
SystemException - if a system exception occurred

findAll

List<User> findAll()
                   throws SystemException
Finds all the users.

Returns:
the users
Throws:
SystemException - if a system exception occurred

findAll

List<User> findAll(int start,
                   int end)
                   throws SystemException
Finds a range of all the users.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
Returns:
the range of users
Throws:
SystemException - if a system exception occurred

findAll

List<User> findAll(int start,
                   int end,
                   OrderByComparator orderByComparator)
                   throws SystemException
Finds an ordered range of all the users.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of users
Throws:
SystemException - if a system exception occurred

removeByUuid

void removeByUuid(String uuid)
                  throws SystemException
Removes all the users where uuid = ? from the database.

Parameters:
uuid - the uuid to search with
Throws:
SystemException - if a system exception occurred

removeByCompanyId

void removeByCompanyId(long companyId)
                       throws SystemException
Removes all the users where companyId = ? from the database.

Parameters:
companyId - the company id to search with
Throws:
SystemException - if a system exception occurred

removeByContactId

void removeByContactId(long contactId)
                       throws NoSuchUserException,
                              SystemException
Removes the user where contactId = ? from the database.

Parameters:
contactId - the contact id to search with
Throws:
SystemException - if a system exception occurred
NoSuchUserException

removeByEmailAddress

void removeByEmailAddress(String emailAddress)
                          throws SystemException
Removes all the users where emailAddress = ? from the database.

Parameters:
emailAddress - the email address to search with
Throws:
SystemException - if a system exception occurred

removeByPortraitId

void removeByPortraitId(long portraitId)
                        throws NoSuchUserException,
                               SystemException
Removes the user where portraitId = ? from the database.

Parameters:
portraitId - the portrait id to search with
Throws:
SystemException - if a system exception occurred
NoSuchUserException

removeByC_U

void removeByC_U(long companyId,
                 long userId)
                 throws NoSuchUserException,
                        SystemException
Removes the user where companyId = ? and userId = ? from the database.

Parameters:
companyId - the company id to search with
userId - the user id to search with
Throws:
SystemException - if a system exception occurred
NoSuchUserException

removeByC_DU

void removeByC_DU(long companyId,
                  boolean defaultUser)
                  throws NoSuchUserException,
                         SystemException
Removes the user where companyId = ? and defaultUser = ? from the database.

Parameters:
companyId - the company id to search with
defaultUser - the default user to search with
Throws:
SystemException - if a system exception occurred
NoSuchUserException

removeByC_SN

void removeByC_SN(long companyId,
                  String screenName)
                  throws NoSuchUserException,
                         SystemException
Removes the user where companyId = ? and screenName = ? from the database.

Parameters:
companyId - the company id to search with
screenName - the screen name to search with
Throws:
SystemException - if a system exception occurred
NoSuchUserException

removeByC_EA

void removeByC_EA(long companyId,
                  String emailAddress)
                  throws NoSuchUserException,
                         SystemException
Removes the user where companyId = ? and emailAddress = ? from the database.

Parameters:
companyId - the company id to search with
emailAddress - the email address to search with
Throws:
SystemException - if a system exception occurred
NoSuchUserException

removeByC_FID

void removeByC_FID(long companyId,
                   long facebookId)
                   throws NoSuchUserException,
                          SystemException
Removes the user where companyId = ? and facebookId = ? from the database.

Parameters:
companyId - the company id to search with
facebookId - the facebook id to search with
Throws:
SystemException - if a system exception occurred
NoSuchUserException

removeByC_O

void removeByC_O(long companyId,
                 String openId)
                 throws NoSuchUserException,
                        SystemException
Removes the user where companyId = ? and openId = ? from the database.

Parameters:
companyId - the company id to search with
openId - the open id to search with
Throws:
SystemException - if a system exception occurred
NoSuchUserException

removeByC_A

void removeByC_A(long companyId,
                 boolean active)
                 throws SystemException
Removes all the users where companyId = ? and active = ? from the database.

Parameters:
companyId - the company id to search with
active - the active to search with
Throws:
SystemException - if a system exception occurred

removeAll

void removeAll()
               throws SystemException
Removes all the users from the database.

Throws:
SystemException - if a system exception occurred

countByUuid

int countByUuid(String uuid)
                throws SystemException
Counts all the users where uuid = ?.

Parameters:
uuid - the uuid to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countByCompanyId

int countByCompanyId(long companyId)
                     throws SystemException
Counts all the users where companyId = ?.

Parameters:
companyId - the company id to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countByContactId

int countByContactId(long contactId)
                     throws SystemException
Counts all the users where contactId = ?.

Parameters:
contactId - the contact id to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countByEmailAddress

int countByEmailAddress(String emailAddress)
                        throws SystemException
Counts all the users where emailAddress = ?.

Parameters:
emailAddress - the email address to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countByPortraitId

int countByPortraitId(long portraitId)
                      throws SystemException
Counts all the users where portraitId = ?.

Parameters:
portraitId - the portrait id to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countByC_U

int countByC_U(long companyId,
               long userId)
               throws SystemException
Counts all the users where companyId = ? and userId = ?.

Parameters:
companyId - the company id to search with
userId - the user id to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countByC_DU

int countByC_DU(long companyId,
                boolean defaultUser)
                throws SystemException
Counts all the users where companyId = ? and defaultUser = ?.

Parameters:
companyId - the company id to search with
defaultUser - the default user to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countByC_SN

int countByC_SN(long companyId,
                String screenName)
                throws SystemException
Counts all the users where companyId = ? and screenName = ?.

Parameters:
companyId - the company id to search with
screenName - the screen name to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countByC_EA

int countByC_EA(long companyId,
                String emailAddress)
                throws SystemException
Counts all the users where companyId = ? and emailAddress = ?.

Parameters:
companyId - the company id to search with
emailAddress - the email address to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countByC_FID

int countByC_FID(long companyId,
                 long facebookId)
                 throws SystemException
Counts all the users where companyId = ? and facebookId = ?.

Parameters:
companyId - the company id to search with
facebookId - the facebook id to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countByC_O

int countByC_O(long companyId,
               String openId)
               throws SystemException
Counts all the users where companyId = ? and openId = ?.

Parameters:
companyId - the company id to search with
openId - the open id to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countByC_A

int countByC_A(long companyId,
               boolean active)
               throws SystemException
Counts all the users where companyId = ? and active = ?.

Parameters:
companyId - the company id to search with
active - the active to search with
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Counts all the users.

Returns:
the number of users
Throws:
SystemException - if a system exception occurred

getGroups

List<Group> getGroups(long pk)
                      throws SystemException
Gets all the groups associated with the user.

Parameters:
pk - the primary key of the user to get the associated groups for
Returns:
the groups associated with the user
Throws:
SystemException - if a system exception occurred

getGroups

List<Group> getGroups(long pk,
                      int start,
                      int end)
                      throws SystemException
Gets a range of all the groups associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated groups for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
Returns:
the range of groups associated with the user
Throws:
SystemException - if a system exception occurred

getGroups

List<Group> getGroups(long pk,
                      int start,
                      int end,
                      OrderByComparator orderByComparator)
                      throws SystemException
Gets an ordered range of all the groups associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated groups for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of groups associated with the user
Throws:
SystemException - if a system exception occurred

getGroupsSize

int getGroupsSize(long pk)
                  throws SystemException
Gets the number of groups associated with the user.

Parameters:
pk - the primary key of the user to get the number of associated groups for
Returns:
the number of groups associated with the user
Throws:
SystemException - if a system exception occurred

containsGroup

boolean containsGroup(long pk,
                      long groupPK)
                      throws SystemException
Determines whether the group is associated with the user.

Parameters:
pk - the primary key of the user
groupPK - the primary key of the group
Returns:
whether the group is associated with the user
Throws:
SystemException - if a system exception occurred

containsGroups

boolean containsGroups(long pk)
                       throws SystemException
Determines whether the user has any groups associated with it.

Parameters:
pk - the primary key of the user to check for associations with groups
Returns:
whether the user has any groups associated with it
Throws:
SystemException - if a system exception occurred

addGroup

void addGroup(long pk,
              long groupPK)
              throws SystemException
Adds an association between the user and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
groupPK - the primary key of the group
Throws:
SystemException - if a system exception occurred

addGroup

void addGroup(long pk,
              Group group)
              throws SystemException
Adds an association between the user and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
group - the group
Throws:
SystemException - if a system exception occurred

addGroups

void addGroups(long pk,
               long[] groupPKs)
               throws SystemException
Adds an association between the user and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
groupPKs - the primary keys of the groups
Throws:
SystemException - if a system exception occurred

addGroups

void addGroups(long pk,
               List<Group> groups)
               throws SystemException
Adds an association between the user and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
groups - the groups
Throws:
SystemException - if a system exception occurred

clearGroups

void clearGroups(long pk)
                 throws SystemException
Clears all associations between the user and its groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to clear the associated groups from
Throws:
SystemException - if a system exception occurred

removeGroup

void removeGroup(long pk,
                 long groupPK)
                 throws SystemException
Removes the association between the user and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
groupPK - the primary key of the group
Throws:
SystemException - if a system exception occurred

removeGroup

void removeGroup(long pk,
                 Group group)
                 throws SystemException
Removes the association between the user and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
group - the group
Throws:
SystemException - if a system exception occurred

removeGroups

void removeGroups(long pk,
                  long[] groupPKs)
                  throws SystemException
Removes the association between the user and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
groupPKs - the primary keys of the groups
Throws:
SystemException - if a system exception occurred

removeGroups

void removeGroups(long pk,
                  List<Group> groups)
                  throws SystemException
Removes the association between the user and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
groups - the groups
Throws:
SystemException - if a system exception occurred

setGroups

void setGroups(long pk,
               long[] groupPKs)
               throws SystemException
Sets the groups associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
groupPKs - the primary keys of the groups to be associated with the user
Throws:
SystemException - if a system exception occurred

setGroups

void setGroups(long pk,
               List<Group> groups)
               throws SystemException
Sets the groups associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
groups - the groups to be associated with the user
Throws:
SystemException - if a system exception occurred

getOrganizations

List<Organization> getOrganizations(long pk)
                                    throws SystemException
Gets all the organizations associated with the user.

Parameters:
pk - the primary key of the user to get the associated organizations for
Returns:
the organizations associated with the user
Throws:
SystemException - if a system exception occurred

getOrganizations

List<Organization> getOrganizations(long pk,
                                    int start,
                                    int end)
                                    throws SystemException
Gets a range of all the organizations associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated organizations for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
Returns:
the range of organizations associated with the user
Throws:
SystemException - if a system exception occurred

getOrganizations

List<Organization> getOrganizations(long pk,
                                    int start,
                                    int end,
                                    OrderByComparator orderByComparator)
                                    throws SystemException
Gets an ordered range of all the organizations associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated organizations for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of organizations associated with the user
Throws:
SystemException - if a system exception occurred

getOrganizationsSize

int getOrganizationsSize(long pk)
                         throws SystemException
Gets the number of organizations associated with the user.

Parameters:
pk - the primary key of the user to get the number of associated organizations for
Returns:
the number of organizations associated with the user
Throws:
SystemException - if a system exception occurred

containsOrganization

boolean containsOrganization(long pk,
                             long organizationPK)
                             throws SystemException
Determines whether the organization is associated with the user.

Parameters:
pk - the primary key of the user
organizationPK - the primary key of the organization
Returns:
whether the organization is associated with the user
Throws:
SystemException - if a system exception occurred

containsOrganizations

boolean containsOrganizations(long pk)
                              throws SystemException
Determines whether the user has any organizations associated with it.

Parameters:
pk - the primary key of the user to check for associations with organizations
Returns:
whether the user has any organizations associated with it
Throws:
SystemException - if a system exception occurred

addOrganization

void addOrganization(long pk,
                     long organizationPK)
                     throws SystemException
Adds an association between the user and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
organizationPK - the primary key of the organization
Throws:
SystemException - if a system exception occurred

addOrganization

void addOrganization(long pk,
                     Organization organization)
                     throws SystemException
Adds an association between the user and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
organization - the organization
Throws:
SystemException - if a system exception occurred

addOrganizations

void addOrganizations(long pk,
                      long[] organizationPKs)
                      throws SystemException
Adds an association between the user and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
organizationPKs - the primary keys of the organizations
Throws:
SystemException - if a system exception occurred

addOrganizations

void addOrganizations(long pk,
                      List<Organization> organizations)
                      throws SystemException
Adds an association between the user and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
organizations - the organizations
Throws:
SystemException - if a system exception occurred

clearOrganizations

void clearOrganizations(long pk)
                        throws SystemException
Clears all associations between the user and its organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to clear the associated organizations from
Throws:
SystemException - if a system exception occurred

removeOrganization

void removeOrganization(long pk,
                        long organizationPK)
                        throws SystemException
Removes the association between the user and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
organizationPK - the primary key of the organization
Throws:
SystemException - if a system exception occurred

removeOrganization

void removeOrganization(long pk,
                        Organization organization)
                        throws SystemException
Removes the association between the user and the organization. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
organization - the organization
Throws:
SystemException - if a system exception occurred

removeOrganizations

void removeOrganizations(long pk,
                         long[] organizationPKs)
                         throws SystemException
Removes the association between the user and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
organizationPKs - the primary keys of the organizations
Throws:
SystemException - if a system exception occurred

removeOrganizations

void removeOrganizations(long pk,
                         List<Organization> organizations)
                         throws SystemException
Removes the association between the user and the organizations. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
organizations - the organizations
Throws:
SystemException - if a system exception occurred

setOrganizations

void setOrganizations(long pk,
                      long[] organizationPKs)
                      throws SystemException
Sets the organizations associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
organizationPKs - the primary keys of the organizations to be associated with the user
Throws:
SystemException - if a system exception occurred

setOrganizations

void setOrganizations(long pk,
                      List<Organization> organizations)
                      throws SystemException
Sets the organizations associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
organizations - the organizations to be associated with the user
Throws:
SystemException - if a system exception occurred

getPermissions

List<Permission> getPermissions(long pk)
                                throws SystemException
Gets all the permissions associated with the user.

Parameters:
pk - the primary key of the user to get the associated permissions for
Returns:
the permissions associated with the user
Throws:
SystemException - if a system exception occurred

getPermissions

List<Permission> getPermissions(long pk,
                                int start,
                                int end)
                                throws SystemException
Gets a range of all the permissions associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated permissions for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
Returns:
the range of permissions associated with the user
Throws:
SystemException - if a system exception occurred

getPermissions

List<Permission> getPermissions(long pk,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                                throws SystemException
Gets an ordered range of all the permissions associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated permissions for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of permissions associated with the user
Throws:
SystemException - if a system exception occurred

getPermissionsSize

int getPermissionsSize(long pk)
                       throws SystemException
Gets the number of permissions associated with the user.

Parameters:
pk - the primary key of the user to get the number of associated permissions for
Returns:
the number of permissions associated with the user
Throws:
SystemException - if a system exception occurred

containsPermission

boolean containsPermission(long pk,
                           long permissionPK)
                           throws SystemException
Determines whether the permission is associated with the user.

Parameters:
pk - the primary key of the user
permissionPK - the primary key of the permission
Returns:
whether the permission is associated with the user
Throws:
SystemException - if a system exception occurred

containsPermissions

boolean containsPermissions(long pk)
                            throws SystemException
Determines whether the user has any permissions associated with it.

Parameters:
pk - the primary key of the user to check for associations with permissions
Returns:
whether the user has any permissions associated with it
Throws:
SystemException - if a system exception occurred

addPermission

void addPermission(long pk,
                   long permissionPK)
                   throws SystemException
Adds an association between the user and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
permissionPK - the primary key of the permission
Throws:
SystemException - if a system exception occurred

addPermission

void addPermission(long pk,
                   Permission permission)
                   throws SystemException
Adds an association between the user and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
permission - the permission
Throws:
SystemException - if a system exception occurred

addPermissions

void addPermissions(long pk,
                    long[] permissionPKs)
                    throws SystemException
Adds an association between the user and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
permissionPKs - the primary keys of the permissions
Throws:
SystemException - if a system exception occurred

addPermissions

void addPermissions(long pk,
                    List<Permission> permissions)
                    throws SystemException
Adds an association between the user and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
permissions - the permissions
Throws:
SystemException - if a system exception occurred

clearPermissions

void clearPermissions(long pk)
                      throws SystemException
Clears all associations between the user and its permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to clear the associated permissions from
Throws:
SystemException - if a system exception occurred

removePermission

void removePermission(long pk,
                      long permissionPK)
                      throws SystemException
Removes the association between the user and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
permissionPK - the primary key of the permission
Throws:
SystemException - if a system exception occurred

removePermission

void removePermission(long pk,
                      Permission permission)
                      throws SystemException
Removes the association between the user and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
permission - the permission
Throws:
SystemException - if a system exception occurred

removePermissions

void removePermissions(long pk,
                       long[] permissionPKs)
                       throws SystemException
Removes the association between the user and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
permissionPKs - the primary keys of the permissions
Throws:
SystemException - if a system exception occurred

removePermissions

void removePermissions(long pk,
                       List<Permission> permissions)
                       throws SystemException
Removes the association between the user and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
permissions - the permissions
Throws:
SystemException - if a system exception occurred

setPermissions

void setPermissions(long pk,
                    long[] permissionPKs)
                    throws SystemException
Sets the permissions associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
permissionPKs - the primary keys of the permissions to be associated with the user
Throws:
SystemException - if a system exception occurred

setPermissions

void setPermissions(long pk,
                    List<Permission> permissions)
                    throws SystemException
Sets the permissions associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
permissions - the permissions to be associated with the user
Throws:
SystemException - if a system exception occurred

getRoles

List<Role> getRoles(long pk)
                    throws SystemException
Gets all the roles associated with the user.

Parameters:
pk - the primary key of the user to get the associated roles for
Returns:
the roles associated with the user
Throws:
SystemException - if a system exception occurred

getRoles

List<Role> getRoles(long pk,
                    int start,
                    int end)
                    throws SystemException
Gets a range of all the roles associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated roles for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
Returns:
the range of roles associated with the user
Throws:
SystemException - if a system exception occurred

getRoles

List<Role> getRoles(long pk,
                    int start,
                    int end,
                    OrderByComparator orderByComparator)
                    throws SystemException
Gets an ordered range of all the roles associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated roles for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of roles associated with the user
Throws:
SystemException - if a system exception occurred

getRolesSize

int getRolesSize(long pk)
                 throws SystemException
Gets the number of roles associated with the user.

Parameters:
pk - the primary key of the user to get the number of associated roles for
Returns:
the number of roles associated with the user
Throws:
SystemException - if a system exception occurred

containsRole

boolean containsRole(long pk,
                     long rolePK)
                     throws SystemException
Determines whether the role is associated with the user.

Parameters:
pk - the primary key of the user
rolePK - the primary key of the role
Returns:
whether the role is associated with the user
Throws:
SystemException - if a system exception occurred

containsRoles

boolean containsRoles(long pk)
                      throws SystemException
Determines whether the user has any roles associated with it.

Parameters:
pk - the primary key of the user to check for associations with roles
Returns:
whether the user has any roles associated with it
Throws:
SystemException - if a system exception occurred

addRole

void addRole(long pk,
             long rolePK)
             throws SystemException
Adds an association between the user and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
rolePK - the primary key of the role
Throws:
SystemException - if a system exception occurred

addRole

void addRole(long pk,
             Role role)
             throws SystemException
Adds an association between the user and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
role - the role
Throws:
SystemException - if a system exception occurred

addRoles

void addRoles(long pk,
              long[] rolePKs)
              throws SystemException
Adds an association between the user and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
rolePKs - the primary keys of the roles
Throws:
SystemException - if a system exception occurred

addRoles

void addRoles(long pk,
              List<Role> roles)
              throws SystemException
Adds an association between the user and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
roles - the roles
Throws:
SystemException - if a system exception occurred

clearRoles

void clearRoles(long pk)
                throws SystemException
Clears all associations between the user and its roles. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to clear the associated roles from
Throws:
SystemException - if a system exception occurred

removeRole

void removeRole(long pk,
                long rolePK)
                throws SystemException
Removes the association between the user and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
rolePK - the primary key of the role
Throws:
SystemException - if a system exception occurred

removeRole

void removeRole(long pk,
                Role role)
                throws SystemException
Removes the association between the user and the role. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
role - the role
Throws:
SystemException - if a system exception occurred

removeRoles

void removeRoles(long pk,
                 long[] rolePKs)
                 throws SystemException
Removes the association between the user and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
rolePKs - the primary keys of the roles
Throws:
SystemException - if a system exception occurred

removeRoles

void removeRoles(long pk,
                 List<Role> roles)
                 throws SystemException
Removes the association between the user and the roles. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
roles - the roles
Throws:
SystemException - if a system exception occurred

setRoles

void setRoles(long pk,
              long[] rolePKs)
              throws SystemException
Sets the roles associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
rolePKs - the primary keys of the roles to be associated with the user
Throws:
SystemException - if a system exception occurred

setRoles

void setRoles(long pk,
              List<Role> roles)
              throws SystemException
Sets the roles associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
roles - the roles to be associated with the user
Throws:
SystemException - if a system exception occurred

getTeams

List<Team> getTeams(long pk)
                    throws SystemException
Gets all the teams associated with the user.

Parameters:
pk - the primary key of the user to get the associated teams for
Returns:
the teams associated with the user
Throws:
SystemException - if a system exception occurred

getTeams

List<Team> getTeams(long pk,
                    int start,
                    int end)
                    throws SystemException
Gets a range of all the teams associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated teams for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
Returns:
the range of teams associated with the user
Throws:
SystemException - if a system exception occurred

getTeams

List<Team> getTeams(long pk,
                    int start,
                    int end,
                    OrderByComparator orderByComparator)
                    throws SystemException
Gets an ordered range of all the teams associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated teams for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of teams associated with the user
Throws:
SystemException - if a system exception occurred

getTeamsSize

int getTeamsSize(long pk)
                 throws SystemException
Gets the number of teams associated with the user.

Parameters:
pk - the primary key of the user to get the number of associated teams for
Returns:
the number of teams associated with the user
Throws:
SystemException - if a system exception occurred

containsTeam

boolean containsTeam(long pk,
                     long teamPK)
                     throws SystemException
Determines whether the team is associated with the user.

Parameters:
pk - the primary key of the user
teamPK - the primary key of the team
Returns:
whether the team is associated with the user
Throws:
SystemException - if a system exception occurred

containsTeams

boolean containsTeams(long pk)
                      throws SystemException
Determines whether the user has any teams associated with it.

Parameters:
pk - the primary key of the user to check for associations with teams
Returns:
whether the user has any teams associated with it
Throws:
SystemException - if a system exception occurred

addTeam

void addTeam(long pk,
             long teamPK)
             throws SystemException
Adds an association between the user and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
teamPK - the primary key of the team
Throws:
SystemException - if a system exception occurred

addTeam

void addTeam(long pk,
             Team team)
             throws SystemException
Adds an association between the user and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
team - the team
Throws:
SystemException - if a system exception occurred

addTeams

void addTeams(long pk,
              long[] teamPKs)
              throws SystemException
Adds an association between the user and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
teamPKs - the primary keys of the teams
Throws:
SystemException - if a system exception occurred

addTeams

void addTeams(long pk,
              List<Team> teams)
              throws SystemException
Adds an association between the user and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
teams - the teams
Throws:
SystemException - if a system exception occurred

clearTeams

void clearTeams(long pk)
                throws SystemException
Clears all associations between the user and its teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to clear the associated teams from
Throws:
SystemException - if a system exception occurred

removeTeam

void removeTeam(long pk,
                long teamPK)
                throws SystemException
Removes the association between the user and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
teamPK - the primary key of the team
Throws:
SystemException - if a system exception occurred

removeTeam

void removeTeam(long pk,
                Team team)
                throws SystemException
Removes the association between the user and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
team - the team
Throws:
SystemException - if a system exception occurred

removeTeams

void removeTeams(long pk,
                 long[] teamPKs)
                 throws SystemException
Removes the association between the user and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
teamPKs - the primary keys of the teams
Throws:
SystemException - if a system exception occurred

removeTeams

void removeTeams(long pk,
                 List<Team> teams)
                 throws SystemException
Removes the association between the user and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
teams - the teams
Throws:
SystemException - if a system exception occurred

setTeams

void setTeams(long pk,
              long[] teamPKs)
              throws SystemException
Sets the teams associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
teamPKs - the primary keys of the teams to be associated with the user
Throws:
SystemException - if a system exception occurred

setTeams

void setTeams(long pk,
              List<Team> teams)
              throws SystemException
Sets the teams associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
teams - the teams to be associated with the user
Throws:
SystemException - if a system exception occurred

getUserGroups

List<UserGroup> getUserGroups(long pk)
                              throws SystemException
Gets all the user groups associated with the user.

Parameters:
pk - the primary key of the user to get the associated user groups for
Returns:
the user groups associated with the user
Throws:
SystemException - if a system exception occurred

getUserGroups

List<UserGroup> getUserGroups(long pk,
                              int start,
                              int end)
                              throws SystemException
Gets a range of all the user groups associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated user groups for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
Returns:
the range of user groups associated with the user
Throws:
SystemException - if a system exception occurred

getUserGroups

List<UserGroup> getUserGroups(long pk,
                              int start,
                              int end,
                              OrderByComparator orderByComparator)
                              throws SystemException
Gets an ordered range of all the user groups associated with the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
pk - the primary key of the user to get the associated user groups for
start - the lower bound of the range of users to return
end - the upper bound of the range of users to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of user groups associated with the user
Throws:
SystemException - if a system exception occurred

getUserGroupsSize

int getUserGroupsSize(long pk)
                      throws SystemException
Gets the number of user groups associated with the user.

Parameters:
pk - the primary key of the user to get the number of associated user groups for
Returns:
the number of user groups associated with the user
Throws:
SystemException - if a system exception occurred

containsUserGroup

boolean containsUserGroup(long pk,
                          long userGroupPK)
                          throws SystemException
Determines whether the user group is associated with the user.

Parameters:
pk - the primary key of the user
userGroupPK - the primary key of the user group
Returns:
whether the user group is associated with the user
Throws:
SystemException - if a system exception occurred

containsUserGroups

boolean containsUserGroups(long pk)
                           throws SystemException
Determines whether the user has any user groups associated with it.

Parameters:
pk - the primary key of the user to check for associations with user groups
Returns:
whether the user has any user groups associated with it
Throws:
SystemException - if a system exception occurred

addUserGroup

void addUserGroup(long pk,
                  long userGroupPK)
                  throws SystemException
Adds an association between the user and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
userGroupPK - the primary key of the user group
Throws:
SystemException - if a system exception occurred

addUserGroup

void addUserGroup(long pk,
                  UserGroup userGroup)
                  throws SystemException
Adds an association between the user and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
userGroup - the user group
Throws:
SystemException - if a system exception occurred

addUserGroups

void addUserGroups(long pk,
                   long[] userGroupPKs)
                   throws SystemException
Adds an association between the user and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
userGroupPKs - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

addUserGroups

void addUserGroups(long pk,
                   List<UserGroup> userGroups)
                   throws SystemException
Adds an association between the user and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
userGroups - the user groups
Throws:
SystemException - if a system exception occurred

clearUserGroups

void clearUserGroups(long pk)
                     throws SystemException
Clears all associations between the user and its user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to clear the associated user groups from
Throws:
SystemException - if a system exception occurred

removeUserGroup

void removeUserGroup(long pk,
                     long userGroupPK)
                     throws SystemException
Removes the association between the user and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
userGroupPK - the primary key of the user group
Throws:
SystemException - if a system exception occurred

removeUserGroup

void removeUserGroup(long pk,
                     UserGroup userGroup)
                     throws SystemException
Removes the association between the user and the user group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
userGroup - the user group
Throws:
SystemException - if a system exception occurred

removeUserGroups

void removeUserGroups(long pk,
                      long[] userGroupPKs)
                      throws SystemException
Removes the association between the user and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
userGroupPKs - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

removeUserGroups

void removeUserGroups(long pk,
                      List<UserGroup> userGroups)
                      throws SystemException
Removes the association between the user and the user groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user
userGroups - the user groups
Throws:
SystemException - if a system exception occurred

setUserGroups

void setUserGroups(long pk,
                   long[] userGroupPKs)
                   throws SystemException
Sets the user groups associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
userGroupPKs - the primary keys of the user groups to be associated with the user
Throws:
SystemException - if a system exception occurred

setUserGroups

void setUserGroups(long pk,
                   List<UserGroup> userGroups)
                   throws SystemException
Sets the user groups associated with the user, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user to set the associations for
userGroups - the user groups to be associated with the user
Throws:
SystemException - if a system exception occurred

Liferay 6.0-ee