Liferay 6.2.0

com.liferay.portal.service
Interface PluginSettingLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
PluginSettingLocalServiceBaseImpl, PluginSettingLocalServiceImpl, 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.

See Also:
PluginSettingLocalServiceUtil, PluginSettingLocalServiceBaseImpl, PluginSettingLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
abstract  PluginSetting addPluginSetting(PluginSetting pluginSetting)
          Adds the plugin setting to the database.
abstract  void checkPermission(long userId, String pluginId, String pluginType)
           
abstract  PluginSetting createPluginSetting(long pluginSettingId)
          Creates a new plugin setting with the primary key.
abstract  PluginSetting deletePluginSetting(long pluginSettingId)
          Deletes the plugin setting with the primary key from the database.
abstract  PluginSetting deletePluginSetting(PluginSetting pluginSetting)
          Deletes the plugin setting from the database.
abstract  DynamicQuery dynamicQuery()
           
abstract  List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
abstract  List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
abstract  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.
abstract  long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
abstract  long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
abstract  PluginSetting fetchPluginSetting(long pluginSettingId)
           
abstract  String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
abstract  PluginSetting getDefaultPluginSetting()
           
abstract  PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
abstract  PluginSetting getPluginSetting(long pluginSettingId)
          Returns the plugin setting with the primary key.
abstract  PluginSetting getPluginSetting(long companyId, String pluginId, String pluginType)
           
abstract  List<PluginSetting> getPluginSettings(int start, int end)
          Returns a range of all the plugin settings.
abstract  int getPluginSettingsCount()
          Returns the number of plugin settings.
abstract  boolean hasPermission(long userId, String pluginId, String pluginType)
           
abstract  void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
abstract  PluginSetting updatePluginSetting(long companyId, String pluginId, String pluginType, String roles, boolean active)
           
abstract  PluginSetting updatePluginSetting(PluginSetting pluginSetting)
          Updates the plugin setting in the database or adds it if it does not yet exist.
 

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

PluginSetting 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
Returns:
the plugin setting that was removed
Throws:
PortalException - if a plugin setting with the primary key could not be found
SystemException - if a system exception occurred

deletePluginSetting

PluginSetting deletePluginSetting(PluginSetting pluginSetting)
                                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
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. 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
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. 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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchPluginSetting

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PluginSetting fetchPluginSetting(long pluginSettingId)
                                 throws SystemException
Throws:
SystemException

getPluginSetting

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PluginSetting getPluginSetting(long pluginSettingId)
                               throws PortalException,
                                      SystemException
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
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getPluginSettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PluginSetting> getPluginSettings(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. 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
Throws:
SystemException - if a system exception occurred

getPluginSettingsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPluginSettingsCount()
                           throws SystemException
Returns 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 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
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

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

Liferay 6.2.0