/** * 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.sampleservicebuilder.service; import aQute.bnd.annotation.ProviderType; import com.liferay.exportimport.kernel.lar.PortletDataContext; import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.DynamicQuery; import com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery; 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.sampleservicebuilder.model.Foo; import java.io.Serializable; import java.util.Date; import java.util.List; /** * Provides the local service interface for Foo. 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 FooLocalServiceUtil * @see com.liferay.sampleservicebuilder.service.base.FooLocalServiceBaseImpl * @see com.liferay.sampleservicebuilder.service.impl.FooLocalServiceImpl * @generated */ @ProviderType @Transactional(isolation = Isolation.PORTAL, rollbackFor = { PortalException.class, SystemException.class}) public interface FooLocalService extends BaseLocalService, InvokableLocalService, PersistedModelLocalService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this interface directly. Always use {@link FooLocalServiceUtil} to access the foo local service. Add custom service methods to {@link com.liferay.sampleservicebuilder.service.impl.FooLocalServiceImpl} 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 ExportActionableDynamicQuery getExportActionableDynamicQuery( PortletDataContext portletDataContext); @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 foo to the database. Also notifies the appropriate model listeners. * * @param foo the foo * @return the foo that was added */ @Indexable(type = IndexableType.REINDEX) public Foo addFoo(Foo foo); /** * Creates a new foo with the primary key. Does not add the foo to the database. * * @param fooId the primary key for the new foo * @return the new foo */ public Foo createFoo(long fooId); /** * Deletes the foo from the database. Also notifies the appropriate model listeners. * * @param foo the foo * @return the foo that was removed */ @Indexable(type = IndexableType.DELETE) public Foo deleteFoo(Foo foo); /** * Deletes the foo with the primary key from the database. Also notifies the appropriate model listeners. * * @param fooId the primary key of the foo * @return the foo that was removed * @throws PortalException if a foo with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) public Foo deleteFoo(long fooId) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public Foo fetchFoo(long fooId); /** * Returns the foo matching the UUID and group. * * @param uuid the foo's UUID * @param groupId the primary key of the group * @return the matching foo, or <code>null</code> if a matching foo could not be found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public Foo fetchFooByUuidAndGroupId(java.lang.String uuid, long groupId); /** * Returns the foo with the primary key. * * @param fooId the primary key of the foo * @return the foo * @throws PortalException if a foo with the primary key could not be found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public Foo getFoo(long fooId) throws PortalException; /** * Returns the foo matching the UUID and group. * * @param uuid the foo's UUID * @param groupId the primary key of the group * @return the matching foo * @throws PortalException if a matching foo could not be found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public Foo getFooByUuidAndGroupId(java.lang.String uuid, long groupId) throws PortalException; /** * Updates the foo in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param foo the foo * @return the foo that was updated */ @Indexable(type = IndexableType.REINDEX) public Foo updateFoo(Foo foo); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getField1FoosCount(java.lang.String[] field1s); /** * Returns the number of foos. * * @return the number of foos */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getFoosCount(); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.lang.Object getLocalObject() throws java.lang.Exception; @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.sampleservicebuilder.model.impl.FooModelImpl}. 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.sampleservicebuilder.model.impl.FooModelImpl}. 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<Foo> getField1Foos(java.lang.String[] field1s, int start, int end, OrderByComparator<Foo> obc); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<Foo> getFoos(); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<Foo> getFoos(OrderByComparator<Foo> obc); /** * Returns a range of all the foos. * * <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.sampleservicebuilder.model.impl.FooModelImpl}. 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 foos * @param end the upper bound of the range of foos (not inclusive) * @return the range of foos */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<Foo> getFoos(int start, int end); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<Foo> getFoos(int start, int end, OrderByComparator<Foo> obc); /** * Returns all the foos matching the UUID and company. * * @param uuid the UUID of the foos * @param companyId the primary key of the company * @return the matching foos, or an empty list if no matches were found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<Foo> getFoosByUuidAndCompanyId(java.lang.String uuid, long companyId); /** * Returns a range of foos matching the UUID and company. * * @param uuid the UUID of the foos * @param companyId the primary key of the company * @param start the lower bound of the range of foos * @param end the upper bound of the range of foos (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the range of matching foos, or an empty list if no matches were found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<Foo> getFoosByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, OrderByComparator<Foo> orderByComparator); /** * 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 addFoo(java.lang.String field1, boolean field2, int field3, Date field4, java.lang.String field5, ServiceContext serviceContext) throws PortalException; public void deleteFoos(); public void updateAsset(long userId, Foo foo, long[] assetCategoryIds, java.lang.String[] assetTagNames) throws PortalException; public void updateFoo(long fooId, java.lang.String field1, boolean field2, int field3, Date field4, java.lang.String field5, ServiceContext serviceContext) throws PortalException; }