com.liferay.change.tracking.service.persistence.CTMessagePersistence Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.change.tracking.service.persistence;
import com.liferay.change.tracking.exception.NoSuchMessageException;
import com.liferay.change.tracking.model.CTMessage;
import com.liferay.portal.kernel.service.persistence.BasePersistence;
import org.osgi.annotation.versioning.ProviderType;
/**
* The persistence interface for the ct message service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see CTMessageUtil
* @generated
*/
@ProviderType
public interface CTMessagePersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link CTMessageUtil} to access the ct message persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Returns all the ct messages where ctCollectionId = ?.
*
* @param ctCollectionId the ct collection ID
* @return the matching ct messages
*/
public java.util.List findByCtCollectionId(long ctCollectionId);
/**
* Returns a range of all the ct messages where ctCollectionId = ?.
*
*
* 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, then the query will include the default ORDER BY logic from CTMessageModelImpl.
*
*
* @param ctCollectionId the ct collection ID
* @param start the lower bound of the range of ct messages
* @param end the upper bound of the range of ct messages (not inclusive)
* @return the range of matching ct messages
*/
public java.util.List findByCtCollectionId(
long ctCollectionId, int start, int end);
/**
* Returns an ordered range of all the ct messages where ctCollectionId = ?.
*
*
* 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, then the query will include the default ORDER BY logic from CTMessageModelImpl.
*
*
* @param ctCollectionId the ct collection ID
* @param start the lower bound of the range of ct messages
* @param end the upper bound of the range of ct messages (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching ct messages
*/
public java.util.List findByCtCollectionId(
long ctCollectionId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns an ordered range of all the ct messages where ctCollectionId = ?.
*
*
* 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, then the query will include the default ORDER BY logic from CTMessageModelImpl.
*
*
* @param ctCollectionId the ct collection ID
* @param start the lower bound of the range of ct messages
* @param end the upper bound of the range of ct messages (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param useFinderCache whether to use the finder cache
* @return the ordered range of matching ct messages
*/
public java.util.List findByCtCollectionId(
long ctCollectionId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
boolean useFinderCache);
/**
* Returns the first ct message in the ordered set where ctCollectionId = ?.
*
* @param ctCollectionId the ct collection ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching ct message
* @throws NoSuchMessageException if a matching ct message could not be found
*/
public CTMessage findByCtCollectionId_First(
long ctCollectionId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchMessageException;
/**
* Returns the first ct message in the ordered set where ctCollectionId = ?.
*
* @param ctCollectionId the ct collection ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching ct message, or null if a matching ct message could not be found
*/
public CTMessage fetchByCtCollectionId_First(
long ctCollectionId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns the last ct message in the ordered set where ctCollectionId = ?.
*
* @param ctCollectionId the ct collection ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching ct message
* @throws NoSuchMessageException if a matching ct message could not be found
*/
public CTMessage findByCtCollectionId_Last(
long ctCollectionId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchMessageException;
/**
* Returns the last ct message in the ordered set where ctCollectionId = ?.
*
* @param ctCollectionId the ct collection ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching ct message, or null if a matching ct message could not be found
*/
public CTMessage fetchByCtCollectionId_Last(
long ctCollectionId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns the ct messages before and after the current ct message in the ordered set where ctCollectionId = ?.
*
* @param ctMessageId the primary key of the current ct message
* @param ctCollectionId the ct collection ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next ct message
* @throws NoSuchMessageException if a ct message with the primary key could not be found
*/
public CTMessage[] findByCtCollectionId_PrevAndNext(
long ctMessageId, long ctCollectionId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchMessageException;
/**
* Removes all the ct messages where ctCollectionId = ? from the database.
*
* @param ctCollectionId the ct collection ID
*/
public void removeByCtCollectionId(long ctCollectionId);
/**
* Returns the number of ct messages where ctCollectionId = ?.
*
* @param ctCollectionId the ct collection ID
* @return the number of matching ct messages
*/
public int countByCtCollectionId(long ctCollectionId);
/**
* Caches the ct message in the entity cache if it is enabled.
*
* @param ctMessage the ct message
*/
public void cacheResult(CTMessage ctMessage);
/**
* Caches the ct messages in the entity cache if it is enabled.
*
* @param ctMessages the ct messages
*/
public void cacheResult(java.util.List ctMessages);
/**
* Creates a new ct message with the primary key. Does not add the ct message to the database.
*
* @param ctMessageId the primary key for the new ct message
* @return the new ct message
*/
public CTMessage create(long ctMessageId);
/**
* Removes the ct message with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param ctMessageId the primary key of the ct message
* @return the ct message that was removed
* @throws NoSuchMessageException if a ct message with the primary key could not be found
*/
public CTMessage remove(long ctMessageId) throws NoSuchMessageException;
public CTMessage updateImpl(CTMessage ctMessage);
/**
* Returns the ct message with the primary key or throws a NoSuchMessageException if it could not be found.
*
* @param ctMessageId the primary key of the ct message
* @return the ct message
* @throws NoSuchMessageException if a ct message with the primary key could not be found
*/
public CTMessage findByPrimaryKey(long ctMessageId)
throws NoSuchMessageException;
/**
* Returns the ct message with the primary key or returns null if it could not be found.
*
* @param ctMessageId the primary key of the ct message
* @return the ct message, or null if a ct message with the primary key could not be found
*/
public CTMessage fetchByPrimaryKey(long ctMessageId);
/**
* Returns all the ct messages.
*
* @return the ct messages
*/
public java.util.List findAll();
/**
* Returns a range of all the ct messages.
*
*
* 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, then the query will include the default ORDER BY logic from CTMessageModelImpl.
*
*
* @param start the lower bound of the range of ct messages
* @param end the upper bound of the range of ct messages (not inclusive)
* @return the range of ct messages
*/
public java.util.List findAll(int start, int end);
/**
* Returns an ordered range of all the ct messages.
*
*
* 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, then the query will include the default ORDER BY logic from CTMessageModelImpl.
*
*
* @param start the lower bound of the range of ct messages
* @param end the upper bound of the range of ct messages (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of ct messages
*/
public java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns an ordered range of all the ct messages.
*
*
* 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, then the query will include the default ORDER BY logic from CTMessageModelImpl.
*
*
* @param start the lower bound of the range of ct messages
* @param end the upper bound of the range of ct messages (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @param useFinderCache whether to use the finder cache
* @return the ordered range of ct messages
*/
public java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
boolean useFinderCache);
/**
* Removes all the ct messages from the database.
*/
public void removeAll();
/**
* Returns the number of ct messages.
*
* @return the number of ct messages
*/
public int countAll();
}