Interface SocialActivitySettingLocalService
- All Superinterfaces:
BaseLocalService
,CTService<SocialActivitySetting>
,PersistedModelLocalService
- All Known Implementing Classes:
SocialActivitySettingLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddSocialActivitySetting
(SocialActivitySetting socialActivitySetting) Adds the social activity setting to the database.createPersistedModel
(Serializable primaryKeyObj) createSocialActivitySetting
(long activitySettingId) Creates a new social activity setting with the primary key.void
deleteActivitySetting
(long groupId, String className, long classPK) void
deleteActivitySettings
(long groupId) deletePersistedModel
(PersistedModel persistedModel) deleteSocialActivitySetting
(long activitySettingId) Deletes the social activity setting with the primary key from the database.deleteSocialActivitySetting
(SocialActivitySetting socialActivitySetting) Deletes the social activity 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.fetchSocialActivitySetting
(long activitySettingId) getActivityDefinition
(long groupId, String className, int activityType) getActivityDefinitions
(long groupId, String className) getActivitySettings
(long groupId) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getSocialActivitySetting
(long activitySettingId) Returns the social activity setting with the primary key.getSocialActivitySettings
(int start, int end) Returns a range of all the social activity settings.int
Returns the number of social activity settings.boolean
isEnabled
(long groupId, long classNameId) boolean
isEnabled
(long groupId, long classNameId, long classPK) void
updateActivitySetting
(long groupId, String className, boolean enabled) void
updateActivitySetting
(long groupId, String className, int activityType, SocialActivityCounterDefinition activityCounterDefinition) void
updateActivitySetting
(long groupId, String className, long classPK, boolean enabled) void
updateActivitySettings
(long groupId, String className, int activityType, List<SocialActivityCounterDefinition> activityCounterDefinitions) updateSocialActivitySetting
(SocialActivitySetting socialActivitySetting) Updates the social activity setting in the database or adds it if it does not yet exist.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<SocialActivitySetting>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addSocialActivitySetting
@Indexable(type=REINDEX) SocialActivitySetting addSocialActivitySetting(SocialActivitySetting socialActivitySetting) Adds the social activity setting to the database. Also notifies the appropriate model listeners.Important: Inspect SocialActivitySettingLocalServiceImpl 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:
socialActivitySetting
- the social activity setting- Returns:
- the social activity setting that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createSocialActivitySetting
@Transactional(enabled=false) SocialActivitySetting createSocialActivitySetting(long activitySettingId) Creates a new social activity setting with the primary key. Does not add the social activity setting to the database.- Parameters:
activitySettingId
- the primary key for the new social activity setting- Returns:
- the new social activity setting
-
deleteActivitySetting
-
deleteActivitySettings
void deleteActivitySettings(long groupId) -
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteSocialActivitySetting
@Indexable(type=DELETE) SocialActivitySetting deleteSocialActivitySetting(long activitySettingId) throws PortalException Deletes the social activity setting with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect SocialActivitySettingLocalServiceImpl 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:
activitySettingId
- the primary key of the social activity setting- Returns:
- the social activity setting that was removed
- Throws:
PortalException
- if a social activity setting with the primary key could not be found
-
deleteSocialActivitySetting
@Indexable(type=DELETE) SocialActivitySetting deleteSocialActivitySetting(SocialActivitySetting socialActivitySetting) Deletes the social activity setting from the database. Also notifies the appropriate model listeners.Important: Inspect SocialActivitySettingLocalServiceImpl 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:
socialActivitySetting
- the social activity setting- Returns:
- the social activity 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.portlet.social.model.impl.SocialActivitySettingModelImpl
.- 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.portlet.social.model.impl.SocialActivitySettingModelImpl
.- 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
-
fetchSocialActivitySetting
@Transactional(propagation=SUPPORTS, readOnly=true) SocialActivitySetting fetchSocialActivitySetting(long activitySettingId) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getActivityDefinition
@Transactional(propagation=SUPPORTS, readOnly=true) SocialActivityDefinition getActivityDefinition(long groupId, String className, int activityType) -
getActivityDefinitions
@Transactional(propagation=SUPPORTS, readOnly=true) List<SocialActivityDefinition> getActivityDefinitions(long groupId, String className) -
getActivitySettings
@Transactional(propagation=SUPPORTS, readOnly=true) List<SocialActivitySetting> getActivitySettings(long groupId) -
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
-
getSocialActivitySetting
@Transactional(propagation=SUPPORTS, readOnly=true) SocialActivitySetting getSocialActivitySetting(long activitySettingId) throws PortalException Returns the social activity setting with the primary key.- Parameters:
activitySettingId
- the primary key of the social activity setting- Returns:
- the social activity setting
- Throws:
PortalException
- if a social activity setting with the primary key could not be found
-
getSocialActivitySettings
@Transactional(propagation=SUPPORTS, readOnly=true) List<SocialActivitySetting> getSocialActivitySettings(int start, int end) Returns a range of all the social activity 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.portlet.social.model.impl.SocialActivitySettingModelImpl
.- Parameters:
start
- the lower bound of the range of social activity settingsend
- the upper bound of the range of social activity settings (not inclusive)- Returns:
- the range of social activity settings
-
getSocialActivitySettingsCount
Returns the number of social activity settings.- Returns:
- the number of social activity settings
-
isEnabled
@Transactional(propagation=SUPPORTS, readOnly=true) boolean isEnabled(long groupId, long classNameId) -
isEnabled
@Transactional(propagation=SUPPORTS, readOnly=true) boolean isEnabled(long groupId, long classNameId, long classPK) -
updateActivitySetting
- Throws:
PortalException
-
updateActivitySetting
void updateActivitySetting(long groupId, String className, int activityType, SocialActivityCounterDefinition activityCounterDefinition) throws PortalException - Throws:
PortalException
-
updateActivitySetting
void updateActivitySetting(long groupId, String className, long classPK, boolean enabled) throws PortalException - Throws:
PortalException
-
updateActivitySettings
void updateActivitySettings(long groupId, String className, int activityType, List<SocialActivityCounterDefinition> activityCounterDefinitions) throws PortalException - Throws:
PortalException
-
updateSocialActivitySetting
@Indexable(type=REINDEX) SocialActivitySetting updateSocialActivitySetting(SocialActivitySetting socialActivitySetting) Updates the social activity setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect SocialActivitySettingLocalServiceImpl 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:
socialActivitySetting
- the social activity setting- Returns:
- the social activity setting that was updated
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<SocialActivitySetting>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<SocialActivitySetting>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<SocialActivitySetting>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<SocialActivitySetting>
- Throws:
E extends Throwable
-