Java tutorial
/** * 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.portal.kernel.service; 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.Image; 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.transaction.Isolation; import com.liferay.portal.kernel.transaction.Propagation; import com.liferay.portal.kernel.transaction.Transactional; import com.liferay.portal.kernel.util.OrderByComparator; import java.io.File; import java.io.InputStream; import java.io.Serializable; import java.util.List; import org.osgi.annotation.versioning.ProviderType; /** * Provides the local service interface for Image. 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 ImageLocalServiceUtil * @generated */ @ProviderType @Transactional(isolation = Isolation.PORTAL, rollbackFor = { PortalException.class, SystemException.class }) public interface ImageLocalService extends BaseLocalService, PersistedModelLocalService { /** * NOTE FOR DEVELOPERS: * * Never modify or reference this interface directly. Always use {@link ImageLocalServiceUtil} to access the image local service. Add custom service methods to <code>com.liferay.portal.service.impl.ImageLocalServiceImpl</code> and rerun ServiceBuilder to automatically copy the method declarations to this interface. */ /** * Adds the image to the database. Also notifies the appropriate model listeners. * * @param image the image * @return the image that was added */ @Indexable(type = IndexableType.REINDEX) public Image addImage(Image image); /** * Creates a new image with the primary key. Does not add the image to the database. * * @param imageId the primary key for the new image * @return the new image */ @Transactional(enabled = false) public Image createImage(long imageId); /** * Deletes the image from the database. Also notifies the appropriate model listeners. * * @param image the image * @return the image that was removed */ @Indexable(type = IndexableType.DELETE) public Image deleteImage(Image image); /** * Deletes the image with the primary key from the database. Also notifies the appropriate model listeners. * * @param imageId the primary key of the image * @return the image that was removed * @throws PortalException if a image with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) public Image deleteImage(long imageId) throws PortalException; /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public DynamicQuery dynamicQuery(); /** * Performs a dynamic query on the database and returns the matching rows. * * @param dynamicQuery the dynamic query * @return the matching rows */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> 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, then the query will include the default ORDER BY logic from <code>com.liferay.portal.model.impl.ImageModelImpl</code>. * </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 */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> 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, then the query will include the default ORDER BY logic from <code>com.liferay.portal.model.impl.ImageModelImpl</code>. * </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 */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator); /** * Returns the number of rows matching the dynamic query. * * @param dynamicQuery the dynamic query * @return the number of rows matching the dynamic query */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 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 */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public Image fetchImage(long imageId); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public ActionableDynamicQuery getActionableDynamicQuery(); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public Image getCompanyLogo(long imageId); /** * Returns the image with the primary key. * * @param imageId the primary key of the image * @return the image * @throws PortalException if a image with the primary key could not be found */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public Image getImage(long imageId) throws PortalException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public Image getImageOrDefault(long imageId); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<Image> getImages(); /** * Returns a range of all the images. * * <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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> 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, then the query will include the default ORDER BY logic from <code>com.liferay.portal.model.impl.ImageModelImpl</code>. * </p> * * @param start the lower bound of the range of images * @param end the upper bound of the range of images (not inclusive) * @return the range of images */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<Image> getImages(int start, int end); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public List<Image> getImagesBySize(int size); /** * Returns the number of images. * * @return the number of images */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getImagesCount(); @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ public String getOSGiServiceIdentifier(); @Override @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException; public Image moveImage(long imageId, byte[] bytes) throws PortalException; /** * Updates the image in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param image the image * @return the image that was updated */ @Indexable(type = IndexableType.REINDEX) public Image updateImage(Image image); public Image updateImage(long imageId, byte[] bytes) throws PortalException; public Image updateImage(long imageId, byte[] bytes, String type, int height, int width, int size) throws PortalException; public Image updateImage(long imageId, File file) throws PortalException; public Image updateImage(long imageId, InputStream is) throws PortalException; public Image updateImage(long imageId, InputStream is, boolean cleanUpStream) throws PortalException; }