com.liferay.contacts.service.persistence

Interface EntryPersistence

All Superinterfaces:

com.liferay.portal.kernel.service.persistence.BasePersistence<Entry>

@ProviderType
public interface EntryPersistence
extends com.liferay.portal.kernel.service.persistence.BasePersistence<Entry>

The persistence interface for the entry service.

Caching information and settings can be found in portal.properties

See Also:

com.liferay.contacts.service.persistence.impl.EntryPersistenceImpl, EntryUtil

Generated:

Method Summary

Modifier and Type	Method and Description
void	cacheResult(Entry entry) Caches the entry in the entity cache if it is enabled.
void	cacheResult(java.util.List<Entry> entries) Caches the entries in the entity cache if it is enabled.
int	countAll() Returns the number of entries.
int	countByU_EA(long userId, java.lang.String emailAddress) Returns the number of entries where userId = ? and emailAddress = ?.
int	countByUserId(long userId) Returns the number of entries where userId = ?.
Entry	create(long entryId) Creates a new entry with the primary key.
Entry	fetchByPrimaryKey(long entryId) Returns the entry with the primary key or returns null if it could not be found.
java.util.Map<java.io.Serializable,Entry>	fetchByPrimaryKeys(java.util.Set<java.io.Serializable> primaryKeys)
Entry	fetchByU_EA(long userId, java.lang.String emailAddress) Returns the entry where userId = ? and emailAddress = ? or returns null if it could not be found.
Entry	fetchByU_EA(long userId, java.lang.String emailAddress, boolean retrieveFromCache) Returns the entry where userId = ? and emailAddress = ? or returns null if it could not be found, optionally using the finder cache.
Entry	fetchByUserId_First(long userId, com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator) Returns the first entry in the ordered set where userId = ?.
Entry	fetchByUserId_Last(long userId, com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator) Returns the last entry in the ordered set where userId = ?.
java.util.List<Entry>	findAll() Returns all the entries.
java.util.List<Entry>	findAll(int start, int end) Returns a range of all the entries.
java.util.List<Entry>	findAll(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator) Returns an ordered range of all the entries.
java.util.List<Entry>	findAll(int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator, boolean retrieveFromCache) Returns an ordered range of all the entries.
Entry	findByPrimaryKey(long entryId) Returns the entry with the primary key or throws a NoSuchEntryException if it could not be found.
Entry	findByU_EA(long userId, java.lang.String emailAddress) Returns the entry where userId = ? and emailAddress = ? or throws a NoSuchEntryException if it could not be found.
Entry	findByUserId_First(long userId, com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator) Returns the first entry in the ordered set where userId = ?.
Entry	findByUserId_Last(long userId, com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator) Returns the last entry in the ordered set where userId = ?.
Entry[]	findByUserId_PrevAndNext(long entryId, long userId, com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator) Returns the entries before and after the current entry in the ordered set where userId = ?.
java.util.List<Entry>	findByUserId(long userId) Returns all the entries where userId = ?.
java.util.List<Entry>	findByUserId(long userId, int start, int end) Returns a range of all the entries where userId = ?.
java.util.List<Entry>	findByUserId(long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator) Returns an ordered range of all the entries where userId = ?.
java.util.List<Entry>	findByUserId(long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator, boolean retrieveFromCache) Returns an ordered range of all the entries where userId = ?.
Entry	remove(long entryId) Removes the entry with the primary key from the database.
void	removeAll() Removes all the entries from the database.
Entry	removeByU_EA(long userId, java.lang.String emailAddress) Removes the entry where userId = ? and emailAddress = ? from the database.
void	removeByUserId(long userId) Removes all the entries where userId = ? from the database.
Entry	updateImpl(Entry entry)

Methods inherited from interface com.liferay.portal.kernel.service.persistence.BasePersistence

clearCache, clearCache, clearCache, closeSession, countWithDynamicQuery, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, flush, getBadColumnNames, getCurrentSession, getDataSource, getListeners, getModelClass, openSession, processException, registerListener, remove, remove, setDataSource, unregisterListener, update, update

Method Detail

findByUserId

java.util.List<Entry> findByUserId(long userId)

Returns all the entries where userId = ?.

Parameters:

userId - the user ID

Returns:

the matching entries

findByUserId

java.util.List<Entry> findByUserId(long userId,
                                   int start,
                                   int end)

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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from EntryModelImpl. 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.

Parameters:

userId - the user ID

start - the lower bound of the range of entries

end - the upper bound of the range of entries (not inclusive)

Returns:

the range of matching entries

findByUserId

