Liferay 6.0-ee

com.liferay.portal.service
Interface ImageLocalService

All Known Implementing Classes:
ImageLocalServiceBaseImpl, ImageLocalServiceImpl, ImageLocalServiceWrapper

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

The interface for the image local service.

Never modify or reference this interface directly. Always use ImageLocalServiceUtil to access the image local service. Add custom service methods to ImageLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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, ImageLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 Image addImage(Image image)
          Adds the image to the database.
 Image createImage(long imageId)
          Creates a new image with the primary key.
 void deleteImage(Image image)
          Deletes the image from the database.
 void deleteImage(long imageId)
          Deletes the image with the primary key from the database.
 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)
          Counts the number of rows that match the dynamic query.
 Image getCompanyLogo(long imageId)
           
 Image getDefaultCompanyLogo()
           
 Image getDefaultOrganizationLogo()
           
 Image getDefaultSpacer()
           
 Image getDefaultUserFemalePortrait()
           
 Image getDefaultUserMalePortrait()
           
 Image getImage(byte[] bytes)
           
 Image getImage(File file)
           
 Image getImage(InputStream is)
           
 Image getImage(long imageId)
          Gets the image with the primary key.
 Image getImageOrDefault(long imageId)
           
 List<Image> getImages()
           
 List<Image> getImages(int start, int end)
          Gets a range of all the images.
 List<Image> getImagesBySize(int size)
           
 int getImagesCount()
          Gets the number of images.
 boolean isNullOrDefaultSpacer(byte[] bytes)
           
 Image updateImage(Image image)
          Updates the image in the database.
 Image updateImage(Image image, boolean merge)
          Updates the image in the database.
 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)
           
 

Method Detail

addImage

Image addImage(Image image)
               throws SystemException
Adds the image to the database. Also notifies the appropriate model listeners.

Parameters:
image - the image to add
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

void 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 to delete
Throws:
PortalException - if a image with the primary key could not be found
SystemException - if a system exception occurred

deleteImage

void deleteImage(Image image)
                 throws SystemException
Deletes the image from the database. Also notifies the appropriate model listeners.

Parameters:
image - the image to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

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

Parameters:
dynamicQuery - the dynamic query to search with
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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (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.

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

dynamicQueryCount

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

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

getImage

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

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

getImages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Image> getImages(int start,
                                                               int end)
                      throws SystemException
Gets 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.

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

getImagesCount

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

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

updateImage

Image updateImage(Image image)
                  throws SystemException
Updates the image in the database. Also notifies the appropriate model listeners.

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

updateImage

Image updateImage(Image image,
                  boolean merge)
                  throws SystemException
Updates the image in the database. Also notifies the appropriate model listeners.

Parameters:
image - the image to update
merge - whether to merge the image with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the image that was updated
Throws:
SystemException - if a system exception occurred

getCompanyLogo

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

getDefaultCompanyLogo

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image getDefaultCompanyLogo()

getDefaultOrganizationLogo

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image getDefaultOrganizationLogo()

getDefaultSpacer

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image getDefaultSpacer()

getDefaultUserFemalePortrait

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image getDefaultUserFemalePortrait()

getDefaultUserMalePortrait

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image getDefaultUserMalePortrait()

getImage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image getImage(byte[] bytes)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

getImage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image getImage(File file)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

getImage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Image getImage(InputStream is)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

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

isNullOrDefaultSpacer

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isNullOrDefaultSpacer(byte[] bytes)

updateImage

Image updateImage(long imageId,
                  byte[] bytes)
                  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,
                  byte[] bytes,
                  String type,
                  int height,
                  int width,
                  int size)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

Liferay 6.0-ee