@ProviderType
public class AttachmentLocalServiceUtil
extends java.lang.Object
com.liferay.mail.reader.service.impl.AttachmentLocalServiceImpl
and is the
primary 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.AttachmentLocalService
,
com.liferay.mail.reader.service.base.AttachmentLocalServiceBaseImpl
,
com.liferay.mail.reader.service.impl.AttachmentLocalServiceImpl
Constructor and Description |
---|
AttachmentLocalServiceUtil() |
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 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 com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
Returns the number of rows matching the dynamic query.
|
static Attachment |
fetchAttachment(long attachmentId) |
static com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static java.io.InputStream |
getInputStream(long attachmentId) |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.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.
|
public static Attachment addAttachment(Attachment attachment)
attachment
- the attachmentpublic static Attachment addAttachment(long userId, long messageId, java.lang.String contentPath, java.lang.String fileName, long size, java.io.File file) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static Attachment createAttachment(long attachmentId)
attachmentId
- the primary key for the new attachmentpublic static Attachment deleteAttachment(Attachment attachment)
attachment
- the attachmentpublic static Attachment deleteAttachment(long attachmentId) throws com.liferay.portal.kernel.exception.PortalException
attachmentId
- the primary key of the attachmentPortalException
- if a attachment with the primary key could not be foundpublic static void deleteAttachments(long companyId, long messageId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
PortalException
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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 com.liferay.mail.reader.model.impl.AttachmentModelImpl
. 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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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 com.liferay.mail.reader.model.impl.AttachmentModelImpl
. 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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static Attachment fetchAttachment(long attachmentId)
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static Attachment getAttachment(long attachmentId) throws com.liferay.portal.kernel.exception.PortalException
attachmentId
- the primary key of the attachmentPortalException
- if a attachment with the primary key could not be foundpublic static java.util.List<Attachment> getAttachments(int start, int end)
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 com.liferay.mail.reader.model.impl.AttachmentModelImpl
. 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.
start
- the lower bound of the range of attachmentsend
- the upper bound of the range of attachments (not inclusive)public static java.util.List<Attachment> getAttachments(long messageId)
public static int getAttachmentsCount()
public static java.io.File getFile(long attachmentId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static java.io.InputStream getInputStream(long attachmentId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static Attachment updateAttachment(Attachment attachment)
attachment
- the attachmentpublic static AttachmentLocalService getService()