com.liferay.portal.service.persistence
Interface TeamPersistence

All Superinterfaces:

BasePersistence<Team>

All Known Implementing Classes:

TeamPersistenceImpl

public interface TeamPersistence
extends BasePersistence<Team>

The persistence interface for the team service.

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

Caching information and settings can be found in portal.properties

See Also:

TeamPersistenceImpl, TeamUtil

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

void	addUser(long pk, long userPK) Adds an association between the team and the user.
void	addUser(long pk, User user) Adds an association between the team and the user.
void	addUsers(long pk, List<User> users) Adds an association between the team and the users.
void	addUsers(long pk, long[] userPKs) Adds an association between the team and the users.
void	cacheResult(List<Team> teams) Caches the teams in the entity cache if it is enabled.
void	cacheResult(Team team) Caches the team in the entity cache if it is enabled.
void	clearUsers(long pk) Clears all associations between the team and its users.
boolean	containsUser(long pk, long userPK) Determines whether the user is associated with the team.
boolean	containsUsers(long pk) Determines whether the team has any users associated with it.
int	countAll() Counts all the teams.
int	countByG_N(long groupId, String name) Counts all the teams where groupId = ? and name = ?.
int	countByGroupId(long groupId) Counts all the teams where groupId = ?.
Team	create(long teamId) Creates a new team with the primary key.
Team	fetchByG_N(long groupId, String name) Finds the team where groupId = ? and name = ? or returns null if it could not be found.
Team	fetchByG_N(long groupId, String name, boolean retrieveFromCache) Finds the team where groupId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
Team	fetchByPrimaryKey(long teamId) Finds the team with the primary key or returns null if it could not be found.
int	filterCountByG_N(long groupId, String name) Filters by the user's permissions and counts all the teams where groupId = ? and name = ?.
int	filterCountByGroupId(long groupId) Filters by the user's permissions and counts all the teams where groupId = ?.
List<Team>	filterFindByGroupId(long groupId) Filters by the user's permissions and finds all the teams where groupId = ?.
List<Team>	filterFindByGroupId(long groupId, int start, int end) Filters by the user's permissions and finds a range of all the teams where groupId = ?.
List<Team>	filterFindByGroupId(long groupId, int start, int end, OrderByComparator orderByComparator) Filters by the user's permissions and finds an ordered range of all the teams where groupId = ?.
List<Team>	findAll() Finds all the teams.
List<Team>	findAll(int start, int end) Finds a range of all the teams.
List<Team>	findAll(int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the teams.
Team	findByG_N(long groupId, String name) Finds the team where groupId = ? and name = ? or throws a NoSuchTeamException if it could not be found.
Team	findByGroupId_First(long groupId, OrderByComparator orderByComparator) Finds the first team in the ordered set where groupId = ?.
Team	findByGroupId_Last(long groupId, OrderByComparator orderByComparator) Finds the last team in the ordered set where groupId = ?.
Team[]	findByGroupId_PrevAndNext(long teamId, long groupId, OrderByComparator orderByComparator) Finds the teams before and after the current team in the ordered set where groupId = ?.
List<Team>	findByGroupId(long groupId) Finds all the teams where groupId = ?.
List<Team>	findByGroupId(long groupId, int start, int end) Finds a range of all the teams where groupId = ?.
List<Team>	findByGroupId(long groupId, int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the teams where groupId = ?.
Team	findByPrimaryKey(long teamId) Finds the team with the primary key or throws a NoSuchTeamException if it could not be found.
List<User>	getUsers(long pk) Gets all the users associated with the team.
List<User>	getUsers(long pk, int start, int end) Gets a range of all the users associated with the team.
List<User>	getUsers(long pk, int start, int end, OrderByComparator orderByComparator) Gets an ordered range of all the users associated with the team.
int	getUsersSize(long pk) Gets the number of users associated with the team.
Team	remove(long teamId) Removes the team with the primary key from the database.
void	removeAll() Removes all the teams from the database.
void	removeByG_N(long groupId, String name) Removes the team where groupId = ? and name = ? from the database.
void	removeByGroupId(long groupId) Removes all the teams where groupId = ? from the database.
void	removeUser(long pk, long userPK) Removes the association between the team and the user.
void	removeUser(long pk, User user) Removes the association between the team and the user.
void	removeUsers(long pk, List<User> users) Removes the association between the team and the users.
void	removeUsers(long pk, long[] userPKs) Removes the association between the team and the users.
void	setUsers(long pk, List<User> users) Sets the users associated with the team, removing and adding associations as necessary.
void	setUsers(long pk, long[] userPKs) Sets the users associated with the team, removing and adding associations as necessary.
Team	updateImpl(Team team, 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(Team team)

Caches the team in the entity cache if it is enabled.

Parameters:

team - the team to cache

cacheResult

void cacheResult(List<Team> teams)

Caches the teams in the entity cache if it is enabled.

Parameters:

teams - the teams to cache

create

Team create(long teamId)

Creates a new team with the primary key. Does not add the team to the database.

Parameters:

teamId - the primary key for the new team

Returns:

the new team

remove

Team remove(long teamId)
            throws NoSuchTeamException,
                   SystemException

Removes the team with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

teamId - the primary key of the team to remove

Returns:

the team that was removed

Throws:

NoSuchTeamException - if a team with the primary key could not be found

SystemException - if a system exception occurred

updateImpl

Team updateImpl(Team team,
                boolean merge)
                throws SystemException

Throws:

SystemException

findByPrimaryKey

Team findByPrimaryKey(long teamId)
                      throws NoSuchTeamException,
                             SystemException

Finds the team with the primary key or throws a NoSuchTeamException if it could not be found.

Parameters:

teamId - the primary key of the team to find

Returns:

the team

Throws:

NoSuchTeamException - if a team with the primary key could not be found

SystemException - if a system exception occurred

fetchByPrimaryKey

Team fetchByPrimaryKey(long teamId)
                       throws SystemException

Finds the team with the primary key or returns null if it could not be found.

Parameters:

teamId - the primary key of the team to find

Returns:

the team, or null if a team with the primary key could not be found

Throws:

SystemException - if a system exception occurred

findByGroupId

List<Team> findByGroupId(long groupId)
                         throws SystemException

Finds all the teams where groupId = ?.

Parameters:

groupId - the group id to search with

Returns:

the matching teams

Throws:

SystemException - if a system exception occurred

findByGroupId

List<Team> findByGroupId(long groupId,
                         int start,
                         int end)
                         throws SystemException

Finds a range of all the teams where groupId = ?.

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:

groupId - the group id to search with

start - the lower bound of the range of teams to return

end - the upper bound of the range of teams to return (not inclusive)

Returns:

the range of matching teams

Throws:

SystemException - if a system exception occurred

findByGroupId

List<Team> findByGroupId(long groupId,
                         int start,
                         int end,
                         OrderByComparator orderByComparator)
                         throws SystemException

Finds an ordered range of all the teams where groupId = ?.

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:

groupId - the group id to search with

start - the lower bound of the range of teams to return

end - the upper bound of the range of teams to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching teams

Throws:

SystemException - if a system exception occurred

findByGroupId_First

Team findByGroupId_First(long groupId,
                         OrderByComparator orderByComparator)
                         throws NoSuchTeamException,
                                SystemException

Finds the first team in the ordered set where groupId = ?.

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:

groupId - the group id to search with

orderByComparator - the comparator to order the set by

Returns:

the first matching team

Throws:

NoSuchTeamException - if a matching team could not be found

SystemException - if a system exception occurred

findByGroupId_Last

Team findByGroupId_Last(long groupId,
                        OrderByComparator orderByComparator)
                        throws NoSuchTeamException,
                               SystemException

Finds the last team in the ordered set where groupId = ?.

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:

groupId - the group id to search with

orderByComparator - the comparator to order the set by

Returns:

the last matching team

Throws:

NoSuchTeamException - if a matching team could not be found

SystemException - if a system exception occurred

findByGroupId_PrevAndNext

Team[] findByGroupId_PrevAndNext(long teamId,
                                 long groupId,
                                 OrderByComparator orderByComparator)
                                 throws NoSuchTeamException,
                                        SystemException

Finds the teams before and after the current team in the ordered set where groupId = ?.

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:

teamId - the primary key of the current team

groupId - the group id to search with

orderByComparator - the comparator to order the set by

Returns:

the previous, current, and next team

Throws:

NoSuchTeamException - if a team with the primary key could not be found

SystemException - if a system exception occurred

filterFindByGroupId

List<Team> filterFindByGroupId(long groupId)
                               throws SystemException

Filters by the user's permissions and finds all the teams where groupId = ?.

Parameters:

groupId - the group id to search with

Returns:

the matching teams that the user has permission to view

Throws:

SystemException - if a system exception occurred

filterFindByGroupId

List<Team> filterFindByGroupId(long groupId,
                               int start,
                               int end)
                               throws SystemException

Filters by the user's permissions and finds a range of all the teams where groupId = ?.

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:

groupId - the group id to search with

start - the lower bound of the range of teams to return

end - the upper bound of the range of teams to return (not inclusive)

Returns:

the range of matching teams that the user has permission to view

Throws:

SystemException - if a system exception occurred

filterFindByGroupId

List<Team> filterFindByGroupId(long groupId,
                               int start,
                               int end,
                               OrderByComparator orderByComparator)
                               throws SystemException

Filters by the user's permissions and finds an ordered range of all the teams where groupId = ?.

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:

groupId - the group id to search with

start - the lower bound of the range of teams to return

end - the upper bound of the range of teams to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching teams that the user has permission to view

Throws:

SystemException - if a system exception occurred

findByG_N

Team findByG_N(long groupId,
               String name)
               throws NoSuchTeamException,
                      SystemException

Finds the team where groupId = ? and name = ? or throws a NoSuchTeamException if it could not be found.

Parameters:

groupId - the group id to search with

name - the name to search with

Returns:

the matching team

Throws:

NoSuchTeamException - if a matching team could not be found

SystemException - if a system exception occurred

fetchByG_N

Team fetchByG_N(long groupId,
                String name)
                throws SystemException

Finds the team where groupId = ? and name = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

groupId - the group id to search with

name - the name to search with

Returns:

the matching team, or null if a matching team could not be found

Throws:

SystemException - if a system exception occurred

fetchByG_N

Team fetchByG_N(long groupId,
                String name,
                boolean retrieveFromCache)
                throws SystemException

Finds the team where groupId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:

groupId - the group id to search with

name - the name to search with

Returns:

the matching team, or null if a matching team could not be found

Throws:

SystemException - if a system exception occurred

findAll

List<Team> findAll()
                   throws SystemException

Finds all the teams.

Returns:

the teams

Throws:

SystemException - if a system exception occurred

findAll

List<Team> findAll(int start,
                   int end)
                   throws SystemException

Finds a range of all the teams.

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 teams to return

end - the upper bound of the range of teams to return (not inclusive)

Returns:

the range of teams

Throws:

SystemException - if a system exception occurred

findAll

List<Team> findAll(int start,
                   int end,
                   OrderByComparator orderByComparator)
                   throws SystemException

Finds an ordered range of all the teams.

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 teams to return

end - the upper bound of the range of teams to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of teams

Throws:

SystemException - if a system exception occurred

removeByGroupId

void removeByGroupId(long groupId)
                     throws SystemException

Removes all the teams where groupId = ? from the database.

Parameters:

groupId - the group id to search with

Throws:

SystemException - if a system exception occurred

removeByG_N

void removeByG_N(long groupId,
                 String name)
                 throws NoSuchTeamException,
                        SystemException

Removes the team where groupId = ? and name = ? from the database.

Parameters:

groupId - the group id to search with

name - the name to search with

Throws:

SystemException - if a system exception occurred

NoSuchTeamException

removeAll

void removeAll()
               throws SystemException

Removes all the teams from the database.

Throws:

SystemException - if a system exception occurred

countByGroupId

int countByGroupId(long groupId)
                   throws SystemException

Counts all the teams where groupId = ?.

Parameters:

groupId - the group id to search with

Returns:

the number of matching teams

Throws:

SystemException - if a system exception occurred

filterCountByGroupId

int filterCountByGroupId(long groupId)
                         throws SystemException

Filters by the user's permissions and counts all the teams where groupId = ?.

Parameters:

groupId - the group id to search with

Returns:

the number of matching teams that the user has permission to view

Throws:

SystemException - if a system exception occurred

countByG_N

int countByG_N(long groupId,
               String name)
               throws SystemException

Counts all the teams where groupId = ? and name = ?.

Parameters:

groupId - the group id to search with

name - the name to search with

Returns:

the number of matching teams

Throws:

SystemException - if a system exception occurred

filterCountByG_N

int filterCountByG_N(long groupId,
                     String name)
                     throws SystemException

Filters by the user's permissions and counts all the teams where groupId = ? and name = ?.

Parameters:

groupId - the group id to search with

name - the name to search with

Returns:

the number of matching teams that the user has permission to view

Throws:

SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException

Counts all the teams.

Returns:

the number of teams

Throws:

SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk)
                    throws SystemException

Gets all the users associated with the team.

Parameters:

pk - the primary key of the team to get the associated users for

Returns:

the users associated with the team

Throws:

SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk,
                    int start,
                    int end)
                    throws SystemException

Gets a range of all the users associated with the team.

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 team to get the associated users for

start - the lower bound of the range of teams to return

end - the upper bound of the range of teams to return (not inclusive)

Returns:

the range of users associated with the team

Throws:

SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk,
                    int start,
                    int end,
                    OrderByComparator orderByComparator)
                    throws SystemException

