com.liferay.portal.kernel.service.persistence

Class PluginSettingUtil

Object

com.liferay.portal.kernel.service.persistence.PluginSettingUtil

@ProviderType
public class PluginSettingUtil
extends Object

The persistence utility for the plugin setting service. This utility wraps 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:

PluginSettingPersistence, PluginSettingPersistenceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
PluginSettingUtil()

Method Summary

Modifier and Type	Method and Description
static void	cacheResult(List<PluginSetting> pluginSettings) Caches the plugin settings in the entity cache if it is enabled.
static void	cacheResult(PluginSetting pluginSetting) Caches the plugin setting in the entity cache if it is enabled.
static void	clearCache()
static void	clearCache(PluginSetting pluginSetting)
static int	countAll() Returns the number of plugin settings.
static int	countByC_I_T(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_I_T(long companyId, String pluginId, String pluginType) Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or returns null if it could not be found.
static PluginSetting	fetchByC_I_T(long companyId, String pluginId, String pluginType, boolean retrieveFromCache) Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or returns null 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 returns null 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 retrieveFromCache) Returns an ordered range of all the plugin settings.
static PluginSetting	findByC_I_T(long companyId, String pluginId, String pluginType) Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or throws a NoSuchPluginSettingException if it could not be found.
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 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 retrieveFromCache) Returns an ordered range of all the plugin settings where companyId = ?.
static PluginSetting	findByPrimaryKey(long pluginSettingId) Returns the plugin setting with the primary key or throws a NoSuchPluginSettingException 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 Set<String>	getBadColumnNames()
static PluginSettingPersistence	getPersistence()
static PluginSetting	remove(long pluginSettingId) Removes the plugin setting with the primary key from the database.
static void	removeAll() Removes all the plugin settings from the database.
static PluginSetting	removeByC_I_T(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 PluginSetting	update(PluginSetting pluginSetting)
static PluginSetting	update(PluginSetting pluginSetting, ServiceContext serviceContext)
static PluginSetting	updateImpl(PluginSetting pluginSetting)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginSettingUtil

public PluginSettingUtil()

Method Detail

clearCache

public static void clearCache()

See Also:

BasePersistence.clearCache()

clearCache

public static void clearCache(PluginSetting pluginSetting)

See Also:

BasePersistence.clearCache(com.liferay.portal.kernel.model.BaseModel)

countWithDynamicQuery

public static long countWithDynamicQuery(DynamicQuery dynamicQuery)

See Also:

BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<PluginSetting> findWithDynamicQuery(DynamicQuery dynamicQuery)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<PluginSetting> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                       int start,
                                                       int end)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static List<PluginSetting> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                       int start,
                                                       int end,
                                                       OrderByComparator<PluginSetting> orderByComparator)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static PluginSetting update(PluginSetting pluginSetting)

See Also:

BasePersistence.update(com.liferay.portal.kernel.model.BaseModel)

update

public static PluginSetting update(PluginSetting pluginSetting,
                                   ServiceContext serviceContext)

See Also:

BasePersistence.update(com.liferay.portal.kernel.model.BaseModel, ServiceContext)

findByCompanyId

public static List<PluginSetting> findByCompanyId(long companyId)

Returns all the plugin settings where companyId = ?.

Parameters:

companyId - the company ID

Returns:

the matching plugin settings

findByCompanyId

public static List<PluginSetting> findByCompanyId(long companyId,
                                                  int start,
                                                  int end)

Returns a range of all the plugin settings where companyId = ?.

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 PluginSettingModelImpl. 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:

companyId - the company ID

start - the lower bound of the range of plugin settings

end - 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 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 PluginSettingModelImpl. 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:

companyId - the company ID

start - the lower bound of the range of plugin settings

