com.liferay.portal.kernel.service

Interface PluginSettingLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

PluginSettingLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface PluginSettingLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for PluginSetting. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

PluginSettingLocalServiceUtil, PluginSettingLocalServiceBaseImpl, PluginSettingLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
PluginSetting	addPluginSetting(PluginSetting pluginSetting) Adds the plugin setting to the database.
void	checkPermission(long userId, String pluginId, String pluginType)
PluginSetting	createPluginSetting(long pluginSettingId) Creates a new plugin setting with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
PluginSetting	deletePluginSetting(long pluginSettingId) Deletes the plugin setting with the primary key from the database.
PluginSetting	deletePluginSetting(PluginSetting pluginSetting) Deletes the plugin setting from the database.
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
PluginSetting	fetchPluginSetting(long pluginSettingId)
ActionableDynamicQuery	getActionableDynamicQuery()
PluginSetting	getDefaultPluginSetting()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
PluginSetting	getPluginSetting(long pluginSettingId) Returns the plugin setting with the primary key.
PluginSetting	getPluginSetting(long companyId, String pluginId, String pluginType)
List<PluginSetting>	getPluginSettings(int start, int end) Returns a range of all the plugin settings.
int	getPluginSettingsCount() Returns the number of plugin settings.
boolean	hasPermission(long userId, String pluginId, String pluginType)
PluginSetting	updatePluginSetting(long companyId, String pluginId, String pluginType, String roles, boolean active)
PluginSetting	updatePluginSetting(PluginSetting pluginSetting) Updates the plugin setting in the database or adds it if it does not yet exist.

Method Detail

addPluginSetting

@Indexable(type=REINDEX)
PluginSetting addPluginSetting(PluginSetting pluginSetting)

Adds the plugin setting to the database. Also notifies the appropriate model listeners.

Parameters:

pluginSetting - the plugin setting

Returns:

the plugin setting that was added

checkPermission

void checkPermission(long userId,
                     String pluginId,
                     String pluginType)
              throws PortalException

Throws:

PortalException

createPluginSetting

@Transactional(enabled=false)
PluginSetting createPluginSetting(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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deletePluginSetting

@Indexable(type=DELETE)
PluginSetting deletePluginSetting(long pluginSettingId)
                                                   throws PortalException

Deletes 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:

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

deletePluginSetting

@Indexable(type=DELETE)
PluginSetting deletePluginSetting(PluginSetting pluginSetting)

Deletes the plugin setting from the database. Also notifies the appropriate model listeners.

Parameters:

pluginSetting - the plugin setting

Returns:

the plugin setting that was removed

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end)

Performs a dynamic query on the database and returns a range of the matching rows.

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:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

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

Returns:

the ordered range of matching rows

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchPluginSetting

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PluginSetting fetchPluginSetting(long pluginSettingId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getDefaultPluginSetting

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PluginSetting getDefaultPluginSetting()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getPluginSetting

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PluginSetting getPluginSetting(long pluginSettingId)
                                                                                           throws PortalException

Returns the plugin setting with the primary key.

Parameters:

pluginSettingId - the primary key of the plugin setting

Returns:

the plugin setting

Throws:

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

getPluginSetting

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PluginSetting getPluginSetting(long companyId,
                                                                                                  String pluginId,
                                                                                                  String pluginType)

getPluginSettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PluginSetting> getPluginSettings(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

getPluginSettingsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPluginSettingsCount()

Returns the number of plugin settings.

Returns:

the number of plugin settings

hasPermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasPermission(long userId,
                                                                                         String pluginId,
                                                                                         String pluginType)

updatePluginSetting

PluginSetting updatePluginSetting(long companyId,
                                  String pluginId,
                                  String pluginType,
                                  String roles,
                                  boolean active)

updatePluginSetting

@Indexable(type=REINDEX)
PluginSetting updatePluginSetting(PluginSetting pluginSetting)

Updates the plugin setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

pluginSetting - the plugin setting

Returns:

the plugin setting that was updated