com.liferay.portal.kernel.service

Interface TeamLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

TeamLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface TeamLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for Team. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

TeamLocalServiceUtil, TeamLocalServiceBaseImpl, TeamLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Team	addTeam(long userId, long groupId, String name, String description) Deprecated. As of Wilberforce (7.0.x), replaced by addTeam(long, long, String, String, ServiceContext)
Team	addTeam(long userId, long groupId, String name, String description, ServiceContext serviceContext)
Team	addTeam(Team team) Adds the team to the database.
void	addUserGroupTeam(long userGroupId, long teamId)
void	addUserGroupTeam(long userGroupId, Team team)
void	addUserGroupTeams(long userGroupId, List<Team> teams)
void	addUserGroupTeams(long userGroupId, long[] teamIds)
void	addUserTeam(long userId, long teamId)
void	addUserTeam(long userId, Team team)
void	addUserTeams(long userId, List<Team> teams)
void	addUserTeams(long userId, long[] teamIds)
void	clearUserGroupTeams(long userGroupId)
void	clearUserTeams(long userId)
Team	createTeam(long teamId) Creates a new team with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
Team	deleteTeam(long teamId) Deletes the team with the primary key from the database.
Team	deleteTeam(Team team) Deletes the team from the database.
void	deleteTeams(long groupId)
void	deleteUserGroupTeam(long userGroupId, long teamId)
void	deleteUserGroupTeam(long userGroupId, Team team)
void	deleteUserGroupTeams(long userGroupId, List<Team> teams)
void	deleteUserGroupTeams(long userGroupId, long[] teamIds)
void	deleteUserTeam(long userId, long teamId)
void	deleteUserTeam(long userId, Team team)
void	deleteUserTeams(long userId, List<Team> teams)
void	deleteUserTeams(long userId, long[] teamIds)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
Team	fetchTeam(long teamId)
Team	fetchTeam(long groupId, String name)
Team	fetchTeamByUuidAndGroupId(String uuid, long groupId) Returns the team matching the UUID and group.
ActionableDynamicQuery	getActionableDynamicQuery()
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
List<Team>	getGroupTeams(long groupId)
int	getGroupTeamsCount(long groupId)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
Team	getTeam(long teamId) Returns the team with the primary key.
Team	getTeam(long groupId, String name)
Team	getTeamByUuidAndGroupId(String uuid, long groupId) Returns the team matching the UUID and group.
List<Team>	getTeams(int start, int end) Returns a range of all the teams.
List<Team>	getTeamsByUuidAndCompanyId(String uuid, long companyId) Returns all the teams matching the UUID and company.
List<Team>	getTeamsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<Team> orderByComparator) Returns a range of teams matching the UUID and company.
int	getTeamsCount() Returns the number of teams.
long[]	getUserGroupPrimaryKeys(long teamId) Returns the userGroupIds of the user groups associated with the team.
List<Team>	getUserGroupTeams(long userGroupId)
List<Team>	getUserGroupTeams(long userGroupId, int start, int end)
List<Team>	getUserGroupTeams(long userGroupId, int start, int end, OrderByComparator<Team> orderByComparator)
int	getUserGroupTeamsCount(long userGroupId)
List<Team>	getUserOrUserGroupTeams(long groupId, long userId)
long[]	getUserPrimaryKeys(long teamId) Returns the userIds of the users associated with the team.
List<Team>	getUserTeams(long userId)
List<Team>	getUserTeams(long userId, int start, int end)
List<Team>	getUserTeams(long userId, int start, int end, OrderByComparator<Team> orderByComparator)
List<Team>	getUserTeams(long userId, long groupId)
int	getUserTeamsCount(long userId)
boolean	hasUserGroupTeam(long userGroupId, long teamId)
boolean	hasUserGroupTeams(long userGroupId)
boolean	hasUserTeam(long userId, long teamId)
boolean	hasUserTeams(long userId)
List<Team>	search(long groupId, String name, String description, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Team> obc)
int	searchCount(long groupId, String name, String description, LinkedHashMap<String,Object> params)
void	setUserGroupTeams(long userGroupId, long[] teamIds)
void	setUserTeams(long userId, long[] teamIds)
Team	updateTeam(long teamId, String name, String description)
Team	updateTeam(Team team) Updates the team in the database or adds it if it does not yet exist.

