Class PortalPreferencesUtil
com.liferay.portal.service.persistence.impl.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
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidcacheResult(PortalPreferences portalPreferences) Caches the portal preferences in the entity cache if it is enabled.static voidcacheResult(List<PortalPreferences> portalPreferenceses) Caches the portal preferenceses in the entity cache if it is enabled.static voidstatic voidclearCache(PortalPreferences portalPreferences) static intcountAll()Returns the number of portal preferenceses.static intcountByO_O(long ownerId, int ownerType) Returns the number of portal preferenceses where ownerId = ? and ownerType = ?.static intcountByOwnerType(int ownerType) Returns the number of portal preferenceses where ownerType = ?.static longcountWithDynamicQuery(DynamicQuery dynamicQuery) static PortalPreferencescreate(long portalPreferencesId) Creates a new portal preferences with the primary key.static PortalPreferencesfetchByO_O(long ownerId, int ownerType) Returns the portal preferences where ownerId = ? and ownerType = ? or returnsnullif it could not be found.static PortalPreferencesfetchByO_O(long ownerId, int ownerType, boolean useFinderCache) Returns the portal preferences where ownerId = ? and ownerType = ? or returnsnullif it could not be found, optionally using the finder cache.static PortalPreferencesfetchByOwnerType_First(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) Returns the first portal preferences in the ordered set where ownerType = ?.static PortalPreferencesfetchByOwnerType_Last(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) Returns the last portal preferences in the ordered set where ownerType = ?.static PortalPreferencesfetchByPrimaryKey(long portalPreferencesId) Returns the portal preferences with the primary key or returnsnullif it could not be found.static Map<Serializable,PortalPreferences> fetchByPrimaryKeys(Set<Serializable> primaryKeys) 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<PortalPreferences> orderByComparator) Returns an ordered range of all the portal preferenceses.static List<PortalPreferences>findAll(int start, int end, OrderByComparator<PortalPreferences> orderByComparator, boolean useFinderCache) Returns an ordered range of all the portal preferenceses.static PortalPreferencesfindByO_O(long ownerId, int ownerType) Returns the portal preferences where ownerId = ? and ownerType = ? or throws aNoSuchPreferencesExceptionif it could not be found.static List<PortalPreferences>findByOwnerType(int ownerType) Returns all the portal preferenceses where ownerType = ?.static List<PortalPreferences>findByOwnerType(int ownerType, int start, int end) Returns a range of all the portal preferenceses where ownerType = ?.static List<PortalPreferences>findByOwnerType(int ownerType, int start, int end, OrderByComparator<PortalPreferences> orderByComparator) Returns an ordered range of all the portal preferenceses where ownerType = ?.static List<PortalPreferences>findByOwnerType(int ownerType, int start, int end, OrderByComparator<PortalPreferences> orderByComparator, boolean useFinderCache) Returns an ordered range of all the portal preferenceses where ownerType = ?.static PortalPreferencesfindByOwnerType_First(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) Returns the first portal preferences in the ordered set where ownerType = ?.static PortalPreferencesfindByOwnerType_Last(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) Returns the last portal preferences in the ordered set where ownerType = ?.static PortalPreferences[]findByOwnerType_PrevAndNext(long portalPreferencesId, int ownerType, OrderByComparator<PortalPreferences> orderByComparator) Returns the portal preferenceses before and after the current portal preferences in the ordered set where ownerType = ?.static PortalPreferencesfindByPrimaryKey(long portalPreferencesId) Returns the portal preferences with the primary key or throws aNoSuchPreferencesExceptionif 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<PortalPreferences> orderByComparator) static PortalPreferencesPersistencestatic PortalPreferencesremove(long portalPreferencesId) Removes the portal preferences with the primary key from the database.static voidRemoves all the portal preferenceses from the database.static PortalPreferencesremoveByO_O(long ownerId, int ownerType) Removes the portal preferences where ownerId = ? and ownerType = ? from the database.static voidremoveByOwnerType(int ownerType) Removes all the portal preferenceses where ownerType = ? from the database.static voidsetPersistence(PortalPreferencesPersistence persistence) static PortalPreferencesupdate(PortalPreferences portalPreferences) static PortalPreferencesupdate(PortalPreferences portalPreferences, ServiceContext serviceContext) static PortalPreferencesupdateImpl(PortalPreferences portalPreferences)
-
Constructor Details
-
PortalPreferencesUtil
public PortalPreferencesUtil()
-
-
Method Details
-
clearCache
public static void clearCache()- See Also:
-
clearCache
-
countWithDynamicQuery
-
fetchByPrimaryKeys
- See Also:
-
findWithDynamicQuery
-
findWithDynamicQuery
public static List<PortalPreferences> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end) -
findWithDynamicQuery
public static List<PortalPreferences> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<PortalPreferences> orderByComparator) -
update
-
update
public static PortalPreferences update(PortalPreferences portalPreferences, ServiceContext serviceContext) -
findByOwnerType
Returns all the portal preferenceses where ownerType = ?.- Parameters:
ownerType- the owner type- Returns:
- the matching portal preferenceses
-
findByOwnerType
Returns a range of all the portal preferenceses where ownerType = ?.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromPortalPreferencesModelImpl.- Parameters:
ownerType- the owner typestart- the lower bound of the range of portal preferencesesend- the upper bound of the range of portal preferenceses (not inclusive)- Returns:
- the range of matching portal preferenceses
-
findByOwnerType
public static List<PortalPreferences> findByOwnerType(int ownerType, int start, int end, OrderByComparator<PortalPreferences> orderByComparator) Returns an ordered range of all the portal preferenceses where ownerType = ?.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromPortalPreferencesModelImpl.- Parameters:
ownerType- the owner typestart- the lower bound of the range of portal preferencesesend- the upper bound of the range of portal preferenceses (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the ordered range of matching portal preferenceses
-
findByOwnerType
public static List<PortalPreferences> findByOwnerType(int ownerType, int start, int end, OrderByComparator<PortalPreferences> orderByComparator, boolean useFinderCache) Returns an ordered range of all the portal preferenceses where ownerType = ?.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromPortalPreferencesModelImpl.- Parameters:
ownerType- the owner typestart- the lower bound of the range of portal preferencesesend- the upper bound of the range of portal preferenceses (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)useFinderCache- whether to use the finder cache- Returns:
- the ordered range of matching portal preferenceses
-
findByOwnerType_First
public static PortalPreferences findByOwnerType_First(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) throws NoSuchPreferencesException Returns the first portal preferences in the ordered set where ownerType = ?.- Parameters:
ownerType- the owner typeorderByComparator- the comparator to order the set by (optionallynull)- Returns:
- the first matching portal preferences
- Throws:
NoSuchPreferencesException- if a matching portal preferences could not be foundNoSuchPreferencesException
-
fetchByOwnerType_First
public static PortalPreferences fetchByOwnerType_First(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) Returns the first portal preferences in the ordered set where ownerType = ?.- Parameters:
ownerType- the owner typeorderByComparator- the comparator to order the set by (optionallynull)- Returns:
- the first matching portal preferences, or
nullif a matching portal preferences could not be found
-
findByOwnerType_Last
public static PortalPreferences findByOwnerType_Last(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) throws NoSuchPreferencesException Returns the last portal preferences in the ordered set where ownerType = ?.- Parameters:
ownerType- the owner typeorderByComparator- the comparator to order the set by (optionallynull)- Returns:
- the last matching portal preferences
- Throws:
NoSuchPreferencesException- if a matching portal preferences could not be foundNoSuchPreferencesException
-
fetchByOwnerType_Last
public static PortalPreferences fetchByOwnerType_Last(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) Returns the last portal preferences in the ordered set where ownerType = ?.- Parameters:
ownerType- the owner typeorderByComparator- the comparator to order the set by (optionallynull)- Returns:
- the last matching portal preferences, or
nullif a matching portal preferences could not be found
-
findByOwnerType_PrevAndNext
public static PortalPreferences[] findByOwnerType_PrevAndNext(long portalPreferencesId, int ownerType, OrderByComparator<PortalPreferences> orderByComparator) throws NoSuchPreferencesException Returns the portal preferenceses before and after the current portal preferences in the ordered set where ownerType = ?.- Parameters:
portalPreferencesId- the primary key of the current portal preferencesownerType- the owner typeorderByComparator- the comparator to order the set by (optionallynull)- Returns:
- the previous, current, and next portal preferences
- Throws:
NoSuchPreferencesException- if a portal preferences with the primary key could not be foundNoSuchPreferencesException
-
removeByOwnerType
public static void removeByOwnerType(int ownerType) Removes all the portal preferenceses where ownerType = ? from the database.- Parameters:
ownerType- the owner type
-
countByOwnerType
public static int countByOwnerType(int ownerType) Returns the number of portal preferenceses where ownerType = ?.- Parameters:
ownerType- the owner type- Returns:
- the number of matching portal preferenceses
-
findByO_O
public static PortalPreferences findByO_O(long ownerId, int ownerType) throws NoSuchPreferencesException Returns the portal preferences where ownerId = ? and ownerType = ? or throws aNoSuchPreferencesExceptionif it could not be found.- Parameters:
ownerId- the owner IDownerType- the owner type- Returns:
- the matching portal preferences
- Throws:
NoSuchPreferencesException- if a matching portal preferences could not be foundNoSuchPreferencesException
-
fetchByO_O
Returns the portal preferences where ownerId = ? and ownerType = ? or returnsnullif it could not be found. Uses the finder cache.- Parameters:
ownerId- the owner IDownerType- the owner type- Returns:
- the matching portal preferences, or
nullif a matching portal preferences could not be found
-
fetchByO_O
Returns the portal preferences where ownerId = ? and ownerType = ? or returnsnullif it could not be found, optionally using the finder cache.- Parameters:
ownerId- the owner IDownerType- the owner typeuseFinderCache- whether to use the finder cache- Returns:
- the matching portal preferences, or
nullif a matching portal preferences could not be found
-
removeByO_O
public static PortalPreferences removeByO_O(long ownerId, int ownerType) throws NoSuchPreferencesException Removes the portal preferences where ownerId = ? and ownerType = ? from the database.- Parameters:
ownerId- the owner IDownerType- the owner type- Returns:
- the portal preferences that was removed
- Throws:
NoSuchPreferencesException
-
countByO_O
public static int countByO_O(long ownerId, int ownerType) Returns the number of portal preferenceses where ownerId = ? and ownerType = ?.- Parameters:
ownerId- the owner IDownerType- the owner type- Returns:
- the number of matching portal preferenceses
-
cacheResult
Caches the portal preferences in the entity cache if it is enabled.- Parameters:
portalPreferences- the portal preferences
-
cacheResult
Caches the portal preferenceses in the entity cache if it is enabled.- Parameters:
portalPreferenceses- the portal preferenceses
-
create
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
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 foundNoSuchPreferencesException
-
updateImpl
-
findByPrimaryKey
public static PortalPreferences findByPrimaryKey(long portalPreferencesId) throws NoSuchPreferencesException Returns the portal preferences with the primary key or throws aNoSuchPreferencesExceptionif 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 foundNoSuchPreferencesException
-
fetchByPrimaryKey
Returns the portal preferences with the primary key or returnsnullif it could not be found.- Parameters:
portalPreferencesId- the primary key of the portal preferences- Returns:
- the portal preferences, or
nullif a portal preferences with the primary key could not be found
-
findAll
Returns all the portal preferenceses.- Returns:
- the portal preferenceses
-
findAll
Returns a range of all the portal preferenceses.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromPortalPreferencesModelImpl.- Parameters:
start- the lower bound of the range of portal preferencesesend- the upper bound of the range of portal preferenceses (not inclusive)- Returns:
- the range of portal preferenceses
-
findAll
public static 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromPortalPreferencesModelImpl.- Parameters:
start- the lower bound of the range of portal preferencesesend- the upper bound of the range of portal preferenceses (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the ordered range of portal preferenceses
-
findAll
public static List<PortalPreferences> findAll(int start, int end, OrderByComparator<PortalPreferences> orderByComparator, boolean useFinderCache) Returns an ordered range of all the portal preferenceses.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromPortalPreferencesModelImpl.- Parameters:
start- the lower bound of the range of portal preferencesesend- the upper bound of the range of portal preferenceses (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)useFinderCache- whether to use the finder cache- Returns:
- the ordered range of portal preferenceses
-
removeAll
public static void removeAll()Removes all the portal preferenceses from the database. -
countAll
public static int countAll()Returns the number of portal preferenceses.- Returns:
- the number of portal preferenceses
-
getPersistence
-
setPersistence
-