com.liferay.portal.kernel.service.persistence

Interface PortalPreferencesPersistence

All Superinterfaces:

BasePersistence<PortalPreferences>

@ProviderType
public interface PortalPreferencesPersistence
extends BasePersistence<PortalPreferences>

The persistence interface for the portal preferences service.

Caching information and settings can be found in portal.properties

Author:

Brian Wing Shun Chan

See Also:

PortalPreferencesPersistenceImpl, PortalPreferencesUtil

{$generated.description}

Method Summary

Modifier and Type	Method and Description
void	cacheResult(List<PortalPreferences> portalPreferenceses) Caches the portal preferenceses in the entity cache if it is enabled.
void	cacheResult(PortalPreferences portalPreferences) Caches the portal preferences in the entity cache if it is enabled.
int	countAll() Returns the number of portal preferenceses.
int	countByO_O(long ownerId, int ownerType) Returns the number of portal preferenceses where ownerId = ? and ownerType = ?.
PortalPreferences	create(long portalPreferencesId) Creates a new portal preferences with the primary key.
PortalPreferences	fetchByO_O(long ownerId, int ownerType) Returns the portal preferences where ownerId = ? and ownerType = ? or returns null if it could not be found.
PortalPreferences	fetchByO_O(long ownerId, int ownerType, boolean retrieveFromCache) Returns the portal preferences where ownerId = ? and ownerType = ? or returns null if it could not be found, optionally using the finder cache.
PortalPreferences	fetchByPrimaryKey(long portalPreferencesId) Returns the portal preferences with the primary key or returns null if it could not be found.
Map<Serializable,PortalPreferences>	fetchByPrimaryKeys(Set<Serializable> primaryKeys)
List<PortalPreferences>	findAll() Returns all the portal preferenceses.
List<PortalPreferences>	findAll(int start, int end) Returns a range of all the portal preferenceses.
List<PortalPreferences>	findAll(int start, int end, OrderByComparator<PortalPreferences> orderByComparator) Returns an ordered range of all the portal preferenceses.
List<PortalPreferences>	findAll(int start, int end, OrderByComparator<PortalPreferences> orderByComparator, boolean retrieveFromCache) Returns an ordered range of all the portal preferenceses.
PortalPreferences	findByO_O(long ownerId, int ownerType) Returns the portal preferences where ownerId = ? and ownerType = ? or throws a NoSuchPreferencesException if it could not be found.
PortalPreferences	findByPrimaryKey(long portalPreferencesId) Returns the portal preferences with the primary key or throws a NoSuchPreferencesException if it could not be found.
PortalPreferences	remove(long portalPreferencesId) Removes the portal preferences with the primary key from the database.
void	removeAll() Removes all the portal preferenceses from the database.
PortalPreferences	removeByO_O(long ownerId, int ownerType) Removes the portal preferences where ownerId = ? and ownerType = ? from the database.
PortalPreferences	updateImpl(PortalPreferences portalPreferences)

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

findByO_O

PortalPreferences findByO_O(long ownerId,
                            int ownerType)
                     throws NoSuchPreferencesException

Returns the portal preferences where ownerId = ? and ownerType = ? or throws a NoSuchPreferencesException if it could not be found.

Parameters:

ownerId - the owner ID

ownerType - the owner type

Returns:

the matching portal preferences

Throws:

NoSuchPreferencesException - if a matching portal preferences could not be found

fetchByO_O

PortalPreferences fetchByO_O(long ownerId,
                             int ownerType)

Returns the portal preferences where ownerId = ? and ownerType = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

ownerId - the owner ID

ownerType - the owner type

Returns:

the matching portal preferences, or null if a matching portal preferences could not be found

fetchByO_O

PortalPreferences fetchByO_O(long ownerId,
                             int ownerType,
                             boolean retrieveFromCache)

Returns the portal preferences where ownerId = ? and ownerType = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:

ownerId - the owner ID

ownerType - the owner type

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the matching portal preferences, or null if a matching portal preferences could not be found

removeByO_O

PortalPreferences removeByO_O(long ownerId,
                              int ownerType)
                       throws NoSuchPreferencesException

Removes the portal preferences where ownerId = ? and ownerType = ? from the database.

Parameters:

ownerId - the owner ID

ownerType - the owner type

Returns:

the portal preferences that was removed

Throws:

NoSuchPreferencesException

countByO_O

int countByO_O(long ownerId,
               int ownerType)

Returns the number of portal preferenceses where ownerId = ? and ownerType = ?.

Parameters:

ownerId - the owner ID

ownerType - the owner type

Returns:

the number of matching portal preferenceses

cacheResult

void cacheResult(PortalPreferences portalPreferences)

Caches the portal preferences in the entity cache if it is enabled.

Parameters:

portalPreferences - the portal preferences

cacheResult

void cacheResult(List<PortalPreferences> portalPreferenceses)

Caches the portal preferenceses in the entity cache if it is enabled.

Parameters:

portalPreferenceses - the portal preferenceses

create

PortalPreferences create(long portalPreferencesId)

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

Parameters:

portalPreferencesId - the primary key for the new portal preferences

Returns:

the new portal preferences

remove

PortalPreferences remove(long portalPreferencesId)
                  throws NoSuchPreferencesException

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

Parameters:

portalPreferencesId - the primary key of the portal preferences

Returns:

the portal preferences that was removed

Throws:

NoSuchPreferencesException - if a portal preferences with the primary key could not be found

updateImpl

PortalPreferences updateImpl(PortalPreferences portalPreferences)

findByPrimaryKey

PortalPreferences findByPrimaryKey(long portalPreferencesId)
                            throws NoSuchPreferencesException

Returns the portal preferences with the primary key or throws a NoSuchPreferencesException if it could not be found.

Parameters:

portalPreferencesId - the primary key of the portal preferences

Returns:

the portal preferences

Throws:

NoSuchPreferencesException - if a portal preferences with the primary key could not be found

fetchByPrimaryKey

PortalPreferences fetchByPrimaryKey(long portalPreferencesId)

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

Parameters:

portalPreferencesId - the primary key of the portal preferences

Returns:

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

fetchByPrimaryKeys

Map<Serializable,PortalPreferences> fetchByPrimaryKeys(Set<Serializable> primaryKeys)

Specified by:

fetchByPrimaryKeys in interface BasePersistence<PortalPreferences>

findAll

List<PortalPreferences> findAll()

Returns all the portal preferenceses.

Returns:

the portal preferenceses

findAll

List<PortalPreferences> findAll(int start,
                                int end)

Returns a range of all the portal preferenceses.

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 PortalPreferencesModelImpl. 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 portal preferenceses

end - the upper bound of the range of portal preferenceses (not inclusive)

Returns:

the range of portal preferenceses

findAll

List<PortalPreferences> findAll(int start,
                                int end,
                                OrderByComparator<PortalPreferences> orderByComparator)

Returns an ordered range of all the portal preferenceses.

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 PortalPreferencesModelImpl. 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 portal preferenceses

end - the upper bound of the range of portal preferenceses (not inclusive)

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

Returns:

the ordered range of portal preferenceses

findAll

List<PortalPreferences> findAll(int start,
                                int end,
                                OrderByComparator<PortalPreferences> orderByComparator,
                                boolean retrieveFromCache)

Returns an ordered range of all the portal preferenceses.

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 PortalPreferencesModelImpl. 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 portal preferenceses

end - the upper bound of the range of portal preferenceses (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 portal preferenceses

removeAll

void removeAll()

Removes all the portal preferenceses from the database.

countAll

int countAll()

Returns the number of portal preferenceses.

Returns:

the number of portal preferenceses