com.liferay.portal.service
Interface PluginSettingLocalService

All Known Implementing Classes:

PluginSettingLocalServiceBaseImpl, PluginSettingLocalServiceImpl, PluginSettingLocalServiceWrapper

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

The interface for the plugin setting local service.

Never modify or reference this interface directly. Always use PluginSettingLocalServiceUtil to access the plugin setting local service. Add custom service methods to PluginSettingLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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.

See Also:

PluginSettingLocalServiceUtil, PluginSettingLocalServiceBaseImpl, PluginSettingLocalServiceImpl

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

Method Summary

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.
void	deletePluginSetting(long pluginSettingId) Deletes the plugin setting with the primary key from the database.
void	deletePluginSetting(PluginSetting pluginSetting) Deletes the plugin setting from the database.
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
PluginSetting	getDefaultPluginSetting()
PluginSetting	getPluginSetting(long pluginSettingId) Gets the plugin setting with the primary key.
PluginSetting	getPluginSetting(long companyId, String pluginId, String pluginType)
List<PluginSetting>	getPluginSettings(int start, int end) Gets a range of all the plugin settings.
int	getPluginSettingsCount() Gets 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.
PluginSetting	updatePluginSetting(PluginSetting pluginSetting, boolean merge) Updates the plugin setting in the database.

Method Detail

addPluginSetting

PluginSetting addPluginSetting(PluginSetting pluginSetting)
                               throws SystemException

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

Parameters:

pluginSetting - the plugin setting to add

Returns:

the plugin setting that was added

Throws:

SystemException - if a system exception occurred

createPluginSetting

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

deletePluginSetting

void deletePluginSetting(long pluginSettingId)
                         throws PortalException,
                                SystemException

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

Throws:

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

SystemException - if a system exception occurred

deletePluginSetting

void deletePluginSetting(PluginSetting pluginSetting)
                         throws SystemException

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

Parameters:

pluginSetting - the plugin setting to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

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

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getPluginSetting

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

Gets the plugin setting with the primary key.

Parameters:

pluginSettingId - the primary key of the plugin setting to get

Returns:

the plugin setting

Throws:

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

SystemException - if a system exception occurred

getPluginSettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PluginSetting> getPluginSettings(int start,
                                                                               int end)
                                      throws SystemException

Gets 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

getPluginSettingsCount

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

Gets the number of plugin settings.

Returns:

the number of plugin settings

Throws:

SystemException - if a system exception occurred

updatePluginSetting

PluginSetting updatePluginSetting(PluginSetting pluginSetting)
                                  throws SystemException

Updates the plugin setting in the database. Also notifies the appropriate model listeners.

Parameters:

pluginSetting - the plugin setting to update

Returns:

the plugin setting that was updated

Throws:

SystemException - if a system exception occurred

updatePluginSetting

PluginSetting updatePluginSetting(PluginSetting pluginSetting,
                                  boolean merge)
                                  throws SystemException

Updates the plugin setting in the database. Also notifies the appropriate model listeners.

Parameters:

pluginSetting - the plugin setting to update

merge - whether to merge the plugin setting with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the plugin setting that was updated

Throws:

SystemException - if a system exception occurred

checkPermission

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

Throws:

PortalException

getDefaultPluginSetting

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

getPluginSetting

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

Throws:

SystemException

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)
                                  throws SystemException

Throws:

SystemException