end - the upper bound of the range of plugin settings (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching plugin settings

findByCompanyId

public static List<PluginSetting> findByCompanyId(long companyId,
                                                  int start,
                                                  int end,
                                                  OrderByComparator<PluginSetting> orderByComparator,
                                                  boolean retrieveFromCache)

Returns an ordered range of all the plugin settings where companyId = ?.

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 PluginSettingModelImpl. 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:

companyId - the company ID

start - the lower bound of the range of plugin settings

end - the upper bound of the range of plugin settings (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

retrieveFromCache - whether to retrieve from 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 ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching plugin setting

Throws:

NoSuchPluginSettingException - if a matching plugin setting could not be found

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 ID

orderByComparator - the comparator to order the set by (optionally null)

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 ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching plugin setting

Throws:

NoSuchPluginSettingException - if a matching plugin setting could not be found

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 ID

orderByComparator - the comparator to order the set by (optionally null)

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 setting

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the previous, current, and next plugin setting

Throws:

NoSuchPluginSettingException - if a plugin setting with the primary key could not be found

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_I_T

public static PluginSetting findByC_I_T(long companyId,
                                        String pluginId,
                                        String pluginType)
                                 throws NoSuchPluginSettingException

Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or throws a NoSuchPluginSettingException if it could not be found.

Parameters:

companyId - the company ID

pluginId - the plugin ID

pluginType - the plugin type

Returns:

the matching plugin setting

Throws:

NoSuchPluginSettingException - if a matching plugin setting could not be found

fetchByC_I_T

public static PluginSetting fetchByC_I_T(long companyId,
                                         String pluginId,
                                         String pluginType)

Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

companyId - the company ID

pluginId - the plugin ID

pluginType - the plugin type

Returns:

the matching plugin setting, or null if a matching plugin setting could not be found

fetchByC_I_T

public static PluginSetting fetchByC_I_T(long companyId,
                                         String pluginId,
                                         String pluginType,
                                         boolean retrieveFromCache)

Returns the plugin setting where companyId = ? and pluginId = ? and pluginType = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:

companyId - the company ID

pluginId - the plugin ID

pluginType - the plugin type

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the matching plugin setting, or null if a matching plugin setting could not be found

removeByC_I_T

public static PluginSetting removeByC_I_T(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 ID

pluginId - the plugin ID

pluginType - the plugin type

Returns:

the plugin setting that was removed

Throws:

NoSuchPluginSettingException

countByC_I_T

public static int countByC_I_T(long companyId,
                               String pluginId,
                               String pluginType)

Returns the number of plugin settings where companyId = ? and pluginId = ? and pluginType = ?.

Parameters:

companyId - the company ID

pluginId - the plugin ID

pluginType - the plugin type

Returns:

the number of matching plugin settings

cacheResult

public static void cacheResult(PluginSetting pluginSetting)

Caches the plugin setting in the entity cache if it is enabled.

Parameters:

pluginSetting - the plugin setting

cacheResult

public static void cacheResult(List<PluginSetting> pluginSettings)

Caches the plugin settings in the entity cache if it is enabled.

Parameters:

pluginSettings - the plugin settings

create

public static PluginSetting create(long pluginSettingId)

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

public static PluginSetting remove(long pluginSettingId)
                            throws NoSuchPluginSettingException

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 found

updateImpl

public static PluginSetting updateImpl(PluginSetting pluginSetting)

findByPrimaryKey

public static PluginSetting findByPrimaryKey(long pluginSettingId)
                                      throws NoSuchPluginSettingException

Returns the plugin setting with the primary key or throws a NoSuchPluginSettingException 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 found

fetchByPrimaryKey

public static PluginSetting fetchByPrimaryKey(long pluginSettingId)

Returns the plugin setting with the primary key or returns null 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

fetchByPrimaryKeys

public static Map<Serializable,PluginSetting> fetchByPrimaryKeys(Set<Serializable> primaryKeys)

findAll

public static List<PluginSetting> findAll()

Returns all the plugin settings.

Returns:

the plugin settings

findAll

public static List<PluginSetting> findAll(int start,
                                          int end)

Returns a range of all the plugin settings.

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 PluginSettingModelImpl. 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 plugin settings

end - 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 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 PluginSettingModelImpl. 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 plugin settings

end - the upper bound of the range of plugin settings (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of plugin settings

findAll

public static List<PluginSetting> findAll(int start,
                                          int end,
                                          OrderByComparator<PluginSetting> orderByComparator,
                                          boolean retrieveFromCache)

Returns an ordered range of all the plugin settings.

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 PluginSettingModelImpl. 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 plugin settings

end - the upper bound of the range of plugin settings (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

retrieveFromCache - whether to retrieve from 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

getBadColumnNames

public static Set<String> getBadColumnNames()

getPersistence

public static PluginSettingPersistence getPersistence()