Method Detail

addTeam

@Deprecated
Team addTeam(long userId,
                         long groupId,
                         String name,
                         String description)
                  throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by addTeam(long, long, String, String, ServiceContext)

Throws:

PortalException

addTeam

Team addTeam(long userId,
             long groupId,
             String name,
             String description,
             ServiceContext serviceContext)
      throws PortalException

Throws:

PortalException

addTeam

@Indexable(type=REINDEX)
Team addTeam(Team team)

Adds the team to the database. Also notifies the appropriate model listeners.

Parameters:

team - the team

Returns:

the team that was added

addUserGroupTeam

void addUserGroupTeam(long userGroupId,
                      long teamId)

addUserGroupTeam

void addUserGroupTeam(long userGroupId,
                      Team team)

addUserGroupTeams

void addUserGroupTeams(long userGroupId,
                       List<Team> teams)

addUserGroupTeams

void addUserGroupTeams(long userGroupId,
                       long[] teamIds)

addUserTeam

void addUserTeam(long userId,
                 long teamId)

addUserTeam

void addUserTeam(long userId,
                 Team team)

addUserTeams

void addUserTeams(long userId,
                  List<Team> teams)

addUserTeams

void addUserTeams(long userId,
                  long[] teamIds)

clearUserGroupTeams

void clearUserGroupTeams(long userGroupId)

clearUserTeams

void clearUserTeams(long userId)

createTeam

@Transactional(enabled=false)
Team createTeam(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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteTeam

@Indexable(type=DELETE)
Team deleteTeam(long teamId)
                                 throws PortalException

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

Parameters:

teamId - the primary key of the team

Returns:

the team that was removed

Throws:

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

deleteTeam

@Indexable(type=DELETE)
Team deleteTeam(Team team)
                                 throws PortalException

Deletes the team from the database. Also notifies the appropriate model listeners.

Parameters:

team - the team

Returns:

the team that was removed

Throws:

PortalException

deleteTeams

void deleteTeams(long groupId)
          throws PortalException

Throws:

PortalException

deleteUserGroupTeam

void deleteUserGroupTeam(long userGroupId,
                         long teamId)

deleteUserGroupTeam

void deleteUserGroupTeam(long userGroupId,
                         Team team)

deleteUserGroupTeams

void deleteUserGroupTeams(long userGroupId,
                          List<Team> teams)

deleteUserGroupTeams

void deleteUserGroupTeams(long userGroupId,
                          long[] teamIds)

deleteUserTeam

void deleteUserTeam(long userId,
                    long teamId)

deleteUserTeam

void deleteUserTeam(long userId,
                    Team team)

deleteUserTeams

void deleteUserTeams(long userId,
                     List<Team> teams)

deleteUserTeams

void deleteUserTeams(long userId,
                     long[] teamIds)

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)

Performs a dynamic query on the database and returns a range of the matching rows.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from TeamModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from TeamModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchTeam

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Team fetchTeam(long teamId)

fetchTeam

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Team fetchTeam(long groupId,
                                                                                  String name)

fetchTeamByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Team fetchTeamByUuidAndGroupId(String uuid,
                                                                                                  long groupId)

Returns the team matching the UUID and group.

Parameters:

uuid - the team's UUID

groupId - the primary key of the group

Returns:

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getGroupTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getGroupTeams(long groupId)

getGroupTeamsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupTeamsCount(long groupId)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getTeam

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Team getTeam(long teamId)
                                                                         throws PortalException

Returns the team with the primary key.

Parameters:

teamId - the primary key of the team

