@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface PluginSettingLocalService extends BaseLocalService, PersistedModelLocalService
PluginSettingLocalServiceUtil
Modifier and Type | Method and Description |
---|---|
PluginSetting |
addPluginSetting(PluginSetting pluginSetting)
Adds the plugin setting to the database.
|
void |
checkPermission(long userId,
String pluginId,
String pluginType) |
PersistedModel |
createPersistedModel(Serializable primaryKeyObj) |
PluginSetting |
createPluginSetting(long pluginSettingId)
Creates a new plugin setting with the primary key.
|
PersistedModel |
deletePersistedModel(PersistedModel persistedModel) |
PluginSetting |
deletePluginSetting(long pluginSettingId)
Deletes the plugin setting with the primary key from the database.
|
PluginSetting |
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) |
DynamicQuery |
dynamicQuery() |
<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.
|
PluginSetting |
fetchPluginSetting(long pluginSettingId) |
ActionableDynamicQuery |
getActionableDynamicQuery() |
PluginSetting |
getDefaultPluginSetting() |
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
PluginSetting |
getPluginSetting(long pluginSettingId)
Returns the plugin setting with the primary key.
|
PluginSetting |
getPluginSetting(long companyId,
String pluginId,
String pluginType) |
List<PluginSetting> |
getPluginSettings(int start,
int end)
Returns a range of all the plugin settings.
|
int |
getPluginSettingsCount()
Returns 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 or adds it if it does not yet exist.
|
getBasePersistence
@Indexable(type=REINDEX) PluginSetting addPluginSetting(PluginSetting pluginSetting)
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.
pluginSetting
- the plugin setting@Transactional(propagation=SUPPORTS, readOnly=true) void checkPermission(long userId, String pluginId, String pluginType) throws PortalException
PortalException
PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
createPersistedModel
in interface PersistedModelLocalService
PortalException
@Transactional(enabled=false) PluginSetting createPluginSetting(long pluginSettingId)
pluginSettingId
- the primary key for the new plugin settingPersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
deletePersistedModel
in interface PersistedModelLocalService
PortalException
@Indexable(type=DELETE) PluginSetting deletePluginSetting(long pluginSettingId) throws PortalException
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.
pluginSettingId
- the primary key of the plugin settingPortalException
- if a plugin setting with the primary key could not be found@Indexable(type=DELETE) PluginSetting deletePluginSetting(PluginSetting pluginSetting)
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.
pluginSetting
- the plugin setting@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQuery
in interface PersistedModelLocalService
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQueryCount
in interface PersistedModelLocalService
@Transactional(propagation=SUPPORTS, readOnly=true) DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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
.
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 (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query@Transactional(propagation=SUPPORTS, readOnly=true) PluginSetting fetchPluginSetting(long pluginSettingId)
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(enabled=false) PluginSetting getDefaultPluginSetting()
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
getPersistedModel
in interface PersistedModelLocalService
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) PluginSetting getPluginSetting(long pluginSettingId) throws PortalException
pluginSettingId
- the primary key of the plugin settingPortalException
- if a plugin setting with the primary key could not be found@Transactional(propagation=SUPPORTS, readOnly=true) PluginSetting getPluginSetting(long companyId, String pluginId, String pluginType)
@Transactional(propagation=SUPPORTS, readOnly=true) List<PluginSetting> getPluginSettings(int start, int end)
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
.
start
- the lower bound of the range of plugin settingsend
- the upper bound of the range of plugin settings (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) int getPluginSettingsCount()
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasPermission(long userId, String pluginId, String pluginType)
PluginSetting updatePluginSetting(long companyId, String pluginId, String pluginType, String roles, boolean active)
@Indexable(type=REINDEX) PluginSetting updatePluginSetting(PluginSetting pluginSetting)
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.
pluginSetting
- the plugin setting