com.liferay.portal.service.TeamLocalService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
/**
* 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 TeamLocalServiceUtil
* @see com.liferay.portal.service.base.TeamLocalServiceBaseImpl
* @see com.liferay.portal.service.impl.TeamLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface TeamLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link TeamLocalServiceUtil} to access the team local service. Add custom service methods to {@link com.liferay.portal.service.impl.TeamLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the team to the database. Also notifies the appropriate model listeners.
*
* @param team the team
* @return the team that was added
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
public com.liferay.portal.model.Team addTeam(
com.liferay.portal.model.Team team)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Creates a new team with the primary key. Does not add the team to the database.
*
* @param teamId the primary key for the new team
* @return the new team
*/
public com.liferay.portal.model.Team createTeam(long teamId);
/**
* Deletes the team with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param teamId the primary key of the team
* @return the team that was removed
* @throws PortalException if a team with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
public com.liferay.portal.model.Team deleteTeam(long teamId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Deletes the team from the database. Also notifies the appropriate model listeners.
*
* @param team the team
* @return the team that was removed
* @throws PortalException
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
public com.liferay.portal.model.Team deleteTeam(
com.liferay.portal.model.Team team)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.Team fetchTeam(long teamId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the team with the primary key.
*
* @param teamId the primary key of the team
* @return the team
* @throws PortalException if a team with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.Team getTeam(long teamId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* 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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param start the lower bound of the range of teams
* @param end the upper bound of the range of teams (not inclusive)
* @return the range of teams
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getTeams(int start,
int end) throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of teams.
*
* @return the number of teams
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getTeamsCount()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Updates the team in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param team the team
* @return the team that was updated
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
public com.liferay.portal.model.Team updateTeam(
com.liferay.portal.model.Team team)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void addUserTeam(long userId, long teamId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void addUserTeam(long userId, com.liferay.portal.model.Team team)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void addUserTeams(long userId, long[] teamIds)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void addUserTeams(long userId,
java.util.List Teams)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void clearUserTeams(long userId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void deleteUserTeam(long userId, long teamId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void deleteUserTeam(long userId, com.liferay.portal.model.Team team)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void deleteUserTeams(long userId, long[] teamIds)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void deleteUserTeams(long userId,
java.util.List Teams)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserTeams(
long userId) throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserTeams(
long userId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserTeams(
long userId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getUserTeamsCount(long userId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasUserTeam(long userId, long teamId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasUserTeams(long userId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void setUserTeams(long userId, long[] teamIds)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void addUserGroupTeam(long userGroupId, long teamId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void addUserGroupTeam(long userGroupId,
com.liferay.portal.model.Team team)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void addUserGroupTeams(long userGroupId, long[] teamIds)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void addUserGroupTeams(long userGroupId,
java.util.List Teams)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void clearUserGroupTeams(long userGroupId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void deleteUserGroupTeam(long userGroupId, long teamId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void deleteUserGroupTeam(long userGroupId,
com.liferay.portal.model.Team team)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void deleteUserGroupTeams(long userGroupId, long[] teamIds)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void deleteUserGroupTeams(long userGroupId,
java.util.List Teams)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserGroupTeams(
long userGroupId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserGroupTeams(
long userGroupId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserGroupTeams(
long userGroupId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getUserGroupTeamsCount(long userGroupId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasUserGroupTeam(long userGroupId, long teamId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasUserGroupTeams(long userGroupId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @throws SystemException if a system exception occurred
*/
public void setUserGroupTeams(long userGroupId, long[] teamIds)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public java.lang.String getBeanIdentifier();
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public void setBeanIdentifier(java.lang.String beanIdentifier);
public com.liferay.portal.model.Team addTeam(long userId, long groupId,
java.lang.String name, java.lang.String description)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void deleteTeams(long groupId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getGroupTeams(
long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.Team getTeam(long groupId,
java.lang.String name)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getUserTeams(
long userId, long groupId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List search(long groupId,
java.lang.String name, java.lang.String description,
java.util.LinkedHashMap params,
int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(long groupId, java.lang.String name,
java.lang.String description,
java.util.LinkedHashMap params)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.Team updateTeam(long teamId,
java.lang.String name, java.lang.String description)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
}