Class PluginSettingLocalServiceUtil

Object
com.liferay.portal.kernel.service.PluginSettingLocalServiceUtil

public class PluginSettingLocalServiceUtil extends Object
Provides the local service utility for PluginSetting. This utility wraps com.liferay.portal.service.impl.PluginSettingLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:
{$generated.description}
  • Constructor Details

    • PluginSettingLocalServiceUtil

      public PluginSettingLocalServiceUtil()
  • Method Details

    • addPluginSetting

      public static PluginSetting addPluginSetting(PluginSetting pluginSetting)
      Adds the plugin setting to the database. Also notifies the appropriate model listeners.

      Important: Inspect PluginSettingLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      pluginSetting - the plugin setting
      Returns:
      the plugin setting that was added
    • checkPermission

      public static void checkPermission(long userId, String pluginId, String pluginType) throws PortalException
      Throws:
      PortalException
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • createPluginSetting

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

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deletePluginSetting

      public static PluginSetting deletePluginSetting(long pluginSettingId) throws PortalException
      Deletes the plugin setting with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect PluginSettingLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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

      public static PluginSetting deletePluginSetting(PluginSetting pluginSetting)
      Deletes the plugin setting from the database. Also notifies the appropriate model listeners.

      Important: Inspect PluginSettingLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      pluginSetting - the plugin setting
      Returns:
      the plugin setting that was removed
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static DynamicQuery dynamicQuery()
    • dynamicQuery

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

      public static <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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PluginSettingModelImpl.

      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

      public static <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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PluginSettingModelImpl.

      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

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

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

      public static PluginSetting fetchPluginSetting(long pluginSettingId)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getDefaultPluginSetting

      public static PluginSetting getDefaultPluginSetting()
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getPluginSetting

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

      public static PluginSetting getPluginSetting(long companyId, String pluginId, String pluginType)
    • getPluginSettings

      public static 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PluginSettingModelImpl.

      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

      public static int getPluginSettingsCount()
      Returns the number of plugin settings.
      Returns:
      the number of plugin settings
    • hasPermission

      public static boolean hasPermission(long userId, String pluginId, String pluginType)
    • updatePluginSetting

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

      public static 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.

      Important: Inspect PluginSettingLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      pluginSetting - the plugin setting
      Returns:
      the plugin setting that was updated
    • getService

      public static PluginSettingLocalService getService()
    • setService

      public static void setService(PluginSettingLocalService service)