Gets an ordered range of all the users associated with the team.

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 team to get the associated users for

start - the lower bound of the range of teams to return

end - the upper bound of the range of teams to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of users associated with the team

Throws:

SystemException - if a system exception occurred

getUsersSize

int getUsersSize(long pk)
                 throws SystemException

Gets the number of users associated with the team.

Parameters:

pk - the primary key of the team to get the number of associated users for

Returns:

the number of users associated with the team

Throws:

SystemException - if a system exception occurred

containsUser

boolean containsUser(long pk,
                     long userPK)
                     throws SystemException

Determines whether the user is associated with the team.

Parameters:

pk - the primary key of the team

userPK - the primary key of the user

Returns:

whether the user is associated with the team

Throws:

SystemException - if a system exception occurred

containsUsers

boolean containsUsers(long pk)
                      throws SystemException

Determines whether the team has any users associated with it.

Parameters:

pk - the primary key of the team to check for associations with users

Returns:

whether the team has any users associated with it

Throws:

SystemException - if a system exception occurred

addUser

void addUser(long pk,
             long userPK)
             throws SystemException

Adds an association between the team and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the team

userPK - the primary key of the user

Throws:

SystemException - if a system exception occurred

addUser

void addUser(long pk,
             User user)
             throws SystemException

Adds an association between the team and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the team

