Liferay 6.2-ce-ga5

com.liferay.portal.service.persistence
Class PortalPreferencesUtil

java.lang.Object
  extended by com.liferay.portal.service.persistence.PortalPreferencesUtil

@ProviderType
public class PortalPreferencesUtil
extends Object

The persistence utility for the portal preferences service. This utility wraps PortalPreferencesPersistenceImpl and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.

Caching information and settings can be found in portal.properties

See Also:
PortalPreferencesPersistence, PortalPreferencesPersistenceImpl

Constructor Summary
PortalPreferencesUtil()
           
 
Method Summary
static void cacheResult(List<PortalPreferences> portalPreferenceses)
          Caches the portal preferenceses in the entity cache if it is enabled.
static void cacheResult(PortalPreferences portalPreferences)
          Caches the portal preferences in the entity cache if it is enabled.
static void clearCache()
           
static void clearCache(PortalPreferences portalPreferences)
           
static int countAll()
          Returns the number of portal preferenceses.
static int countByO_O(long ownerId, int ownerType)
          Returns the number of portal preferenceses where ownerId = ? and ownerType = ?.
static long countWithDynamicQuery(DynamicQuery dynamicQuery)
           
static PortalPreferences create(long portalPreferencesId)
          Creates a new portal preferences with the primary key.
static PortalPreferences fetchByO_O(long ownerId, int ownerType)
          Returns the portal preferences where ownerId = ? and ownerType = ? or returns null if it could not be found.
static 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.
static PortalPreferences fetchByPrimaryKey(long portalPreferencesId)
          Returns the portal preferences with the primary key or returns null if it could not be found.
static List<PortalPreferences> findAll()
          Returns all the portal preferenceses.
static List<PortalPreferences> findAll(int start, int end)
          Returns a range of all the portal preferenceses.
static List<PortalPreferences> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the portal preferenceses.
static 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.
static PortalPreferences findByPrimaryKey(long portalPreferencesId)
          Returns the portal preferences with the primary key or throws a NoSuchPreferencesException if it could not be found.
static List<PortalPreferences> findWithDynamicQuery(DynamicQuery dynamicQuery)
           
static List<PortalPreferences> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)
           
static List<PortalPreferences> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
           
static PortalPreferencesPersistence getPersistence()
           
static PortalPreferences remove(long portalPreferencesId)
          Removes the portal preferences with the primary key from the database.
static void removeAll()
          Removes all the portal preferenceses from the database.
static PortalPreferences removeByO_O(long ownerId, int ownerType)
          Removes the portal preferences where ownerId = ? and ownerType = ? from the database.
 void setPersistence(PortalPreferencesPersistence persistence)
          Deprecated. As of 6.2.0
static PortalPreferences update(PortalPreferences portalPreferences)
           
static PortalPreferences update(PortalPreferences portalPreferences, ServiceContext serviceContext)
           
static PortalPreferences updateImpl(PortalPreferences portalPreferences)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortalPreferencesUtil

public PortalPreferencesUtil()
Method Detail

clearCache

public static void clearCache()
See Also:
BasePersistence.clearCache()

clearCache

public static void clearCache(PortalPreferences portalPreferences)
See Also:
BasePersistence.clearCache(com.liferay.portal.model.BaseModel)

countWithDynamicQuery

public static long countWithDynamicQuery(DynamicQuery dynamicQuery)
                                  throws SystemException
Throws:
SystemException
See Also:
BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<PortalPreferences> findWithDynamicQuery(DynamicQuery dynamicQuery)
                                                    throws SystemException
Throws:
SystemException
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<PortalPreferences> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                           int start,
                                                           int end)
                                                    throws SystemException
Throws:
SystemException
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static List<PortalPreferences> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                           int start,
                                                           int end,
                                                           OrderByComparator orderByComparator)
                                                    throws SystemException
Throws:
SystemException
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static PortalPreferences update(PortalPreferences portalPreferences)
                                throws SystemException
Throws:
SystemException
See Also:
BasePersistence.update(com.liferay.portal.model.BaseModel)

update

public static PortalPreferences update(PortalPreferences portalPreferences,
                                       ServiceContext serviceContext)
                                throws SystemException
Throws:
SystemException
See Also:
BasePersistence.update(com.liferay.portal.model.BaseModel, ServiceContext)

findByO_O

public static PortalPreferences findByO_O(long ownerId,
                                          int ownerType)
                                   throws NoSuchPreferencesException,
                                          SystemException
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
SystemException - if a system exception occurred

fetchByO_O

public static PortalPreferences fetchByO_O(long ownerId,
                                           int ownerType)
                                    throws SystemException
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
Throws:
SystemException - if a system exception occurred

fetchByO_O

public static PortalPreferences fetchByO_O(long ownerId,
                                           int ownerType,
                                           boolean retrieveFromCache)
                                    throws SystemException
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 use the finder cache
Returns:
the matching portal preferences, or null if a matching portal preferences could not be found
Throws:
SystemException - if a system exception occurred

removeByO_O

public static PortalPreferences 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
ownerType - the owner type
Returns:
the portal preferences that was removed
Throws:
SystemException - if a system exception occurred
NoSuchPreferencesException

countByO_O

public static int countByO_O(long ownerId,
                             int ownerType)
                      throws SystemException
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
Throws:
SystemException - if a system exception occurred

cacheResult

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

Parameters:
portalPreferences - the portal preferences

cacheResult

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

Parameters:
portalPreferenceses - the portal preferenceses

create

public static 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

public static 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
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

public static PortalPreferences updateImpl(PortalPreferences portalPreferences)
                                    throws SystemException
Throws:
SystemException

findByPrimaryKey

public static PortalPreferences findByPrimaryKey(long portalPreferencesId)
                                          throws NoSuchPreferencesException,
                                                 SystemException
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
SystemException - if a system exception occurred

fetchByPrimaryKey

public static PortalPreferences fetchByPrimaryKey(long portalPreferencesId)
                                           throws SystemException
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
Throws:
SystemException - if a system exception occurred

findAll

public static List<PortalPreferences> findAll()
                                       throws SystemException
Returns all the portal preferenceses.

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

findAll

public static List<PortalPreferences> findAll(int start,
                                              int end)
                                       throws SystemException
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
Throws:
SystemException - if a system exception occurred

findAll

public static List<PortalPreferences> findAll(int start,
                                              int end,
                                              OrderByComparator orderByComparator)
                                       throws SystemException
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
Throws:
SystemException - if a system exception occurred

removeAll

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

Throws:
SystemException - if a system exception occurred

countAll

public static int countAll()
                    throws SystemException
Returns the number of portal preferenceses.

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

getPersistence

public static PortalPreferencesPersistence getPersistence()

setPersistence

public void setPersistence(PortalPreferencesPersistence persistence)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5