com.liferay.contacts.service.persistence.EntryPersistence 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.contacts.service.persistence;
import com.liferay.contacts.exception.NoSuchEntryException;
import com.liferay.contacts.model.Entry;
import com.liferay.portal.kernel.service.persistence.BasePersistence;
import org.osgi.annotation.versioning.ProviderType;
/**
* The persistence interface for the entry service.
*
*
* Caching information and settings can be found in portal.properties
*
*
* @author Brian Wing Shun Chan
* @see EntryUtil
* @generated
*/
@ProviderType
public interface EntryPersistence extends BasePersistence {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link EntryUtil} to access the entry persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.
*/
/**
* Returns all the entries where userId = ?.
*
* @param userId the user ID
* @return the matching entries
*/
public java.util.List findByUserId(long userId);
/**
* Returns a range of all the entries where userId = ?.
*
*
* 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 EntryModelImpl.
*
*
* @param userId the user ID
* @param start the lower bound of the range of entries
* @param end the upper bound of the range of entries (not inclusive)
* @return the range of matching entries
*/
public java.util.List findByUserId(long userId, int start, int end);
/**
* Returns an ordered range of all the entries where userId = ?.
*
*
* 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 EntryModelImpl.
*
*
* @param userId the user ID
* @param start the lower bound of the range of entries
* @param end the upper bound of the range of entries (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching entries
*/
public java.util.List findByUserId(
long userId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns an ordered range of all the entries where userId = ?.
*
*
* 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 EntryModelImpl.
*
*
* @param userId the user ID
* @param start the lower bound of the range of entries
* @param end the upper bound of the range of entries (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 entries
*/
public java.util.List findByUserId(
long userId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
boolean useFinderCache);
/**
* Returns the first entry in the ordered set where userId = ?.
*
* @param userId the user ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching entry
* @throws NoSuchEntryException if a matching entry could not be found
*/
public Entry findByUserId_First(
long userId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchEntryException;
/**
* Returns the first entry in the ordered set where userId = ?.
*
* @param userId the user ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the first matching entry, or null if a matching entry could not be found
*/
public Entry fetchByUserId_First(
long userId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns the last entry in the ordered set where userId = ?.
*
* @param userId the user ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching entry
* @throws NoSuchEntryException if a matching entry could not be found
*/
public Entry findByUserId_Last(
long userId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchEntryException;
/**
* Returns the last entry in the ordered set where userId = ?.
*
* @param userId the user ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the last matching entry, or null if a matching entry could not be found
*/
public Entry fetchByUserId_Last(
long userId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns the entries before and after the current entry in the ordered set where userId = ?.
*
* @param entryId the primary key of the current entry
* @param userId the user ID
* @param orderByComparator the comparator to order the set by (optionally null)
* @return the previous, current, and next entry
* @throws NoSuchEntryException if a entry with the primary key could not be found
*/
public Entry[] findByUserId_PrevAndNext(
long entryId, long userId,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator)
throws NoSuchEntryException;
/**
* Removes all the entries where userId = ? from the database.
*
* @param userId the user ID
*/
public void removeByUserId(long userId);
/**
* Returns the number of entries where userId = ?.
*
* @param userId the user ID
* @return the number of matching entries
*/
public int countByUserId(long userId);
/**
* Returns the entry where userId = ? and emailAddress = ? or throws a NoSuchEntryException if it could not be found.
*
* @param userId the user ID
* @param emailAddress the email address
* @return the matching entry
* @throws NoSuchEntryException if a matching entry could not be found
*/
public Entry findByU_EA(long userId, String emailAddress)
throws NoSuchEntryException;
/**
* Returns the entry where userId = ? and emailAddress = ? or returns null if it could not be found. Uses the finder cache.
*
* @param userId the user ID
* @param emailAddress the email address
* @return the matching entry, or null if a matching entry could not be found
*/
public Entry fetchByU_EA(long userId, String emailAddress);
/**
* Returns the entry where userId = ? and emailAddress = ? or returns null if it could not be found, optionally using the finder cache.
*
* @param userId the user ID
* @param emailAddress the email address
* @param useFinderCache whether to use the finder cache
* @return the matching entry, or null if a matching entry could not be found
*/
public Entry fetchByU_EA(
long userId, String emailAddress, boolean useFinderCache);
/**
* Removes the entry where userId = ? and emailAddress = ? from the database.
*
* @param userId the user ID
* @param emailAddress the email address
* @return the entry that was removed
*/
public Entry removeByU_EA(long userId, String emailAddress)
throws NoSuchEntryException;
/**
* Returns the number of entries where userId = ? and emailAddress = ?.
*
* @param userId the user ID
* @param emailAddress the email address
* @return the number of matching entries
*/
public int countByU_EA(long userId, String emailAddress);
/**
* Caches the entry in the entity cache if it is enabled.
*
* @param entry the entry
*/
public void cacheResult(Entry entry);
/**
* Caches the entries in the entity cache if it is enabled.
*
* @param entries the entries
*/
public void cacheResult(java.util.List entries);
/**
* Creates a new entry with the primary key. Does not add the entry to the database.
*
* @param entryId the primary key for the new entry
* @return the new entry
*/
public Entry create(long entryId);
/**
* Removes the entry with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param entryId the primary key of the entry
* @return the entry that was removed
* @throws NoSuchEntryException if a entry with the primary key could not be found
*/
public Entry remove(long entryId) throws NoSuchEntryException;
public Entry updateImpl(Entry entry);
/**
* Returns the entry with the primary key or throws a NoSuchEntryException if it could not be found.
*
* @param entryId the primary key of the entry
* @return the entry
* @throws NoSuchEntryException if a entry with the primary key could not be found
*/
public Entry findByPrimaryKey(long entryId) throws NoSuchEntryException;
/**
* Returns the entry with the primary key or returns null if it could not be found.
*
* @param entryId the primary key of the entry
* @return the entry, or null if a entry with the primary key could not be found
*/
public Entry fetchByPrimaryKey(long entryId);
/**
* Returns all the entries.
*
* @return the entries
*/
public java.util.List findAll();
/**
* Returns a range of all the entries.
*
*
* 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 EntryModelImpl.
*
*
* @param start the lower bound of the range of entries
* @param end the upper bound of the range of entries (not inclusive)
* @return the range of entries
*/
public java.util.List findAll(int start, int end);
/**
* Returns an ordered range of all the entries.
*
*
* 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 EntryModelImpl.
*
*
* @param start the lower bound of the range of entries
* @param end the upper bound of the range of entries (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of entries
*/
public java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator);
/**
* Returns an ordered range of all the entries.
*
*
* 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 EntryModelImpl.
*
*
* @param start the lower bound of the range of entries
* @param end the upper bound of the range of entries (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 entries
*/
public java.util.List findAll(
int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator,
boolean useFinderCache);
/**
* Removes all the entries from the database.
*/
public void removeAll();
/**
* Returns the number of entries.
*
* @return the number of entries
*/
public int countAll();
}