Liferay 6.0.5

com.liferay.portal.service
Interface TeamLocalService

All Known Implementing Classes:
TeamLocalServiceBaseImpl, TeamLocalServiceImpl, TeamLocalServiceWrapper

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

The interface for the team local service.

Never modify or reference this interface directly. Always use TeamLocalServiceUtil to access the team local service. Add custom service methods to TeamLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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.

See Also:
TeamLocalServiceUtil, TeamLocalServiceBaseImpl, TeamLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 Team addTeam(long userId, long groupId, String name, String description)
           
 Team addTeam(Team team)
          Adds the team to the database.
 Team createTeam(long teamId)
          Creates a new team with the primary key.
 void deleteTeam(long teamId)
          Deletes the team with the primary key from the database.
 void deleteTeam(Team team)
          Deletes the team from the database.
 void deleteTeams(long groupId)
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
 List<Team> getGroupTeams(long groupId)
           
 Team getTeam(long teamId)
          Gets the team with the primary key.
 List<Team> getTeams(int start, int end)
          Gets a range of all the teams.
 int getTeamsCount()
          Gets the number of teams.
 List<Team> getUserTeams(long userId)
           
 List<Team> getUserTeams(long userId, long groupId)
           
 boolean hasUserTeam(long userId, long teamId)
           
 List<Team> search(long groupId, String name, String description, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)
           
 int searchCount(long groupId, String name, String description, LinkedHashMap<String,Object> params)
           
 Team updateTeam(long teamId, String name, String description)
           
 Team updateTeam(Team team)
          Updates the team in the database.
 Team updateTeam(Team team, boolean merge)
          Updates the team in the database.
 

Method Detail

addTeam

Team addTeam(Team team)
             throws SystemException
Adds the team to the database. Also notifies the appropriate model listeners.

Parameters:
team - the team to add
Returns:
the team that was added
Throws:
SystemException - if a system exception occurred

createTeam

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

deleteTeam

void deleteTeam(long teamId)
                throws PortalException,
                       SystemException
Deletes the team with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
teamId - the primary key of the team to delete
Throws:
PortalException - if a team with the primary key could not be found
SystemException - if a system exception occurred

deleteTeam

void deleteTeam(Team team)
                throws SystemException
Deletes the team from the database. Also notifies the appropriate model listeners.

Parameters:
team - the team to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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.

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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getTeam

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Team getTeam(long teamId)
             throws PortalException,
                    SystemException
Gets the team with the primary key.

Parameters:
teamId - the primary key of the team to get
Returns:
the team
Throws:
PortalException - if a team with the primary key could not be found
SystemException - if a system exception occurred

getTeams

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Team> getTeams(int start,
                                                             int end)
                    throws SystemException
Gets 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

getTeamsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTeamsCount()
                  throws SystemException
Gets the number of teams.

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

updateTeam

Team updateTeam(Team team)
                throws SystemException
Updates the team in the database. Also notifies the appropriate model listeners.

Parameters:
team - the team to update
Returns:
the team that was updated
Throws:
SystemException - if a system exception occurred

updateTeam

Team updateTeam(Team team,
                boolean merge)
                throws SystemException
Updates the team in the database. Also notifies the appropriate model listeners.

Parameters:
team - the team to update
merge - whether to merge the team with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the team that was updated
Throws:
SystemException - if a system exception occurred

addTeam

Team addTeam(long userId,
             long groupId,
             String name,
             String description)
             throws PortalException,
                    SystemException
Throws:
PortalException
SystemException

deleteTeams

void deleteTeams(long groupId)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

getGroupTeams

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

getUserTeams

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

getUserTeams

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

hasUserTeam

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserTeam(long userId,
                                                             long teamId)
                    throws SystemException
Throws:
SystemException

search

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

searchCount

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

updateTeam

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

Liferay 6.0.5