Returns:

the team

Throws:

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

getTeam

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Team getTeam(long groupId,
                                                                                String name)
                                                                         throws PortalException

Throws:

PortalException

getTeamByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Team getTeamByUuidAndGroupId(String uuid,
                                                                                                long groupId)
                                                                                         throws PortalException

Returns the team matching the UUID and group.

Parameters:

uuid - the team's UUID

groupId - the primary key of the group

Returns:

the matching team

Throws:

PortalException - if a matching team could not be found

getTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getTeams(int start,
                                                                                       int end)

Returns 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from TeamModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of teams

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

Returns:

the range of teams

getTeamsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getTeamsByUuidAndCompanyId(String uuid,
                                                                                                         long companyId)

Returns all the teams matching the UUID and company.

Parameters:

uuid - the UUID of the teams

companyId - the primary key of the company

Returns:

the matching teams, or an empty list if no matches were found

getTeamsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getTeamsByUuidAndCompanyId(String uuid,
                                                                                                         long companyId,
                                                                                                         int start,
                                                                                                         int end,
                                                                                                         OrderByComparator<Team> orderByComparator)

Returns a range of teams matching the UUID and company.

Parameters:

uuid - the UUID of the teams

companyId - the primary key of the company

start - the lower bound of the range of teams

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

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching teams, or an empty list if no matches were found

getTeamsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTeamsCount()

Returns the number of teams.

Returns:

the number of teams

getUserGroupPrimaryKeys

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getUserGroupPrimaryKeys(long teamId)

Returns the userGroupIds of the user groups associated with the team.

Parameters:

teamId - the teamId of the team

Returns:

long[] the userGroupIds of user groups associated with the team

getUserGroupTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getUserGroupTeams(long userGroupId)

getUserGroupTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getUserGroupTeams(long userGroupId,
                                                                                                int start,
                                                                                                int end)

getUserGroupTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getUserGroupTeams(long userGroupId,
                                                                                                int start,
                                                                                                int end,
                                                                                                OrderByComparator<Team> orderByComparator)

getUserGroupTeamsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupTeamsCount(long userGroupId)

getUserOrUserGroupTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getUserOrUserGroupTeams(long groupId,
                                                                                                      long userId)

getUserPrimaryKeys

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getUserPrimaryKeys(long teamId)

Returns the userIds of the users associated with the team.

Parameters:

teamId - the teamId of the team

Returns:

long[] the userIds of users associated with the team

getUserTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getUserTeams(long userId)

getUserTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getUserTeams(long userId,
                                                                                           int start,
                                                                                           int end)

getUserTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getUserTeams(long userId,
                                                                                           int start,
                                                                                           int end,
                                                                                           OrderByComparator<Team> orderByComparator)

getUserTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getUserTeams(long userId,
                                                                                           long groupId)

getUserTeamsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserTeamsCount(long userId)

hasUserGroupTeam

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroupTeam(long userGroupId,
                                                                                            long teamId)

hasUserGroupTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroupTeams(long userGroupId)

hasUserTeam

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserTeam(long userId,
                                                                                       long teamId)

hasUserTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserTeams(long userId)

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> search(long groupId,
                                                                                     String name,
                                                                                     String description,
                                                                                     LinkedHashMap<String,Object> params,
                                                                                     int start,
                                                                                     int end,
                                                                                     OrderByComparator<Team> obc)

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long groupId,
                                                                                   String name,
                                                                                   String description,
                                                                                   LinkedHashMap<String,Object> params)

setUserGroupTeams

void setUserGroupTeams(long userGroupId,
                       long[] teamIds)

setUserTeams

void setUserTeams(long userId,
                  long[] teamIds)

updateTeam

Team updateTeam(long teamId,
                String name,
                String description)
         throws PortalException

Throws:

PortalException

updateTeam

@Indexable(type=REINDEX)
Team updateTeam(Team team)

Updates the team in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

team - the team

Returns:

the team that was updated