java.util.List<Entry> findByUserId(long userId,
                                   int start,
                                   int end,
                                   com.liferay.portal.kernel.util.OrderByComparator<Entry> 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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from EntryModelImpl. 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.

Parameters:

userId - the user ID

start - the lower bound of the range of entries

end - the upper bound of the range of entries (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching entries

findByUserId

java.util.List<Entry> findByUserId(long userId,
                                   int start,
                                   int end,
                                   com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator,
                                   boolean retrieveFromCache)

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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from EntryModelImpl. 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.

Parameters:

userId - the user ID

start - the lower bound of the range of entries

end - the upper bound of the range of entries (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the ordered range of matching entries

findByUserId_First

Entry findByUserId_First(long userId,
                         com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator)
                  throws NoSuchEntryException

Returns the first entry in the ordered set where userId = ?.

Parameters:

userId - the user ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching entry

Throws:

NoSuchEntryException - if a matching entry could not be found

fetchByUserId_First

Entry fetchByUserId_First(long userId,
                          com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator)

Returns the first entry in the ordered set where userId = ?.

Parameters:

userId - the user ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching entry, or null if a matching entry could not be found

findByUserId_Last

Entry findByUserId_Last(long userId,
                        com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator)
                 throws NoSuchEntryException

Returns the last entry in the ordered set where userId = ?.

Parameters:

userId - the user ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching entry

Throws:

NoSuchEntryException - if a matching entry could not be found

fetchByUserId_Last

Entry fetchByUserId_Last(long userId,
                         com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator)

Returns the last entry in the ordered set where userId = ?.

Parameters:

userId - the user ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching entry, or null if a matching entry could not be found

findByUserId_PrevAndNext

Entry[] findByUserId_PrevAndNext(long entryId,
                                 long userId,
                                 com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator)
                          throws NoSuchEntryException

Returns the entries before and after the current entry in the ordered set where userId = ?.

Parameters:

entryId - the primary key of the current entry

userId - the user ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the previous, current, and next entry

Throws:

NoSuchEntryException - if a entry with the primary key could not be found

removeByUserId

void removeByUserId(long userId)

Removes all the entries where userId = ? from the database.

Parameters:

userId - the user ID

countByUserId

int countByUserId(long userId)

Returns the number of entries where userId = ?.

Parameters:

userId - the user ID

Returns:

the number of matching entries

findByU_EA

Entry findByU_EA(long userId,
                 java.lang.String emailAddress)
          throws NoSuchEntryException

Returns the entry where userId = ? and emailAddress = ? or throws a NoSuchEntryException if it could not be found.

Parameters:

userId - the user ID

emailAddress - the email address

Returns:

the matching entry

Throws:

NoSuchEntryException - if a matching entry could not be found

fetchByU_EA

Entry fetchByU_EA(long userId,
                  java.lang.String emailAddress)

Returns the entry where userId = ? and emailAddress = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

userId - the user ID

emailAddress - the email address

Returns:

the matching entry, or null if a matching entry could not be found

fetchByU_EA

Entry fetchByU_EA(long userId,
                  java.lang.String emailAddress,
                  boolean retrieveFromCache)

Returns the entry where userId = ? and emailAddress = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:

userId - the user ID

emailAddress - the email address

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the matching entry, or null if a matching entry could not be found

removeByU_EA

Entry removeByU_EA(long userId,
                   java.lang.String emailAddress)
            throws NoSuchEntryException

Removes the entry where userId = ? and emailAddress = ? from the database.

Parameters:

userId - the user ID

emailAddress - the email address

Returns:

the entry that was removed

Throws:

NoSuchEntryException

countByU_EA

int countByU_EA(long userId,
                java.lang.String emailAddress)

Returns the number of entries where userId = ? and emailAddress = ?.

Parameters:

userId - the user ID

emailAddress - the email address

Returns:

the number of matching entries

cacheResult

void cacheResult(Entry entry)

Caches the entry in the entity cache if it is enabled.

Parameters:

entry - the entry

cacheResult

void cacheResult(java.util.List<Entry> entries)

Caches the entries in the entity cache if it is enabled.

Parameters:

entries - the entries

create

Entry create(long entryId)

Creates a new entry with the primary key. Does not add the entry to the database.

Parameters:

entryId - the primary key for the new entry

Returns:

the new entry

remove

Entry remove(long entryId)
      throws NoSuchEntryException

Removes the entry with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

entryId - the primary key of the entry

Returns:

the entry that was removed

Throws:

NoSuchEntryException - if a entry with the primary key could not be found

updateImpl

Entry updateImpl(Entry entry)

findByPrimaryKey

Entry findByPrimaryKey(long entryId)
                throws NoSuchEntryException

Returns the entry with the primary key or throws a NoSuchEntryException if it could not be found.

Parameters:

entryId - the primary key of the entry

Returns:

the entry

Throws:

NoSuchEntryException - if a entry with the primary key could not be found

fetchByPrimaryKey

Entry fetchByPrimaryKey(long entryId)

Returns the entry with the primary key or returns null if it could not be found.

Parameters:

entryId - the primary key of the entry

Returns:

the entry, or null if a entry with the primary key could not be found

fetchByPrimaryKeys

java.util.Map<java.io.Serializable,Entry> fetchByPrimaryKeys(java.util.Set<java.io.Serializable> primaryKeys)

Specified by:

fetchByPrimaryKeys in interface com.liferay.portal.kernel.service.persistence.BasePersistence<Entry>

findAll

java.util.List<Entry> findAll()

Returns all the entries.

Returns:

the entries

findAll

java.util.List<Entry> findAll(int start,
                              int end)

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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from EntryModelImpl. 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.

Parameters:

start - the lower bound of the range of entries

end - the upper bound of the range of entries (not inclusive)

Returns:

the range of entries

findAll

java.util.List<Entry> findAll(int start,
                              int end,
                              com.liferay.portal.kernel.util.OrderByComparator<Entry> 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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from EntryModelImpl. 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.

Parameters:

start - the lower bound of the range of entries

end - the upper bound of the range of entries (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of entries

findAll

java.util.List<Entry> findAll(int start,
                              int end,
                              com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator,
                              boolean retrieveFromCache)

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 and pagination is required (start and end are not QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from EntryModelImpl. 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.

Parameters:

start - the lower bound of the range of entries

end - the upper bound of the range of entries (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the ordered range of entries

removeAll

void removeAll()

Removes all the entries from the database.

countAll

int countAll()

Returns the number of entries.

Returns:

the number of entries