com.liferay.portal.service.persistence
Class PluginSettingUtil

java.lang.Object
  com.liferay.portal.service.persistence.PluginSettingUtil

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.

Never modify this class directly. Modify service.xml and rerun ServiceBuilder to regenerate this class.

Caching information and settings can be found in portal.properties

See Also:

PluginSettingPersistence, PluginSettingPersistenceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary

PluginSettingUtil()

Method Summary

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() Counts all the plugin settings.
static int	countByC_I_T(long companyId, String pluginId, String pluginType) Counts all the plugin settings where companyId = ? and pluginId = ? and pluginType = ?.
static int	countByCompanyId(long companyId) Counts all the plugin settings where companyId = ?.
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) Finds 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) Finds 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	fetchByPrimaryKey(long pluginSettingId) Finds the plugin setting with the primary key or returns null if it could not be found.
static List<PluginSetting>	findAll() Finds all the plugin settings.
static List<PluginSetting>	findAll(int start, int end) Finds a range of all the plugin settings.
static List<PluginSetting>	findAll(int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the plugin settings.
static PluginSetting	findByC_I_T(long companyId, String pluginId, String pluginType) Finds 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 orderByComparator) Finds the first plugin setting in the ordered set where companyId = ?.
static PluginSetting	findByCompanyId_Last(long companyId, OrderByComparator orderByComparator) Finds the last plugin setting in the ordered set where companyId = ?.
static PluginSetting[]	findByCompanyId_PrevAndNext(long pluginSettingId, long companyId, OrderByComparator orderByComparator) Finds the plugin settings before and after the current plugin setting in the ordered set where companyId = ?.
static List<PluginSetting>	findByCompanyId(long companyId) Finds all the plugin settings where companyId = ?.
static List<PluginSetting>	findByCompanyId(long companyId, int start, int end) Finds a range of all the plugin settings where companyId = ?.
static List<PluginSetting>	findByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the plugin settings where companyId = ?.
static PluginSetting	findByPrimaryKey(long pluginSettingId) Finds 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 orderByComparator)
static PluginSettingPersistence	getPersistence()
static PluginSetting	remove(long pluginSettingId) Removes the plugin setting with the primary key from the database.
static PluginSetting	remove(PluginSetting pluginSetting)
static void	removeAll() Removes all the plugin settings from the database.
static void	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.
void	setPersistence(PluginSettingPersistence persistence)
static PluginSetting	update(PluginSetting pluginSetting, boolean merge)
static PluginSetting	update(PluginSetting pluginSetting, boolean merge, ServiceContext serviceContext)
static PluginSetting	updateImpl(PluginSetting pluginSetting, boolean merge)

Methods inherited from class java.lang.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.model.BaseModel)

countWithDynamicQuery

public long countWithDynamicQuery(DynamicQuery dynamicQuery)
                           throws SystemException

Throws:

SystemException

See Also:

BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<PluginSetting> findWithDynamicQuery(DynamicQuery dynamicQuery)
                                                throws SystemException

Throws:

SystemException

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

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

Throws:

SystemException

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

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

Throws:

SystemException

See Also:

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

remove

public static PluginSetting remove(PluginSetting pluginSetting)
                            throws SystemException

Throws:

SystemException

See Also:

BasePersistence.remove(com.liferay.portal.model.BaseModel)

update

public static PluginSetting update(PluginSetting pluginSetting,
                                   boolean merge)
                            throws SystemException

Throws:

SystemException

See Also:

BasePersistence.update(com.liferay.portal.model.BaseModel, boolean)

update

public static PluginSetting update(PluginSetting pluginSetting,
                                   boolean merge,
                                   ServiceContext serviceContext)
                            throws SystemException

Throws:

SystemException

See Also:

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

cacheResult

public static void cacheResult(PluginSetting pluginSetting)

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

Parameters:

pluginSetting - the plugin setting to cache

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 to cache

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,
                                   SystemException

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 to remove

Returns:

the plugin setting that was removed

Throws:

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

SystemException - if a system exception occurred

updateImpl

public static PluginSetting updateImpl(PluginSetting pluginSetting,
                                       boolean merge)
                                throws SystemException

Throws:

SystemException

findByPrimaryKey

public static PluginSetting findByPrimaryKey(long pluginSettingId)
                                      throws NoSuchPluginSettingException,
                                             SystemException

Finds 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 to find

Returns:

the plugin setting

Throws:

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

SystemException - if a system exception occurred

fetchByPrimaryKey

public static PluginSetting fetchByPrimaryKey(long pluginSettingId)
                                       throws SystemException

Finds 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 to find

Returns:

the plugin setting, or null if a plugin setting with the primary key could not be found

Throws:

SystemException - if a system exception occurred

findByCompanyId

public static List<PluginSetting> findByCompanyId(long companyId)
                                           throws SystemException

Finds all the plugin settings where companyId = ?.

Parameters:

companyId - the company id to search with

Returns:

the matching plugin settings

Throws:

SystemException - if a system exception occurred

findByCompanyId

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

