Interface PluginSettingLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
PluginSettingLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddPluginSetting
(PluginSetting pluginSetting) Adds the plugin setting to the database.void
checkPermission
(long userId, String pluginId, String pluginType) createPersistedModel
(Serializable primaryKeyObj) createPluginSetting
(long pluginSettingId) Creates a new plugin setting with the primary key.deletePersistedModel
(PersistedModel persistedModel) deletePluginSetting
(long pluginSettingId) Deletes the plugin setting with the primary key from the database.deletePluginSetting
(PluginSetting pluginSetting) Deletes the plugin setting from the database.<T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchPluginSetting
(long pluginSettingId) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getPluginSetting
(long pluginSettingId) Returns the plugin setting with the primary key.getPluginSetting
(long companyId, String pluginId, String pluginType) getPluginSettings
(int start, int end) Returns a range of all the plugin settings.int
Returns the number of plugin settings.boolean
hasPermission
(long userId, String pluginId, String pluginType) updatePluginSetting
(long companyId, String pluginId, String pluginType, String roles, boolean active) updatePluginSetting
(PluginSetting pluginSetting) Updates the plugin setting in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
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
@Transactional(propagation=SUPPORTS, readOnly=true) void checkPermission(long userId, String pluginId, String pluginType) throws PortalException - Throws:
PortalException
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- 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
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- 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.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
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
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
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
@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
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
@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 queryprojection
- 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
-
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 interfacePersistedModelLocalService
- 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
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
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
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
-