Class PluginSettingLocalServiceUtil
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PluginSetting
addPluginSetting
(PluginSetting pluginSetting) Adds the plugin setting to the database.static void
checkPermission
(long userId, String pluginId, String pluginType) static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static PluginSetting
createPluginSetting
(long pluginSettingId) Creates a new plugin setting with the primary key.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static PluginSetting
deletePluginSetting
(long pluginSettingId) Deletes the plugin setting with the primary key from the database.static PluginSetting
deletePluginSetting
(PluginSetting pluginSetting) Deletes the plugin setting from the database.static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.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.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.static long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static PluginSetting
fetchPluginSetting
(long pluginSettingId) static ActionableDynamicQuery
static PluginSetting
static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static PluginSetting
getPluginSetting
(long pluginSettingId) Returns the plugin setting with the primary key.static PluginSetting
getPluginSetting
(long companyId, String pluginId, String pluginType) static List<PluginSetting>
getPluginSettings
(int start, int end) Returns a range of all the plugin settings.static int
Returns the number of plugin settings.static PluginSettingLocalService
static boolean
hasPermission
(long userId, String pluginId, String pluginType) static void
setService
(PluginSettingLocalService service) static PluginSetting
updatePluginSetting
(long companyId, String pluginId, String pluginType, String roles, boolean active) static PluginSetting
updatePluginSetting
(PluginSetting pluginSetting) Updates the plugin setting in the database or adds it if it does not yet exist.
-
Constructor Details
-
PluginSettingLocalServiceUtil
public PluginSettingLocalServiceUtil()
-
-
Method Details
-
addPluginSetting
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
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
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
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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PluginSettingModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PluginSettingModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchPluginSetting
-
getActionableDynamicQuery
-
getDefaultPluginSetting
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getPluginSetting
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
-
getPluginSettings
Returns a range of all the plugin settings.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PluginSettingModelImpl
.- Parameters:
start
- the lower bound of the range of plugin settingsend
- 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
-
updatePluginSetting
public static PluginSetting updatePluginSetting(long companyId, String pluginId, String pluginType, String roles, boolean active) -
updatePluginSetting
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
-
setService
-