Finds 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.

Parameters:

companyId - the company id to search with

start - the lower bound of the range of plugin settings to return

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

Returns:

the range of matching plugin settings

Throws:

SystemException - if a system exception occurred

findByCompanyId

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

Finds 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.

Parameters:

companyId - the company id to search with

start - the lower bound of the range of plugin settings to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching plugin settings

Throws:

SystemException - if a system exception occurred

findByCompanyId_First

public static PluginSetting findByCompanyId_First(long companyId,
                                                  OrderByComparator orderByComparator)
                                           throws NoSuchPluginSettingException,
                                                  SystemException

Finds the first plugin setting in the ordered set 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.

Parameters:

companyId - the company id to search with

orderByComparator - the comparator to order the set by

Returns:

the first matching plugin setting

Throws:

NoSuchPluginSettingException - if a matching plugin setting could not be found

SystemException - if a system exception occurred

findByCompanyId_Last

public static PluginSetting findByCompanyId_Last(long companyId,
                                                 OrderByComparator orderByComparator)
                                          throws NoSuchPluginSettingException,
                                                 SystemException

Finds the last plugin setting in the ordered set 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.

Parameters:

companyId - the company id to search with

orderByComparator - the comparator to order the set by

Returns:

the last matching plugin setting

Throws:

NoSuchPluginSettingException - if a matching plugin setting could not be found

SystemException - if a system exception occurred

findByCompanyId_PrevAndNext

public static PluginSetting[] findByCompanyId_PrevAndNext(long pluginSettingId,
                                                          long companyId,
                                                          OrderByComparator orderByComparator)
                                                   throws NoSuchPluginSettingException,
                                                          SystemException

Finds the plugin settings before and after the current plugin setting in the ordered set 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.

Parameters:

pluginSettingId - the primary key of the current plugin setting

companyId - the company id to search with

orderByComparator - the comparator to order the set by

Returns:

the previous, current, and next plugin setting

Throws:

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

SystemException - if a system exception occurred

findByC_I_T

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

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

Parameters:

companyId - the company id to search with

pluginId - the plugin id to search with

pluginType - the plugin type to search with

Returns:

the matching plugin setting

Throws:

NoSuchPluginSettingException - if a matching plugin setting could not be found

SystemException - if a system exception occurred

fetchByC_I_T

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

Finds 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 to search with

pluginId - the plugin id to search with

pluginType - the plugin type to search with

Returns:

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

Throws:

SystemException - if a system exception occurred

fetchByC_I_T

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

Finds 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 to search with

pluginId - the plugin id to search with

pluginType - the plugin type to search with

Returns:

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

Throws:

SystemException - if a system exception occurred

findAll

public static List<PluginSetting> findAll()
                                   throws SystemException

Finds all the plugin settings.

Returns:

the plugin settings

Throws:

SystemException - if a system exception occurred

findAll

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

Finds 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.

Parameters:

start - the lower bound of the range of plugin settings to return

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

Returns:

the range of plugin settings

Throws:

SystemException - if a system exception occurred

findAll

public static List<PluginSetting> findAll(int start,
                                          int end,
                                          OrderByComparator orderByComparator)
                                   throws SystemException

Finds 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.

Parameters:

start - the lower bound of the range of plugin settings to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of plugin settings

Throws:

SystemException - if a system exception occurred

removeByCompanyId

public static void removeByCompanyId(long companyId)
                              throws SystemException

Removes all the plugin settings where companyId = ? from the database.

Parameters:

companyId - the company id to search with

Throws:

SystemException - if a system exception occurred

removeByC_I_T

public static void removeByC_I_T(long companyId,
                                 String pluginId,
                                 String pluginType)
                          throws NoSuchPluginSettingException,
                                 SystemException

Removes the plugin setting where companyId = ? and pluginId = ? and pluginType = ? from the database.

Parameters:

companyId - the company id to search with

pluginId - the plugin id to search with

pluginType - the plugin type to search with

Throws:

SystemException - if a system exception occurred

NoSuchPluginSettingException

removeAll

public static void removeAll()
                      throws SystemException

Removes all the plugin settings from the database.

Throws:

SystemException - if a system exception occurred

countByCompanyId

public static int countByCompanyId(long companyId)
                            throws SystemException

Counts all the plugin settings where companyId = ?.

Parameters:

companyId - the company id to search with

Returns:

the number of matching plugin settings

Throws:

SystemException - if a system exception occurred

countByC_I_T

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

Counts all the plugin settings where companyId = ? and pluginId = ? and pluginType = ?.

Parameters:

companyId - the company id to search with

pluginId - the plugin id to search with

pluginType - the plugin type to search with

Returns:

the number of matching plugin settings

Throws:

SystemException - if a system exception occurred

countAll

public static int countAll()
                    throws SystemException

Counts all the plugin settings.

Returns:

the number of plugin settings

Throws:

SystemException - if a system exception occurred

getPersistence

public static PluginSettingPersistence getPersistence()

setPersistence

public void setPersistence(PluginSettingPersistence persistence)