Class SocialActivitySettingLocalServiceUtil
com.liferay.portlet.social.service.impl.SocialActivitySettingLocalServiceImpl
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 SocialActivitySetting
addSocialActivitySetting
(SocialActivitySetting socialActivitySetting) Adds the social activity setting to the database.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static SocialActivitySetting
createSocialActivitySetting
(long activitySettingId) Creates a new social activity setting with the primary key.static void
deleteActivitySetting
(long groupId, String className, long classPK) static void
deleteActivitySettings
(long groupId) static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static SocialActivitySetting
deleteSocialActivitySetting
(long activitySettingId) Deletes the social activity setting with the primary key from the database.static SocialActivitySetting
deleteSocialActivitySetting
(SocialActivitySetting socialActivitySetting) Deletes the social activity 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 SocialActivitySetting
fetchSocialActivitySetting
(long activitySettingId) static ActionableDynamicQuery
static SocialActivityDefinition
getActivityDefinition
(long groupId, String className, int activityType) static List<SocialActivityDefinition>
getActivityDefinitions
(long groupId, String className) static List<SocialActivitySetting>
getActivitySettings
(long groupId) static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static SocialActivitySetting
getSocialActivitySetting
(long activitySettingId) Returns the social activity setting with the primary key.static List<SocialActivitySetting>
getSocialActivitySettings
(int start, int end) Returns a range of all the social activity settings.static int
Returns the number of social activity settings.static boolean
isEnabled
(long groupId, long classNameId) static boolean
isEnabled
(long groupId, long classNameId, long classPK) static void
static void
updateActivitySetting
(long groupId, String className, boolean enabled) static void
updateActivitySetting
(long groupId, String className, int activityType, SocialActivityCounterDefinition activityCounterDefinition) static void
updateActivitySetting
(long groupId, String className, long classPK, boolean enabled) static void
updateActivitySettings
(long groupId, String className, int activityType, List<SocialActivityCounterDefinition> activityCounterDefinitions) static SocialActivitySetting
updateSocialActivitySetting
(SocialActivitySetting socialActivitySetting) Updates the social activity setting in the database or adds it if it does not yet exist.
-
Constructor Details
-
SocialActivitySettingLocalServiceUtil
public SocialActivitySettingLocalServiceUtil()
-
-
Method Details
-
addSocialActivitySetting
public static 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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createSocialActivitySetting
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
public static void deleteActivitySettings(long groupId) -
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteSocialActivitySetting
public static 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
public static 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
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.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
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.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
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
-
fetchSocialActivitySetting
-
getActionableDynamicQuery
-
getActivityDefinition
public static SocialActivityDefinition getActivityDefinition(long groupId, String className, int activityType) -
getActivityDefinitions
-
getActivitySettings
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getSocialActivitySetting
public static 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
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
public static int getSocialActivitySettingsCount()Returns the number of social activity settings.- Returns:
- the number of social activity settings
-
isEnabled
public static boolean isEnabled(long groupId, long classNameId) -
isEnabled
public static boolean isEnabled(long groupId, long classNameId, long classPK) -
updateActivitySetting
public static void updateActivitySetting(long groupId, String className, boolean enabled) throws PortalException - Throws:
PortalException
-
updateActivitySetting
public static void updateActivitySetting(long groupId, String className, int activityType, SocialActivityCounterDefinition activityCounterDefinition) throws PortalException - Throws:
PortalException
-
updateActivitySetting
public static void updateActivitySetting(long groupId, String className, long classPK, boolean enabled) throws PortalException - Throws:
PortalException
-
updateActivitySettings
public static void updateActivitySettings(long groupId, String className, int activityType, List<SocialActivityCounterDefinition> activityCounterDefinitions) throws PortalException - Throws:
PortalException
-
updateSocialActivitySetting
public static 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
-
getService
-
setService
-