com.liferay.portal.service.persistence
Interface PluginSettingPersistence

All Superinterfaces:

BasePersistence<PluginSetting>

All Known Implementing Classes:

PluginSettingPersistenceImpl

public interface PluginSettingPersistence
extends BasePersistence<PluginSetting>

The persistence interface for the plugin setting service.

Caching information and settings can be found in portal.properties

See Also:

PluginSettingPersistenceImpl, PluginSettingUtil

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

Method Summary

void	cacheResult(List<PluginSetting> pluginSettings) Caches the plugin settings in the entity cache if it is enabled.
void	cacheResult(PluginSetting pluginSetting) Caches the plugin setting in the entity cache if it is enabled.
int	countAll() Returns the number of plugin settings.
int	countByC_I_T(long companyId, String pluginId, String pluginType) Returns the number of plugin settings where companyId = ? and pluginId = ? and pluginType = ?.
int	countByCompanyId(long companyId) Returns the number of plugin settings where companyId = ?.
PluginSetting	create(long pluginSettingId) Creates a new plugin setting with the primary key.
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.
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.
PluginSetting	fetchByCompanyId_First(long companyId, OrderByComparator orderByComparator) Returns the first plugin setting in the ordered set where companyId = ?.
PluginSetting	fetchByCompanyId_Last(long companyId, OrderByComparator orderByComparator) Returns the last plugin setting in the ordered set where companyId = ?.
PluginSetting	fetchByPrimaryKey(long pluginSettingId) Returns the plugin setting with the primary key or returns null if it could not be found.
List<PluginSetting>	findAll() Returns all the plugin settings.
List<PluginSetting>	findAll(int start, int end) Returns a range of all the plugin settings.
List<PluginSetting>	findAll(int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the plugin settings.
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.
PluginSetting	findByCompanyId_First(long companyId, OrderByComparator orderByComparator) Returns the first plugin setting in the ordered set where companyId = ?.
PluginSetting	findByCompanyId_Last(long companyId, OrderByComparator orderByComparator) Returns the last plugin setting in the ordered set where companyId = ?.
PluginSetting[]	findByCompanyId_PrevAndNext(long pluginSettingId, long companyId, OrderByComparator orderByComparator) Returns the plugin settings before and after the current plugin setting in the ordered set where companyId = ?.
List<PluginSetting>	findByCompanyId(long companyId) Returns all the plugin settings where companyId = ?.
List<PluginSetting>	findByCompanyId(long companyId, int start, int end) Returns a range of all the plugin settings where companyId = ?.
List<PluginSetting>	findByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the plugin settings where companyId = ?.
PluginSetting	findByPrimaryKey(long pluginSettingId) Returns the plugin setting with the primary key or throws a NoSuchPluginSettingException if it could not be found.
PluginSetting	remove(long pluginSettingId) Removes the plugin setting with the primary key from the database.
void	removeAll() Removes all the plugin settings from the database.
PluginSetting	removeByC_I_T(long companyId, String pluginId, String pluginType) Removes the plugin setting where companyId = ? and pluginId = ? and pluginType = ? from the database.
void	removeByCompanyId(long companyId) Removes all the plugin settings where companyId = ? from the database.
PluginSetting	updateImpl(PluginSetting pluginSetting, boolean merge)

Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence

clearCache, clearCache, clearCache, closeSession, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, openSession, processException, registerListener, remove, remove, setDataSource, unregisterListener, update, update

Method Detail

cacheResult

void cacheResult(PluginSetting pluginSetting)

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

Parameters:

pluginSetting - the plugin setting

cacheResult

void cacheResult(List<PluginSetting> pluginSettings)

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

Parameters:

pluginSettings - the plugin settings

create

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

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

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

PluginSetting updateImpl(PluginSetting pluginSetting,
                         boolean merge)
                         throws SystemException

Throws:

SystemException

findByPrimaryKey

PluginSetting findByPrimaryKey(long pluginSettingId)
                               throws NoSuchPluginSettingException,
                                      SystemException

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

SystemException - if a system exception occurred

fetchByPrimaryKey

PluginSetting fetchByPrimaryKey(long pluginSettingId)
                                throws SystemException

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

Throws:

SystemException - if a system exception occurred

findByCompanyId

List<PluginSetting> findByCompanyId(long companyId)
                                    throws SystemException

Returns all the plugin settings where companyId = ?.

Parameters:

companyId - the company ID

Returns:

the matching plugin settings

Throws:

SystemException - if a system exception occurred

findByCompanyId

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

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.

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

Throws:

SystemException - if a system exception occurred

findByCompanyId

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

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.

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

Throws:

SystemException - if a system exception occurred

findByCompanyId_First

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

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

SystemException - if a system exception occurred

fetchByCompanyId_First

PluginSetting fetchByCompanyId_First(long companyId,
                                     OrderByComparator orderByComparator)
                                     throws SystemException

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

Throws:

SystemException - if a system exception occurred

findByCompanyId_Last

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

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

SystemException - if a system exception occurred

fetchByCompanyId_Last

PluginSetting fetchByCompanyId_Last(long companyId,
                                    OrderByComparator orderByComparator)
                                    throws SystemException

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

Throws:

SystemException - if a system exception occurred

findByCompanyId_PrevAndNext

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

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

SystemException - if a system exception occurred

findByC_I_T

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

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

SystemException - if a system exception occurred

fetchByC_I_T

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

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

Throws:

SystemException - if a system exception occurred

fetchByC_I_T

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

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 use the finder cache

Returns:

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

Throws:

SystemException - if a system exception occurred

findAll

List<PluginSetting> findAll()
                            throws SystemException

Returns all the plugin settings.

Returns:

the plugin settings

Throws:

SystemException - if a system exception occurred

findAll

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

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.

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

Throws:

SystemException - if a system exception occurred

findAll

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

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.

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

Throws:

SystemException - if a system exception occurred

removeByCompanyId

void removeByCompanyId(long companyId)
                       throws SystemException

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

Parameters:

companyId - the company ID

Throws:

SystemException - if a system exception occurred

removeByC_I_T

PluginSetting 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

pluginId - the plugin ID

pluginType - the plugin type

Returns:

the plugin setting that was removed

Throws:

SystemException - if a system exception occurred

NoSuchPluginSettingException

removeAll

void removeAll()
               throws SystemException

Removes all the plugin settings from the database.

Throws:

SystemException - if a system exception occurred

countByCompanyId

int countByCompanyId(long companyId)
                     throws SystemException

Returns the number of plugin settings where companyId = ?.

Parameters:

companyId - the company ID

Returns:

the number of matching plugin settings

Throws:

SystemException - if a system exception occurred

countByC_I_T

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

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

Throws:

SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException

Returns the number of plugin settings.

Returns:

the number of plugin settings

Throws:

SystemException - if a system exception occurred