com.liferay.mail.reader.service

Class AttachmentLocalServiceUtil

java.lang.Object

com.liferay.mail.reader.service.AttachmentLocalServiceUtil

public class AttachmentLocalServiceUtil
extends java.lang.Object

Provides the local service utility for Attachment. This utility wraps com.liferay.mail.reader.service.impl.AttachmentLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:

AttachmentLocalService

Constructor Summary

Constructors

Constructor and Description
AttachmentLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static Attachment	addAttachment(Attachment attachment) Adds the attachment to the database.
static Attachment	addAttachment(long userId, long messageId, java.lang.String contentPath, java.lang.String fileName, long size, java.io.File file)
static Attachment	createAttachment(long attachmentId) Creates a new attachment with the primary key.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static Attachment	deleteAttachment(Attachment attachment) Deletes the attachment from the database.
static Attachment	deleteAttachment(long attachmentId) Deletes the attachment with the primary key from the database.
static void	deleteAttachments(long companyId, long messageId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static <T> T	dslQuery(DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static Attachment	fetchAttachment(long attachmentId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static Attachment	getAttachment(long attachmentId) Returns the attachment with the primary key.
static java.util.List<Attachment>	getAttachments(int start, int end) Returns a range of all the attachments.
static java.util.List<Attachment>	getAttachments(long messageId)
static int	getAttachmentsCount() Returns the number of attachments.
static java.io.File	getFile(long attachmentId)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.io.InputStream	getInputStream(long attachmentId)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static AttachmentLocalService	getService()
static Attachment	updateAttachment(Attachment attachment) Updates the attachment in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttachmentLocalServiceUtil

public AttachmentLocalServiceUtil()

Method Detail

addAttachment

public static Attachment addAttachment(Attachment attachment)

Adds the attachment to the database. Also notifies the appropriate model listeners.

Important: Inspect AttachmentLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

attachment - the attachment

Returns:

the attachment that was added

addAttachment

public static Attachment addAttachment(long userId,
                                       long messageId,
                                       java.lang.String contentPath,
                                       java.lang.String fileName,
                                       long size,
                                       java.io.File file)
                                throws PortalException

Throws:

PortalException

createAttachment

public static Attachment createAttachment(long attachmentId)

Creates a new attachment with the primary key. Does not add the attachment to the database.

Parameters:

attachmentId - the primary key for the new attachment

Returns:

the new attachment

createPersistedModel

public static PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteAttachment

public static Attachment deleteAttachment(Attachment attachment)

Deletes the attachment from the database. Also notifies the appropriate model listeners.

Important: Inspect AttachmentLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

attachment - the attachment

Returns:

the attachment that was removed

deleteAttachment

public static Attachment deleteAttachment(long attachmentId)
                                   throws PortalException

Deletes the attachment with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect AttachmentLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

attachmentId - the primary key of the attachment

Returns:

the attachment that was removed

Throws:

PortalException - if a attachment with the primary key could not be found

deleteAttachments

public static void deleteAttachments(long companyId,
                                     long messageId)
                              throws PortalException

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.mail.reader.model.impl.AttachmentModelImpl.

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

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<T> orderByComparator)

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.mail.reader.model.impl.AttachmentModelImpl.

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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchAttachment

public static Attachment fetchAttachment(long attachmentId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getAttachment

public static Attachment getAttachment(long attachmentId)
                                throws PortalException

Returns the attachment with the primary key.

Parameters:

attachmentId - the primary key of the attachment

Returns:

the attachment

Throws:

PortalException - if a attachment with the primary key could not be found

getAttachments

public static java.util.List<Attachment> getAttachments(int start,
                                                        int end)

Returns a range of all the attachments.

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.mail.reader.model.impl.AttachmentModelImpl.

Parameters:

start - the lower bound of the range of attachments

end - the upper bound of the range of attachments (not inclusive)

Returns:

the range of attachments

getAttachments

public static java.util.List<Attachment> getAttachments(long messageId)

getAttachmentsCount

public static int getAttachmentsCount()

Returns the number of attachments.

Returns:

the number of attachments

getFile

public static java.io.File getFile(long attachmentId)
                            throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getInputStream

public static java.io.InputStream getInputStream(long attachmentId)
                                          throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

updateAttachment

public static Attachment updateAttachment(Attachment attachment)

Updates the attachment in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect AttachmentLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

attachment - the attachment

Returns:

the attachment that was updated

getService

public static AttachmentLocalService getService()