Liferay 6.0-ee-sp2

com.liferay.portal.service.persistence
Interface PortalPreferencesPersistence

All Superinterfaces:
BasePersistence<PortalPreferences>

public interface PortalPreferencesPersistence
extends BasePersistence<PortalPreferences>

The persistence interface for the portal preferences service.

Caching information and settings can be found in portal.properties

See Also:
PortalPreferencesPersistenceImpl, PortalPreferencesUtil

Method Summary
 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()
          Counts all the portal preferenceses.
 int countByO_O(long ownerId, int ownerType)
          Counts all the 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)
          Finds 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)
          Finds 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)
          Finds the portal preferences with the primary key or returns null if it could not be found.
 List<PortalPreferences> findAll()
          Finds all the portal preferenceses.
 List<PortalPreferences> findAll(int start, int end)
          Finds a range of all the portal preferenceses.
 List<PortalPreferences> findAll(int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the portal preferenceses.
 PortalPreferences findByO_O(long ownerId, int ownerType)
          Finds the portal preferences where ownerId = ? and ownerType = ? or throws a NoSuchPreferencesException if it could not be found.
 PortalPreferences findByPrimaryKey(long portalPreferencesId)
          Finds 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.
 PortalPreferences remove(PortalPreferences portalPreferences)
          Removes the model instance from the database.
 void removeAll()
          Removes all the portal preferenceses from the database.
 void removeByO_O(long ownerId, int ownerType)
          Removes the portal preferences where ownerId = ? and ownerType = ? from the database.
 PortalPreferences updateImpl(PortalPreferences portalPreferences, boolean merge)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, closeSession, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, openSession, processException, registerListener, remove, setDataSource, unregisterListener, update, update
 

Method Detail

cacheResult

void cacheResult(PortalPreferences portalPreferences)
Caches the portal preferences in the entity cache if it is enabled.

Parameters:
portalPreferences - the portal preferences to cache

cacheResult

void cacheResult(List<PortalPreferences> portalPreferenceses)
Caches the portal preferenceses in the entity cache if it is enabled.

Parameters:
portalPreferenceses - the portal preferenceses to cache

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,
                                SystemException
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 to remove
Returns:
the portal preferences that was removed
Throws:
NoSuchPreferencesException - if a portal preferences with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

PortalPreferences updateImpl(PortalPreferences portalPreferences,
                             boolean merge)
                             throws SystemException
Throws:
SystemException

findByPrimaryKey

PortalPreferences findByPrimaryKey(long portalPreferencesId)
                                   throws NoSuchPreferencesException,
                                          SystemException
Finds 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 to find
Returns:
the portal preferences
Throws:
NoSuchPreferencesException - if a portal preferences with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

PortalPreferences fetchByPrimaryKey(long portalPreferencesId)
                                    throws SystemException
Finds 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 to find
Returns:
the portal preferences, or null if a portal preferences with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findByO_O

PortalPreferences findByO_O(long ownerId,
                            int ownerType)
                            throws NoSuchPreferencesException,
                                   SystemException
Finds the portal preferences where ownerId = ? and ownerType = ? or throws a NoSuchPreferencesException if it could not be found.

Parameters:
ownerId - the owner ID to search with
ownerType - the owner type to search with
Returns:
the matching portal preferences
Throws:
NoSuchPreferencesException - if a matching portal preferences could not be found
SystemException - if a system exception occurred

fetchByO_O

PortalPreferences fetchByO_O(long ownerId,
                             int ownerType)
                             throws SystemException
Finds 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 to search with
ownerType - the owner type to search with
Returns:
the matching portal preferences, or null if a matching portal preferences could not be found
Throws:
SystemException - if a system exception occurred

fetchByO_O

PortalPreferences fetchByO_O(long ownerId,
                             int ownerType,
                             boolean retrieveFromCache)
                             throws SystemException
Finds 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 to search with
ownerType - the owner type to search with
Returns:
the matching portal preferences, or null if a matching portal preferences could not be found
Throws:
SystemException - if a system exception occurred

findAll

List<PortalPreferences> findAll()
                                throws SystemException
Finds all the portal preferenceses.

Returns:
the portal preferenceses
Throws:
SystemException - if a system exception occurred

findAll

List<PortalPreferences> findAll(int start,
                                int end)
                                throws SystemException
Finds 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.

Parameters:
start - the lower bound of the range of portal preferenceses to return
end - the upper bound of the range of portal preferenceses to return (not inclusive)
Returns:
the range of portal preferenceses
Throws:
SystemException - if a system exception occurred

findAll

List<PortalPreferences> findAll(int start,
                                int end,
                                OrderByComparator orderByComparator)
                                throws SystemException
Finds 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.

Parameters:
start - the lower bound of the range of portal preferenceses to return
end - the upper bound of the range of portal preferenceses to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of portal preferenceses
Throws:
SystemException - if a system exception occurred

removeByO_O

void removeByO_O(long ownerId,
                 int ownerType)
                 throws NoSuchPreferencesException,
                        SystemException
Removes the portal preferences where ownerId = ? and ownerType = ? from the database.

Parameters:
ownerId - the owner ID to search with
ownerType - the owner type to search with
Throws:
SystemException - if a system exception occurred
NoSuchPreferencesException

removeAll

void removeAll()
               throws SystemException
Removes all the portal preferenceses from the database.

Throws:
SystemException - if a system exception occurred

countByO_O

int countByO_O(long ownerId,
               int ownerType)
               throws SystemException
Counts all the portal preferenceses where ownerId = ? and ownerType = ?.

Parameters:
ownerId - the owner ID to search with
ownerType - the owner type to search with
Returns:
the number of matching portal preferenceses
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Counts all the portal preferenceses.

Returns:
the number of portal preferenceses
Throws:
SystemException - if a system exception occurred

remove

PortalPreferences remove(PortalPreferences portalPreferences)
                         throws SystemException
Description copied from interface: BasePersistence
Removes the model instance from the database. Also notifies the appropriate model listeners.

Specified by:
remove in interface BasePersistence<PortalPreferences>
Parameters:
portalPreferences - the model instance to remove
Returns:
the model instance that was removed
Throws:
SystemException - if a system exception occurred

Liferay 6.0-ee-sp2