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 void
cacheResult
(PortalPreferences portalPreferences) Caches the portal preferences in the entity cache if it is enabled.static void
cacheResult
(List<PortalPreferences> portalPreferenceses) Caches the portal preferenceses in the entity cache if it is enabled.static void
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 int
countByOwnerType
(int ownerType) Returns the number of portal preferenceses where 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 returnsnull
if it could not be found.static PortalPreferences
fetchByO_O
(long ownerId, int ownerType, boolean useFinderCache) Returns the portal preferences where ownerId = ? and ownerType = ? or returnsnull
if it could not be found, optionally using the finder cache.static PortalPreferences
fetchByOwnerType_First
(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) Returns the first portal preferences in the ordered set where ownerType = ?.static PortalPreferences
fetchByOwnerType_Last
(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) Returns the last portal preferences in the ordered set where ownerType = ?.static PortalPreferences
fetchByPrimaryKey
(long portalPreferencesId) Returns the portal preferences with the primary key or returnsnull
if 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 PortalPreferences
findByO_O
(long ownerId, int ownerType) Returns the portal preferences where ownerId = ? and ownerType = ? or throws aNoSuchPreferencesException
if 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 PortalPreferences
findByOwnerType_First
(int ownerType, OrderByComparator<PortalPreferences> orderByComparator) Returns the first portal preferences in the ordered set where ownerType = ?.static PortalPreferences
findByOwnerType_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 PortalPreferences
findByPrimaryKey
(long portalPreferencesId) Returns the portal preferences with the primary key or throws aNoSuchPreferencesException
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<PortalPreferences> orderByComparator) static PortalPreferencesPersistence
static PortalPreferences
remove
(long portalPreferencesId) Removes the portal preferences with the primary key from the database.static void
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.static void
removeByOwnerType
(int ownerType) Removes all the portal preferenceses where ownerType = ? from the database.static void
setPersistence
(PortalPreferencesPersistence persistence) static PortalPreferences
update
(PortalPreferences portalPreferences) static PortalPreferences
update
(PortalPreferences portalPreferences, ServiceContext serviceContext) static PortalPreferences
updateImpl
(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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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
null
if 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
null
if 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 aNoSuchPreferencesException
if 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 returnsnull
if it could not be found. Uses the finder cache.- Parameters:
ownerId
- the owner IDownerType
- the owner type- Returns:
- the matching portal preferences, or
null
if a matching portal preferences could not be found
-
fetchByO_O
Returns the portal preferences where ownerId = ? and ownerType = ? or returnsnull
if 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
null
if 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 aNoSuchPreferencesException
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 foundNoSuchPreferencesException
-
fetchByPrimaryKey
Returns the portal preferences with the primary key or returnsnull
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
-
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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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
-