com.liferay.portal.kernel.service.persistence

Interface PluginSettingPersistence

All Superinterfaces:

BasePersistence<PluginSetting>

@ProviderType
public interface PluginSettingPersistence
extends BasePersistence<PluginSetting>

The persistence interface for the plugin setting service.

Caching information and settings can be found in portal.properties

Author:

Brian Wing Shun Chan

See Also:

PluginSettingPersistenceImpl, PluginSettingUtil

{$generated.description}

Method Summary

Modifier and Type	Method and Description
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<PluginSetting> orderByComparator) Returns the first plugin setting in the ordered set where companyId = ?.
PluginSetting	fetchByCompanyId_Last(long companyId, OrderByComparator<PluginSetting> 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.
Map<Serializable,PluginSetting>	fetchByPrimaryKeys(Set<Serializable> primaryKeys)
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<PluginSetting> orderByComparator) Returns an ordered range of all the plugin settings.
List<PluginSetting>	findAll(int start, int end, OrderByComparator<PluginSetting> orderByComparator, boolean retrieveFromCache) 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<PluginSetting> orderByComparator) Returns the first plugin setting in the ordered set where companyId = ?.
PluginSetting	findByCompanyId_Last(long companyId, OrderByComparator<PluginSetting> orderByComparator) Returns the last plugin setting in the ordered set where companyId = ?.
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 = ?.
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<PluginSetting> orderByComparator) Returns an ordered range of all the plugin settings where companyId = ?.
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 = ?.
PluginSetting	findByPrimaryKey(long pluginSettingId) Returns the plugin setting with the primary key or throws a NoSuchPluginSettingException if it could not be found.
Set<String>	getBadColumnNames()
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)

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

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

Method Detail

findByCompanyId

List<PluginSetting> findByCompanyId(long companyId)

Returns all the plugin settings where companyId = ?.

Parameters:

companyId - the company ID

Returns:

the matching plugin settings

findByCompanyId

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

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

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

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

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

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

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

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

void removeByCompanyId(long companyId)

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

Parameters:

companyId - the company ID

countByCompanyId

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

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

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

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

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

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

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

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

PluginSetting updateImpl(PluginSetting pluginSetting)

findByPrimaryKey

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

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

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

Specified by:

fetchByPrimaryKeys in interface BasePersistence<PluginSetting>

findAll

List<PluginSetting> findAll()

Returns all the plugin settings.

Returns:

the plugin settings

findAll

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

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

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

void removeAll()

Removes all the plugin settings from the database.

countAll

int countAll()

Returns the number of plugin settings.

Returns:

the number of plugin settings

getBadColumnNames

Set<String> getBadColumnNames()

Specified by:

getBadColumnNames in interface BasePersistence<PluginSetting>