user - the user

Throws:

SystemException - if a system exception occurred

addUsers

void addUsers(long pk,
              long[] userPKs)
              throws SystemException

Adds an association between the team and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the team

userPKs - the primary keys of the users

Throws:

SystemException - if a system exception occurred

addUsers

void addUsers(long pk,
              List<User> users)
              throws SystemException

Adds an association between the team and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the team

users - the users

Throws:

SystemException - if a system exception occurred

clearUsers

void clearUsers(long pk)
                throws SystemException

Clears all associations between the team and its users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the team to clear the associated users from

Throws:

SystemException - if a system exception occurred

removeUser

void removeUser(long pk,
                long userPK)
                throws SystemException

Removes the association between the team and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the team

userPK - the primary key of the user

Throws:

SystemException - if a system exception occurred

removeUser

void removeUser(long pk,
                User user)
                throws SystemException

Removes the association between the team and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the team

user - the user

Throws:

SystemException - if a system exception occurred

removeUsers

void removeUsers(long pk,
                 long[] userPKs)
                 throws SystemException

Removes the association between the team and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the team

userPKs - the primary keys of the users

Throws:

SystemException - if a system exception occurred

removeUsers

void removeUsers(long pk,
                 List<User> users)
                 throws SystemException

Removes the association between the team and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the team

users - the users

Throws:

SystemException - if a system exception occurred

setUsers

void setUsers(long pk,
              long[] userPKs)
              throws SystemException

Sets the users associated with the team, 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 team to set the associations for

userPKs - the primary keys of the users to be associated with the team

Throws:

SystemException - if a system exception occurred

setUsers

void setUsers(long pk,
              List<User> users)
              throws SystemException

Sets the users associated with the team, 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 team to set the associations for

users - the users to be associated with the team

Throws:

SystemException - if a system exception occurred