Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface ImageLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ImageLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ImageLocalService
extends BaseLocalService, PersistedModelLocalService

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.

See Also:
ImageLocalServiceUtil, ImageLocalServiceBaseImpl, com.liferay.portal.service.impl.ImageLocalServiceImpl

Method Summary
 Image addImage(Image image)
          Adds the image to the database.
 Image createImage(long imageId)
          Creates a new image with the primary key.
 Image deleteImage(Image image)
          Deletes the image from the database.
 Image deleteImage(long imageId)
          Deletes the image with the primary key from the database.
 DynamicQuery dynamicQuery()
           
 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)
          Returns the number of rows that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 Image fetchImage(long imageId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 Image getCompanyLogo(long imageId)
           
 Image getImage(long imageId)
          Returns the image with the primary key.
 Image getImageOrDefault(long imageId)
           
 List<Image> getImages()
           
 List<Image> getImages(int start, int end)
          Returns a range of all the images.
 List<Image> getImagesBySize(int size)
           
 int getImagesCount()
          Returns the number of images.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 Image updateImage(Image image)
          Updates the image in the database or adds it if it does not yet exist.
 Image updateImage(long imageId, byte[] bytes)
           
 Image updateImage(long imageId, byte[] bytes, String type, int height, int width, int size)
           
 Image updateImage(long imageId, File file)
           
 Image updateImage(long imageId, InputStream is)
           
 Image updateImage(long imageId, InputStream is, boolean cleanUpStream)
           
 

Method Detail

addImage

@Indexable(type=REINDEX)
Image addImage(Image image)
               throws SystemException
Adds the image to the database. Also notifies the appropriate model listeners.

Parameters:
image - the image
Returns:
the image that was added
Throws:
SystemException - if a system exception occurred

createImage

Image createImage(long imageId)
Creates a new image with the primary key. Does not add the image to the database.

Parameters:
imageId - the primary key for the new image
Returns:
the new image

deleteImage

@Indexable(type=DELETE)
Image deleteImage(long imageId)
                  throws PortalException,
                         SystemException
Deletes the image with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
imageId - the primary key of the image
Returns:
the image that was removed
Throws:
PortalException - if a image with the primary key could not be found
SystemException - if a system exception occurred

deleteImage

@Indexable(type=DELETE)
Image deleteImage(Image image)
                  throws SystemException
Deletes the image from the database. Also notifies the appropriate model listeners.

Parameters:
image - the image
Returns:
the image that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

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

Parameters:
dynamicQuery - the dynamic query
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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ImageModelImpl. 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.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ImageModelImpl. 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.

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

dynamicQueryCount

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

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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

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

fetchImage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image fetchImage(long imageId)
                 throws SystemException
Throws:
SystemException

getImage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image getImage(long imageId)
               throws PortalException,
                      SystemException
Returns the image with the primary key.

Parameters:
imageId - the primary key of the image
Returns:
the image
Throws:
PortalException - if a image with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getImages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Image> getImages(int start,
                                                               int end)
                      throws SystemException
Returns a range of all the images.

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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ImageModelImpl. 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.

Parameters:
start - the lower bound of the range of images
end - the upper bound of the range of images (not inclusive)
Returns:
the range of images
Throws:
SystemException - if a system exception occurred

getImagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getImagesCount()
                   throws SystemException
Returns the number of images.

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

updateImage

@Indexable(type=REINDEX)
Image updateImage(Image image)
                  throws SystemException
Updates the image in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
image - the image
Returns:
the image that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

getCompanyLogo

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image getCompanyLogo(long imageId)

getImageOrDefault

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image getImageOrDefault(long imageId)

getImages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Image> getImages()
                      throws SystemException
Throws:
SystemException

getImagesBySize

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Image> getImagesBySize(int size)
                            throws SystemException
Throws:
SystemException

updateImage

Image updateImage(long imageId,
                  byte[] bytes)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

updateImage

Image updateImage(long imageId,
                  byte[] bytes,
                  String type,
                  int height,
                  int width,
                  int size)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

updateImage

Image updateImage(long imageId,
                  File file)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

updateImage

Image updateImage(long imageId,
                  InputStream is)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

updateImage

Image updateImage(long imageId,
                  InputStream is,
                  boolean cleanUpStream)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5