Class PluginSettingUtil
com.liferay.portal.service.persistence.impl.PluginSettingPersistenceImpl
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
(PluginSetting pluginSetting) Caches the plugin setting in the entity cache if it is enabled.static void
cacheResult
(List<PluginSetting> pluginSettings) Caches the plugin settings in the entity cache if it is enabled.static void
static void
clearCache
(PluginSetting pluginSetting) static int
countAll()
Returns the number of plugin settings.static int
countByC_P_P
(long companyId, String pluginId, String pluginType) Returns the number of plugin settings where companyId = ? and pluginId = ? and pluginType = ?.static int
countByCompanyId
(long companyId) Returns the number of plugin settings where companyId = ?.static long
countWithDynamicQuery
(DynamicQuery dynamicQuery) static PluginSetting
create
(long pluginSettingId) Creates a new plugin setting with the primary key.static PluginSetting
fetchByC_P_P
(long companyId, String pluginId, String pluginType) Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or returnsnull
if it could not be found.static PluginSetting
fetchByC_P_P
(long companyId, String pluginId, String pluginType, boolean useFinderCache) Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or returnsnull
if it could not be found, optionally using the finder cache.static PluginSetting
fetchByCompanyId_First
(long companyId, OrderByComparator<PluginSetting> orderByComparator) Returns the first plugin setting in the ordered set where companyId = ?.static PluginSetting
fetchByCompanyId_Last
(long companyId, OrderByComparator<PluginSetting> orderByComparator) Returns the last plugin setting in the ordered set where companyId = ?.static PluginSetting
fetchByPrimaryKey
(long pluginSettingId) Returns the plugin setting with the primary key or returnsnull
if it could not be found.static Map<Serializable,
PluginSetting> fetchByPrimaryKeys
(Set<Serializable> primaryKeys) static List<PluginSetting>
findAll()
Returns all the plugin settings.static List<PluginSetting>
findAll
(int start, int end) Returns a range of all the plugin settings.static List<PluginSetting>
findAll
(int start, int end, OrderByComparator<PluginSetting> orderByComparator) Returns an ordered range of all the plugin settings.static List<PluginSetting>
findAll
(int start, int end, OrderByComparator<PluginSetting> orderByComparator, boolean useFinderCache) Returns an ordered range of all the plugin settings.static PluginSetting
findByC_P_P
(long companyId, String pluginId, String pluginType) Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or throws aNoSuchPluginSettingException
if it could not be found.static List<PluginSetting>
findByCompanyId
(long companyId) Returns all the plugin settings where companyId = ?.static List<PluginSetting>
findByCompanyId
(long companyId, int start, int end) Returns a range of all the plugin settings where companyId = ?.static List<PluginSetting>
findByCompanyId
(long companyId, int start, int end, OrderByComparator<PluginSetting> orderByComparator) Returns an ordered range of all the plugin settings where companyId = ?.static List<PluginSetting>
findByCompanyId
(long companyId, int start, int end, OrderByComparator<PluginSetting> orderByComparator, boolean useFinderCache) Returns an ordered range of all the plugin settings where companyId = ?.static PluginSetting
findByCompanyId_First
(long companyId, OrderByComparator<PluginSetting> orderByComparator) Returns the first plugin setting in the ordered set where companyId = ?.static PluginSetting
findByCompanyId_Last
(long companyId, OrderByComparator<PluginSetting> orderByComparator) Returns the last plugin setting in the ordered set where companyId = ?.static PluginSetting[]
findByCompanyId_PrevAndNext
(long pluginSettingId, long companyId, OrderByComparator<PluginSetting> orderByComparator) Returns the plugin settings before and after the current plugin setting in the ordered set where companyId = ?.static PluginSetting
findByPrimaryKey
(long pluginSettingId) Returns the plugin setting with the primary key or throws aNoSuchPluginSettingException
if it could not be found.static List<PluginSetting>
findWithDynamicQuery
(DynamicQuery dynamicQuery) static List<PluginSetting>
findWithDynamicQuery
(DynamicQuery dynamicQuery, int start, int end) static List<PluginSetting>
findWithDynamicQuery
(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<PluginSetting> orderByComparator) static PluginSettingPersistence
static PluginSetting
remove
(long pluginSettingId) Removes the plugin setting with the primary key from the database.static void
Removes all the plugin settings from the database.static PluginSetting
removeByC_P_P
(long companyId, String pluginId, String pluginType) Removes the plugin setting where companyId = ? and pluginId = ? and pluginType = ? from the database.static void
removeByCompanyId
(long companyId) Removes all the plugin settings where companyId = ? from the database.static void
setPersistence
(PluginSettingPersistence persistence) static PluginSetting
update
(PluginSetting pluginSetting) static PluginSetting
update
(PluginSetting pluginSetting, ServiceContext serviceContext) static PluginSetting
updateImpl
(PluginSetting pluginSetting)
-
Constructor Details
-
PluginSettingUtil
public PluginSettingUtil()
-
-
Method Details
-
clearCache
public static void clearCache()- See Also:
-
clearCache
-
countWithDynamicQuery
-
fetchByPrimaryKeys
- See Also:
-
findWithDynamicQuery
-
findWithDynamicQuery
public static List<PluginSetting> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end) -
findWithDynamicQuery
public static List<PluginSetting> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<PluginSetting> orderByComparator) -
update
-
update
-
findByCompanyId
Returns all the plugin settings where companyId = ?.- Parameters:
companyId
- the company ID- Returns:
- the matching plugin settings
-
findByCompanyId
Returns a range of all the plugin settings where companyId = ?.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 fromPluginSettingModelImpl
.- Parameters:
companyId
- the company IDstart
- the lower bound of the range of plugin settingsend
- the upper bound of the range of plugin settings (not inclusive)- Returns:
- the range of matching plugin settings
-
findByCompanyId
public static List<PluginSetting> findByCompanyId(long companyId, int start, int end, OrderByComparator<PluginSetting> orderByComparator) Returns an ordered range of all the plugin settings where companyId = ?.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 fromPluginSettingModelImpl
.- Parameters:
companyId
- the company IDstart
- the lower bound of the range of plugin settingsend
- the upper bound of the range of plugin settings (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching plugin settings
-
findByCompanyId
public static List<PluginSetting> findByCompanyId(long companyId, int start, int end, OrderByComparator<PluginSetting> orderByComparator, boolean useFinderCache) Returns an ordered range of all the plugin settings where companyId = ?.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 fromPluginSettingModelImpl
.- Parameters:
companyId
- the company IDstart
- the lower bound of the range of plugin settingsend
- the upper bound of the range of plugin settings (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)useFinderCache
- whether to use the finder cache- Returns:
- the ordered range of matching plugin settings
-
findByCompanyId_First
public static PluginSetting findByCompanyId_First(long companyId, OrderByComparator<PluginSetting> orderByComparator) throws NoSuchPluginSettingException Returns the first plugin setting in the ordered set where companyId = ?.- Parameters:
companyId
- the company IDorderByComparator
- the comparator to order the set by (optionallynull
)- Returns:
- the first matching plugin setting
- Throws:
NoSuchPluginSettingException
- if a matching plugin setting could not be foundNoSuchPluginSettingException
-
fetchByCompanyId_First
public static PluginSetting fetchByCompanyId_First(long companyId, OrderByComparator<PluginSetting> orderByComparator) Returns the first plugin setting in the ordered set where companyId = ?.- Parameters:
companyId
- the company IDorderByComparator
- the comparator to order the set by (optionallynull
)- Returns:
- the first matching plugin setting, or
null
if a matching plugin setting could not be found
-
findByCompanyId_Last
public static PluginSetting findByCompanyId_Last(long companyId, OrderByComparator<PluginSetting> orderByComparator) throws NoSuchPluginSettingException Returns the last plugin setting in the ordered set where companyId = ?.- Parameters:
companyId
- the company IDorderByComparator
- the comparator to order the set by (optionallynull
)- Returns:
- the last matching plugin setting
- Throws:
NoSuchPluginSettingException
- if a matching plugin setting could not be foundNoSuchPluginSettingException
-
fetchByCompanyId_Last
public static PluginSetting fetchByCompanyId_Last(long companyId, OrderByComparator<PluginSetting> orderByComparator) Returns the last plugin setting in the ordered set where companyId = ?.- Parameters:
companyId
- the company IDorderByComparator
- the comparator to order the set by (optionallynull
)- Returns:
- the last matching plugin setting, or
null
if a matching plugin setting could not be found
-
findByCompanyId_PrevAndNext
public static PluginSetting[] findByCompanyId_PrevAndNext(long pluginSettingId, long companyId, OrderByComparator<PluginSetting> orderByComparator) throws NoSuchPluginSettingException Returns the plugin settings before and after the current plugin setting in the ordered set where companyId = ?.- Parameters:
pluginSettingId
- the primary key of the current plugin settingcompanyId
- the company IDorderByComparator
- the comparator to order the set by (optionallynull
)- Returns:
- the previous, current, and next plugin setting
- Throws:
NoSuchPluginSettingException
- if a plugin setting with the primary key could not be foundNoSuchPluginSettingException
-
removeByCompanyId
public static void removeByCompanyId(long companyId) Removes all the plugin settings where companyId = ? from the database.- Parameters:
companyId
- the company ID
-
countByCompanyId
public static int countByCompanyId(long companyId) Returns the number of plugin settings where companyId = ?.- Parameters:
companyId
- the company ID- Returns:
- the number of matching plugin settings
-
findByC_P_P
public static PluginSetting findByC_P_P(long companyId, String pluginId, String pluginType) throws NoSuchPluginSettingException Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or throws aNoSuchPluginSettingException
if it could not be found.- Parameters:
companyId
- the company IDpluginId
- the plugin IDpluginType
- the plugin type- Returns:
- the matching plugin setting
- Throws:
NoSuchPluginSettingException
- if a matching plugin setting could not be foundNoSuchPluginSettingException
-
fetchByC_P_P
Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or returnsnull
if it could not be found. Uses the finder cache.- Parameters:
companyId
- the company IDpluginId
- the plugin IDpluginType
- the plugin type- Returns:
- the matching plugin setting, or
null
if a matching plugin setting could not be found
-
fetchByC_P_P
public static PluginSetting fetchByC_P_P(long companyId, String pluginId, String pluginType, boolean useFinderCache) Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or returnsnull
if it could not be found, optionally using the finder cache.- Parameters:
companyId
- the company IDpluginId
- the plugin IDpluginType
- the plugin typeuseFinderCache
- whether to use the finder cache- Returns:
- the matching plugin setting, or
null
if a matching plugin setting could not be found
-
removeByC_P_P
public static PluginSetting removeByC_P_P(long companyId, String pluginId, String pluginType) throws NoSuchPluginSettingException Removes the plugin setting where companyId = ? and pluginId = ? and pluginType = ? from the database.- Parameters:
companyId
- the company IDpluginId
- the plugin IDpluginType
- the plugin type- Returns:
- the plugin setting that was removed
- Throws:
NoSuchPluginSettingException
-
countByC_P_P
Returns the number of plugin settings where companyId = ? and pluginId = ? and pluginType = ?.- Parameters:
companyId
- the company IDpluginId
- the plugin IDpluginType
- the plugin type- Returns:
- the number of matching plugin settings
-
cacheResult
Caches the plugin setting in the entity cache if it is enabled.- Parameters:
pluginSetting
- the plugin setting
-
cacheResult
Caches the plugin settings in the entity cache if it is enabled.- Parameters:
pluginSettings
- the plugin settings
-
create
Creates a new plugin setting with the primary key. Does not add the plugin setting to the database.- Parameters:
pluginSettingId
- the primary key for the new plugin setting- Returns:
- the new plugin setting
-
remove
Removes the plugin setting with the primary key from the database. Also notifies the appropriate model listeners.- Parameters:
pluginSettingId
- the primary key of the plugin setting- Returns:
- the plugin setting that was removed
- Throws:
NoSuchPluginSettingException
- if a plugin setting with the primary key could not be foundNoSuchPluginSettingException
-
updateImpl
-
findByPrimaryKey
public static PluginSetting findByPrimaryKey(long pluginSettingId) throws NoSuchPluginSettingException Returns the plugin setting with the primary key or throws aNoSuchPluginSettingException
if it could not be found.- Parameters:
pluginSettingId
- the primary key of the plugin setting- Returns:
- the plugin setting
- Throws:
NoSuchPluginSettingException
- if a plugin setting with the primary key could not be foundNoSuchPluginSettingException
-
fetchByPrimaryKey
Returns the plugin setting with the primary key or returnsnull
if it could not be found.- Parameters:
pluginSettingId
- the primary key of the plugin setting- Returns:
- the plugin setting, or
null
if a plugin setting with the primary key could not be found
-
findAll
Returns all the plugin settings.- Returns:
- the plugin settings
-
findAll
Returns a range of all the plugin settings.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 fromPluginSettingModelImpl
.- Parameters:
start
- the lower bound of the range of plugin settingsend
- the upper bound of the range of plugin settings (not inclusive)- Returns:
- the range of plugin settings
-
findAll
public static List<PluginSetting> findAll(int start, int end, OrderByComparator<PluginSetting> orderByComparator) Returns an ordered range of all the plugin settings.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 fromPluginSettingModelImpl
.- Parameters:
start
- the lower bound of the range of plugin settingsend
- the upper bound of the range of plugin settings (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of plugin settings
-
findAll
public static List<PluginSetting> findAll(int start, int end, OrderByComparator<PluginSetting> orderByComparator, boolean useFinderCache) Returns an ordered range of all the plugin settings.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 fromPluginSettingModelImpl
.- Parameters:
start
- the lower bound of the range of plugin settingsend
- the upper bound of the range of plugin settings (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)useFinderCache
- whether to use the finder cache- Returns:
- the ordered range of plugin settings
-
removeAll
public static void removeAll()Removes all the plugin settings from the database. -
countAll
public static int countAll()Returns the number of plugin settings.- Returns:
- the number of plugin settings
-
getPersistence
-
setPersistence
-