com.liferay.mail.reader.service

Interface AttachmentLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

AttachmentLocalServiceWrapper

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

Provides the local service interface for Attachment. 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:

AttachmentLocalServiceUtil

Method Summary

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

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addAttachment

@Indexable(type=REINDEX)
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

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

@Transactional(enabled=false)
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

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

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteAttachment

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

void deleteAttachments(long companyId,
                       long messageId)
                throws PortalException

Throws:

PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Attachment fetchAttachment(long attachmentId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getAttachment

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Attachment> getAttachments(long messageId)

getAttachmentsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAttachmentsCount()

Returns the number of attachments.

Returns:

the number of attachments

getFile

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.io.File getFile(long attachmentId)
                                                                                 throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getInputStream

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.io.InputStream getInputStream(long attachmentId)
                                                                                               throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

updateAttachment

@Indexable(type=REINDEX)
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