com.liferay.mail.reader.service.persistence.AttachmentPersistence Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.mail.reader.service.persistence;
import aQute.bnd.annotation.ProviderType;
import com.liferay.mail.reader.exception.NoSuchAttachmentException;
import com.liferay.mail.reader.model.Attachment;
import com.liferay.portal.kernel.service.persistence.BasePersistence;
import java.io.Serializable;
import java.util.Map;
import java.util.Set;
/**
* The persistence interface for the attachment service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see AttachmentUtil
* @generated
*/
@ProviderType
public interface AttachmentPersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link AttachmentUtil} to access the attachment persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
@Override
public Map fetchByPrimaryKeys(
Set primaryKeys);
/**
* Returns all the attachments where messageId = ?.
*
* @param messageId the message ID
* @return the matching attachments
*/
public java.util.List findByMessageId(long messageId);
/**
* Returns a range of all the attachments where messageId = ?.
*
*
* 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 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.
*
*
* @param messageId the message ID
* @param start the lower bound of the range of attachments
* @param end the upper bound of the range of attachments (not inclusive)
* @return the range of matching attachments
*/
public java.util.List findByMessageId(
long messageId, int start, int end);
/**
* Returns an ordered range of all the attachments where messageId = ?.
*
*
* 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 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.
*
*
* @param messageId the message ID
* @param start the lower bound of the range of attachments
* @param end the upper bound of the range of attachments (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching attachments
*/
public java.util.List findByMessageId(
long messageId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns an ordered range of all the attachments where messageId = ?.
*
*
* 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 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.
*
*
* @param messageId the message ID
* @param start the lower bound of the range of attachments
* @param end the upper bound of the range of attachments (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param retrieveFromCache whether to retrieve from the finder cache
* @return the ordered range of matching attachments
*/
public java.util.List findByMessageId(
long messageId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
boolean retrieveFromCache);
/**
* Returns the first attachment in the ordered set where messageId = ?.
*
* @param messageId the message ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching attachment
* @throws NoSuchAttachmentException if a matching attachment could not be found
*/
public Attachment findByMessageId_First(
long messageId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchAttachmentException;
/**
* Returns the first attachment in the ordered set where messageId = ?.
*
* @param messageId the message ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching attachment, or null if a matching attachment could not be found
*/
public Attachment fetchByMessageId_First(
long messageId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns the last attachment in the ordered set where messageId = ?.
*
* @param messageId the message ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching attachment
* @throws NoSuchAttachmentException if a matching attachment could not be found
*/
public Attachment findByMessageId_Last(
long messageId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchAttachmentException;
/**
* Returns the last attachment in the ordered set where messageId = ?.
*
* @param messageId the message ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching attachment, or null if a matching attachment could not be found
*/
public Attachment fetchByMessageId_Last(
long messageId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns the attachments before and after the current attachment in the ordered set where messageId = ?.
*
* @param attachmentId the primary key of the current attachment
* @param messageId the message ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next attachment
* @throws NoSuchAttachmentException if a attachment with the primary key could not be found
*/
public Attachment[] findByMessageId_PrevAndNext(
long attachmentId, long messageId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchAttachmentException;
/**
* Removes all the attachments where messageId = ? from the database.
*
* @param messageId the message ID
*/
public void removeByMessageId(long messageId);
/**
* Returns the number of attachments where messageId = ?.
*
* @param messageId the message ID
* @return the number of matching attachments
*/
public int countByMessageId(long messageId);
/**
* Caches the attachment in the entity cache if it is enabled.
*
* @param attachment the attachment
*/
public void cacheResult(Attachment attachment);
/**
* Caches the attachments in the entity cache if it is enabled.
*
* @param attachments the attachments
*/
public void cacheResult(java.util.List attachments);
/**
* Creates a new attachment with the primary key. Does not add the attachment to the database.
*
* @param attachmentId the primary key for the new attachment
* @return the new attachment
*/
public Attachment create(long attachmentId);
/**
* Removes the attachment with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param attachmentId the primary key of the attachment
* @return the attachment that was removed
* @throws NoSuchAttachmentException if a attachment with the primary key could not be found
*/
public Attachment remove(long attachmentId)
throws NoSuchAttachmentException;
public Attachment updateImpl(Attachment attachment);
/**
* Returns the attachment with the primary key or throws a NoSuchAttachmentException if it could not be found.
*
* @param attachmentId the primary key of the attachment
* @return the attachment
* @throws NoSuchAttachmentException if a attachment with the primary key could not be found
*/
public Attachment findByPrimaryKey(long attachmentId)
throws NoSuchAttachmentException;
/**
* Returns the attachment with the primary key or returns null if it could not be found.
*
* @param attachmentId the primary key of the attachment
* @return the attachment, or null if a attachment with the primary key could not be found
*/
public Attachment fetchByPrimaryKey(long attachmentId);
/**
* Returns all the attachments.
*
* @return the attachments
*/
public java.util.List findAll();
/**
* 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 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 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.
*
*
* @param start the lower bound of the range of attachments
* @param end the upper bound of the range of attachments (not inclusive)
* @return the range of attachments
*/
public java.util.List findAll(int start, int end);
/**
* Returns an ordered 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 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 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.
*
*
* @param start the lower bound of the range of attachments
* @param end the upper bound of the range of attachments (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of attachments
*/
public java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns an ordered 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 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 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.
*
*
* @param start the lower bound of the range of attachments
* @param end the upper bound of the range of attachments (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param retrieveFromCache whether to retrieve from the finder cache
* @return the ordered range of attachments
*/
public java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
boolean retrieveFromCache);
/**
* Removes all the attachments from the database.
*/
public void removeAll();
/**
* Returns the number of attachments.
*
* @return the number of attachments
*/
public int countAll();
@Override
public Set getBadColumnNames();
}