/** * Copyright (c) 2000-present 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.tasks.service; import aQute.bnd.annotation.ProviderType; import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.DynamicQuery; import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.Projection; import com.liferay.portal.kernel.exception.PortalException; import com.liferay.portal.kernel.exception.SystemException; import com.liferay.portal.kernel.model.PersistedModel; import com.liferay.portal.kernel.search.Indexable; import com.liferay.portal.kernel.search.IndexableType; import com.liferay.portal.kernel.service.BaseLocalService; import com.liferay.portal.kernel.service.InvokableLocalService; import com.liferay.portal.kernel.service.PersistedModelLocalService; import com.liferay.portal.kernel.service.ServiceContext; import com.liferay.portal.kernel.transaction.Isolation; import com.liferay.portal.kernel.transaction.Propagation; import com.liferay.portal.kernel.transaction.Transactional; import com.liferay.portal.kernel.util.OrderByComparator; import com.liferay.tasks.model.TasksEntry; import java.io.Serializable; import java.util.List; /** * Provides the local service interface for TasksEntry. 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 Ryan Park * @see TasksEntryLocalServiceUtil * @see com.liferay.tasks.service.base.TasksEntryLocalServiceBaseImpl * @see com.liferay.tasks.service.impl.TasksEntryLocalServiceImpl * @generated */ @ProviderType @Transactional(isolation = Isolation.PORTAL, rollbackFor = { PortalException.class, SystemException.class}) public interface TasksEntryLocalService extends BaseLocalService, InvokableLocalService, PersistedModelLocalService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this interface directly. Always use {@link TasksEntryLocalServiceUtil} to access the tasks entry local service. Add custom service methods to {@link com.liferay.tasks.service.impl.TasksEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public ActionableDynamicQuery getActionableDynamicQuery(); public DynamicQuery dynamicQuery(); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException; @Override @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException; /** * Adds the tasks entry to the database. Also notifies the appropriate model listeners. * * @param tasksEntry the tasks entry * @return the tasks entry that was added */ @Indexable(type = IndexableType.REINDEX) public TasksEntry addTasksEntry(TasksEntry tasksEntry); public TasksEntry addTasksEntry(long userId, java.lang.String title, int priority, long assigneeUserId, int dueDateMonth, int dueDateDay, int dueDateYear, int dueDateHour, int dueDateMinute, boolean addDueDate, ServiceContext serviceContext) throws PortalException; /** * Creates a new tasks entry with the primary key. Does not add the tasks entry to the database. * * @param tasksEntryId the primary key for the new tasks entry * @return the new tasks entry */ public TasksEntry createTasksEntry(long tasksEntryId); /** * Deletes the tasks entry from the database. Also notifies the appropriate model listeners. * * @param tasksEntry the tasks entry * @return the tasks entry that was removed * @throws PortalException */ @Indexable(type = IndexableType.DELETE) public TasksEntry deleteTasksEntry(TasksEntry tasksEntry) throws PortalException; /** * Deletes the tasks entry with the primary key from the database. Also notifies the appropriate model listeners. * * @param tasksEntryId the primary key of the tasks entry * @return the tasks entry that was removed * @throws PortalException if a tasks entry with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) public TasksEntry deleteTasksEntry(long tasksEntryId) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public TasksEntry fetchTasksEntry(long tasksEntryId); /** * Returns the tasks entry with the primary key. * * @param tasksEntryId the primary key of the tasks entry * @return the tasks entry * @throws PortalException if a tasks entry with the primary key could not be found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public TasksEntry getTasksEntry(long tasksEntryId) throws PortalException; /** * Updates the tasks entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param tasksEntry the tasks entry * @return the tasks entry that was updated */ @Indexable(type = IndexableType.REINDEX) public TasksEntry updateTasksEntry(TasksEntry tasksEntry); public TasksEntry updateTasksEntry(long tasksEntryId, java.lang.String title, int priority, long assigneeUserId, long resolverUserId, int dueDateMonth, int dueDateDay, int dueDateYear, int dueDateHour, int dueDateMinute, boolean addDueDate, int status, ServiceContext serviceContext) throws PortalException; public TasksEntry updateTasksEntryStatus(long tasksEntryId, long resolverUserId, int status, ServiceContext serviceContext) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getAssigneeTasksEntriesCount(long assigneeUserId); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getGroupAssigneeTasksEntriesCount(long groupId, long assigneeUserId); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getGroupResolverTasksEntriesCount(long groupId, long resolverUserId); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getGroupUserTasksEntriesCount(long groupId, long userId); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getResolverTasksEntriesCount(long resolverUserId); /** * Returns the number of tasks entries. * * @return the number of tasks entries */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getTasksEntriesCount(); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getTasksEntriesCount(long groupId); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getTasksEntriesCount(long groupId, long userId, int priority, long assigneeUserId, int status, long[] tagsEntryIds, long[] notTagsEntryIds); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getUserTasksEntriesCount(long userId); @Override public java.lang.Object invokeMethod(java.lang.String name, java.lang.String[] parameterTypes, java.lang.Object[] arguments) throws java.lang.Throwable; /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ public java.lang.String getOSGiServiceIdentifier(); /** * Performs a dynamic query on the database and returns the matching rows. * * @param dynamicQuery the dynamic query * @return the matching rows */ public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); /** * Performs a dynamic query on the database and returns a range of the matching rows. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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.tasks.model.impl.TasksEntryModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @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 */ public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end); /** * Performs a dynamic query on the database and returns an ordered range of the matching rows. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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.tasks.model.impl.TasksEntryModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @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 <code>null</code>) * @return the ordered range of matching rows */ public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<TasksEntry> getAssigneeTasksEntries(long assigneeUserId, int start, int end); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<TasksEntry> getGroupAssigneeTasksEntries(long groupId, long assigneeUserId, int start, int end); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<TasksEntry> getGroupResolverTasksEntries(long groupId, long resolverUserId, int start, int end); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<TasksEntry> getGroupUserTasksEntries(long groupId, long userId, int start, int end); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<TasksEntry> getResolverTasksEntries(long resolverUserId, int start, int end); /** * Returns a range of all the tasks entries. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> 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.tasks.model.impl.TasksEntryModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @param start the lower bound of the range of tasks entries * @param end the upper bound of the range of tasks entries (not inclusive) * @return the range of tasks entries */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<TasksEntry> getTasksEntries(int start, int end); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<TasksEntry> getTasksEntries(long groupId, int start, int end); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<TasksEntry> getTasksEntries(long groupId, long userId, int priority, long assigneeUserId, int status, long[] assetTagIds, long[] notAssetTagIds, int start, int end); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<TasksEntry> getUserTasksEntries(long userId, int start, int end); /** * Returns the number of rows matching the dynamic query. * * @param dynamicQuery the dynamic query * @return the number of rows matching the dynamic query */ public long dynamicQueryCount(DynamicQuery dynamicQuery); /** * Returns the number of rows matching the dynamic query. * * @param dynamicQuery the dynamic query * @param projection the projection to apply to the query * @return the number of rows matching the dynamic query */ public long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection); public void updateAsset(long userId, TasksEntry tasksEntry, long[] assetCategoryIds, java.lang.String[] assetTagNames) throws PortalException; }