Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Class ImageLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.ImageLocalServiceUtil

public class ImageLocalServiceUtil
extends Object

The utility for the image local service. This utility wraps com.liferay.portal.service.impl.ImageLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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:
ImageLocalService, ImageLocalServiceBaseImpl, com.liferay.portal.service.impl.ImageLocalServiceImpl

Constructor Summary
ImageLocalServiceUtil()
           
 
Method Summary
static Image addImage(Image image)
          Adds the image to the database.
static Image createImage(long imageId)
          Creates a new image with the primary key.
static Image deleteImage(Image image)
          Deletes the image from the database.
static Image deleteImage(long imageId)
          Deletes the image with the primary key from the database.
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static Image fetchImage(long imageId)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static Image getCompanyLogo(long imageId)
           
static Image getDefaultCompanyLogo()
           
static Image getDefaultOrganizationLogo()
           
static Image getDefaultSpacer()
           
static Image getDefaultUserFemalePortrait()
           
static Image getDefaultUserMalePortrait()
           
static Image getImage(byte[] bytes)
           
static Image getImage(File file)
           
static Image getImage(InputStream is)
           
static Image getImage(InputStream is, boolean cleanUpStream)
           
static Image getImage(long imageId)
          Returns the image with the primary key.
static Image getImageOrDefault(long imageId)
           
static List<Image> getImages()
           
static List<Image> getImages(int start, int end)
          Returns a range of all the images.
static List<Image> getImagesBySize(int size)
           
static int getImagesCount()
          Returns the number of images.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static ImageLocalService getService()
           
static boolean isNullOrDefaultSpacer(byte[] bytes)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(ImageLocalService service)
          Deprecated.  
static Image updateImage(Image image)
          Updates the image in the database or adds it if it does not yet exist.
static Image updateImage(Image image, boolean merge)
          Updates the image in the database or adds it if it does not yet exist.
static Image updateImage(long imageId, byte[] bytes)
           
static Image updateImage(long imageId, byte[] bytes, String type, int height, int width, int size)
           
static Image updateImage(long imageId, File file)
           
static Image updateImage(long imageId, InputStream is)
           
static Image updateImage(long imageId, InputStream is, boolean cleanUpStream)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImageLocalServiceUtil

public ImageLocalServiceUtil()
Method Detail

addImage

public static 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

public static 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

public static 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

public static 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

public static DynamicQuery dynamicQuery()

dynamicQuery

public static 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

public static 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
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

public static 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
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

public static 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

fetchImage

public static Image fetchImage(long imageId)
                        throws SystemException
Throws:
SystemException

getImage

public static 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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getImages

public static 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.

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

public static int getImagesCount()
                          throws SystemException
Returns the number of images.

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

updateImage

public static 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

updateImage

public static Image updateImage(Image image,
                                boolean merge)
                         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
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

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

getCompanyLogo

public static Image getCompanyLogo(long imageId)

getDefaultCompanyLogo

public static Image getDefaultCompanyLogo()

getDefaultOrganizationLogo

public static Image getDefaultOrganizationLogo()

getDefaultSpacer

public static Image getDefaultSpacer()

getDefaultUserFemalePortrait

public static Image getDefaultUserFemalePortrait()

getDefaultUserMalePortrait

public static Image getDefaultUserMalePortrait()

getImage

public static Image getImage(byte[] bytes)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getImage

public static Image getImage(File file)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getImage

public static Image getImage(InputStream is)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getImage

public static Image getImage(InputStream is,
                             boolean cleanUpStream)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getImageOrDefault

public static Image getImageOrDefault(long imageId)

getImages

public static List<Image> getImages()
                             throws SystemException
Throws:
SystemException

getImagesBySize

public static List<Image> getImagesBySize(int size)
                                   throws SystemException
Throws:
SystemException

isNullOrDefaultSpacer

public static boolean isNullOrDefaultSpacer(byte[] bytes)

updateImage

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

updateImage

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

updateImage

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

updateImage

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

updateImage

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

getService

public static ImageLocalService getService()

setService

public void setService(ImageLocalService service)
Deprecated. 


Liferay 6.1.2-ce-ga3