Liferay 6.2-ce-ga5

com.liferay.portlet.social.service
Class SocialActivityCounterLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.social.service.SocialActivityCounterLocalServiceUtil

@ProviderType
public class SocialActivityCounterLocalServiceUtil
extends Object

Provides the local service utility for SocialActivityCounter. This utility wraps SocialActivityCounterLocalServiceImpl and is the primary 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.

See Also:
SocialActivityCounterLocalService, SocialActivityCounterLocalServiceBaseImpl, SocialActivityCounterLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
SocialActivityCounterLocalServiceUtil()
           
 
Method Summary
static SocialActivityCounter addActivityCounter(long groupId, long classNameId, long classPK, String name, int ownerType, int currentValue, int totalValue, int startPeriod, int endPeriod)
          Deprecated. As of 6.2.0, replaced by addActivityCounter(long, long, long, String, int, int, long, int)
static SocialActivityCounter addActivityCounter(long groupId, long classNameId, long classPK, String name, int ownerType, int currentValue, int totalValue, int startPeriod, int endPeriod, long previousActivityCounterId, int periodLength)
          Deprecated. As of 6.2.0, replaced by addActivityCounter(long, long, long, String, int, int, long, int)
static SocialActivityCounter addActivityCounter(long groupId, long classNameId, long classPK, String name, int ownerType, int totalValue, long previousActivityCounterId, int periodLength)
          Adds an activity counter specifying a previous activity and period length.
static void addActivityCounters(SocialActivity activity)
          Adds or increments activity counters related to an activity.
static SocialActivityCounter addSocialActivityCounter(SocialActivityCounter socialActivityCounter)
          Adds the social activity counter to the database.
static SocialActivityCounter createActivityCounter(long groupId, long classNameId, long classPK, String name, int ownerType, int currentValue, int totalValue, int startPeriod, int endPeriod)
          Deprecated. As of 6.2.0, replaced by addActivityCounter(long, long, long, String, int, int, long, int)
static SocialActivityCounter createActivityCounter(long groupId, long classNameId, long classPK, String name, int ownerType, int currentValue, int totalValue, int startPeriod, int endPeriod, long previousActivityCounterId, int periodLength)
          Deprecated. As of 6.2.0, replaced by addActivityCounter(long, long, long, String, int, int, long, int)
static SocialActivityCounter createSocialActivityCounter(long activityCounterId)
          Creates a new social activity counter with the primary key.
static void deleteActivityCounters(AssetEntry assetEntry)
          Deletes all activity counters, limits, and settings related to the asset.
static void deleteActivityCounters(long classNameId, long classPK)
          Deletes all activity counters, limits, and settings related to the entity identified by the class name ID and class primary key.
static void deleteActivityCounters(String className, long classPK)
          Deletes all activity counters for the entity identified by the class name and class primary key.
static SocialActivityCounter deleteSocialActivityCounter(long activityCounterId)
          Deletes the social activity counter with the primary key from the database.
static SocialActivityCounter deleteSocialActivityCounter(SocialActivityCounter socialActivityCounter)
          Deletes the social activity counter from the database.
static void disableActivityCounters(long classNameId, long classPK)
          Disables all the counters of an asset identified by the class name ID and class primary key.
static void disableActivityCounters(String className, long classPK)
          Disables all the counters of an asset identified by the class name and class primary key.
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static void enableActivityCounters(long classNameId, long classPK)
          Enables all activity counters of an asset identified by the class name ID and class primary key.
static void enableActivityCounters(String className, long classPK)
          Enables all the counters of an asset identified by the class name and class primary key.
static SocialActivityCounter fetchActivityCounterByEndPeriod(long groupId, long classNameId, long classPK, String name, int ownerType, int endPeriod)
          Returns the activity counter with the given name, owner, and end period that belong to the given entity.
static SocialActivityCounter fetchActivityCounterByStartPeriod(long groupId, long classNameId, long classPK, String name, int ownerType, int startPeriod)
          Returns the activity counter with the given name, owner, and start period that belong to the given entity.
static SocialActivityCounter fetchLatestActivityCounter(long groupId, long classNameId, long classPK, String name, int ownerType)
          Returns the latest activity counter with the given name and owner that belong to the given entity.
static SocialActivityCounter fetchSocialActivityCounter(long activityCounterId)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static List<SocialActivityCounter> getOffsetActivityCounters(long groupId, String name, int startOffset, int endOffset)
          Returns all the activity counters with the given name and period offsets.
static List<SocialActivityCounter> getOffsetDistributionActivityCounters(long groupId, String name, int startOffset, int endOffset)
          Returns the distribution of the activity counters with the given name and period offsets.
static List<SocialActivityCounter> getPeriodActivityCounters(long groupId, String name, int startPeriod, int endPeriod)
          Returns all the activity counters with the given name and time period.
static List<SocialActivityCounter> getPeriodDistributionActivityCounters(long groupId, String name, int startPeriod, int endPeriod)
          Returns the distribution of activity counters with the given name and time period.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static SocialActivityCounterLocalService getService()
           
static SocialActivityCounter getSocialActivityCounter(long activityCounterId)
          Returns the social activity counter with the primary key.
static List<SocialActivityCounter> getSocialActivityCounters(int start, int end)
          Returns a range of all the social activity counters.
static int getSocialActivityCountersCount()
          Returns the number of social activity counters.
static List<Tuple> getUserActivityCounters(long groupId, String[] rankingNames, String[] selectedNames, int start, int end)
          Returns the range of tuples that contain users and a list of activity counters.
static int getUserActivityCountersCount(long groupId, String[] rankingNames)
          Returns the number of users having a rank based on the given counters.
static void incrementUserAchievementCounter(long userId, long groupId)
          Increments the user.achievements counter for a user.
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(SocialActivityCounterLocalService service)
          Deprecated. As of 6.2.0
static SocialActivityCounter updateSocialActivityCounter(SocialActivityCounter socialActivityCounter)
          Updates the social activity counter in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SocialActivityCounterLocalServiceUtil

public SocialActivityCounterLocalServiceUtil()
Method Detail

addSocialActivityCounter

public static SocialActivityCounter addSocialActivityCounter(SocialActivityCounter socialActivityCounter)
                                                      throws SystemException
Adds the social activity counter to the database. Also notifies the appropriate model listeners.

Parameters:
socialActivityCounter - the social activity counter
Returns:
the social activity counter that was added
Throws:
SystemException - if a system exception occurred

createSocialActivityCounter

public static SocialActivityCounter createSocialActivityCounter(long activityCounterId)
Creates a new social activity counter with the primary key. Does not add the social activity counter to the database.

Parameters:
activityCounterId - the primary key for the new social activity counter
Returns:
the new social activity counter

deleteSocialActivityCounter

public static SocialActivityCounter deleteSocialActivityCounter(long activityCounterId)
                                                         throws PortalException,
                                                                SystemException
Deletes the social activity counter with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
activityCounterId - the primary key of the social activity counter
Returns:
the social activity counter that was removed
Throws:
PortalException - if a social activity counter with the primary key could not be found
SystemException - if a system exception occurred

deleteSocialActivityCounter

public static SocialActivityCounter deleteSocialActivityCounter(SocialActivityCounter socialActivityCounter)
                                                         throws SystemException
Deletes the social activity counter from the database. Also notifies the appropriate model listeners.

Parameters:
socialActivityCounter - the social activity counter
Returns:
the social activity counter that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException
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 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from SocialActivityCounterModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException
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 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from SocialActivityCounterModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchSocialActivityCounter

public static SocialActivityCounter fetchSocialActivityCounter(long activityCounterId)
                                                        throws SystemException
Throws:
SystemException

getSocialActivityCounter

public static SocialActivityCounter getSocialActivityCounter(long activityCounterId)
                                                      throws PortalException,
                                                             SystemException
Returns the social activity counter with the primary key.

Parameters:
activityCounterId - the primary key of the social activity counter
Returns:
the social activity counter
Throws:
PortalException - if a social activity counter with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getSocialActivityCounters

public static List<SocialActivityCounter> getSocialActivityCounters(int start,
                                                                    int end)
                                                             throws SystemException
Returns a range of all the social activity counters.

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from SocialActivityCounterModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
start - the lower bound of the range of social activity counters
end - the upper bound of the range of social activity counters (not inclusive)
Returns:
the range of social activity counters
Throws:
SystemException - if a system exception occurred

getSocialActivityCountersCount

public static int getSocialActivityCountersCount()
                                          throws SystemException
Returns the number of social activity counters.

Returns:
the number of social activity counters
Throws:
SystemException - if a system exception occurred

updateSocialActivityCounter

public static SocialActivityCounter updateSocialActivityCounter(SocialActivityCounter socialActivityCounter)
                                                         throws SystemException
Updates the social activity counter in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
socialActivityCounter - the social activity counter
Returns:
the social activity counter that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addActivityCounter

public static SocialActivityCounter addActivityCounter(long groupId,
                                                       long classNameId,
                                                       long classPK,
                                                       String name,
                                                       int ownerType,
                                                       int currentValue,
                                                       int totalValue,
                                                       int startPeriod,
                                                       int endPeriod)
                                                throws PortalException,
                                                       SystemException
Deprecated. As of 6.2.0, replaced by addActivityCounter(long, long, long, String, int, int, long, int)

Adds an activity counter with a default period length.

This method uses the lock service to guard against multiple threads trying to insert the same counter because this service is called asynchronously from the social activity service.

Parameters:
groupId - the primary key of the group
classNameId - the primary key of the entity's class this counter belongs to
classPK - the primary key of the entity this counter belongs to
name - the counter's name
ownerType - the counter's owner type. Acceptable values are TYPE_ACTOR, TYPE_ASSET and TYPE_CREATOR defined in SocialActivityCounterConstants.
currentValue - the counter's current value (optionally 0)
totalValue - the counter's total value (optionally 0)
startPeriod - the counter's start period
endPeriod - the counter's end period
Returns:
the added activity counter
Throws:
PortalException - if the group or the previous activity counter could not be found
SystemException - if a system exception occurred

addActivityCounter

public static SocialActivityCounter addActivityCounter(long groupId,
                                                       long classNameId,
                                                       long classPK,
                                                       String name,
                                                       int ownerType,
                                                       int currentValue,
                                                       int totalValue,
                                                       int startPeriod,
                                                       int endPeriod,
                                                       long previousActivityCounterId,
                                                       int periodLength)
                                                throws PortalException,
                                                       SystemException
Deprecated. As of 6.2.0, replaced by addActivityCounter(long, long, long, String, int, int, long, int)

Adds an activity counter specifying a previous activity and period length.

This method uses the lock service to guard against multiple threads trying to insert the same counter because this service is called asynchronously from the social activity service.

Parameters:
groupId - the primary key of the group
classNameId - the primary key of the entity's class this counter belongs to
classPK - the primary key of the entity this counter belongs to
name - the counter name
ownerType - the counter's owner type. Acceptable values are TYPE_ACTOR, TYPE_ASSET and TYPE_CREATOR defined in SocialActivityCounterConstants.
currentValue - the current value of the counter (optionally 0)
totalValue - the counter's total value (optionally 0)
startPeriod - the counter's start period
endPeriod - the counter's end period
previousActivityCounterId - the primary key of the activity counter for the previous time period (optionally 0, if this is the first)
periodLength - the period length in days, PERIOD_LENGTH_INFINITE for never ending counters or PERIOD_LENGTH_SYSTEM for the period length defined in portal-ext.properties. For more information see SocialActivityCounterConstants.
Returns:
the added activity counter
Throws:
PortalException - if the group or the previous activity counter could not be found
SystemException - if a system exception occurred

addActivityCounter

public static SocialActivityCounter addActivityCounter(long groupId,
                                                       long classNameId,
                                                       long classPK,
                                                       String name,
                                                       int ownerType,
                                                       int totalValue,
                                                       long previousActivityCounterId,
                                                       int periodLength)
                                                throws PortalException,
                                                       SystemException
Adds an activity counter specifying a previous activity and period length.

This method uses the lock service to guard against multiple threads trying to insert the same counter because this service is called asynchronously from the social activity service.

Parameters:
groupId - the primary key of the group
classNameId - the primary key of the entity's class this counter belongs to
classPK - the primary key of the entity this counter belongs to
name - the counter name
ownerType - the counter's owner type. Acceptable values are TYPE_ACTOR, TYPE_ASSET and TYPE_CREATOR defined in SocialActivityCounterConstants.
totalValue - the counter's total value (optionally 0)
previousActivityCounterId - the primary key of the activity counter for the previous time period (optionally 0, if this is the first)
periodLength - the period length in days, PERIOD_LENGTH_INFINITE for never ending counters or PERIOD_LENGTH_SYSTEM for the period length defined in portal-ext.properties. For more information see SocialActivityCounterConstants.
Returns:
the added activity counter
Throws:
PortalException - if the group or the previous activity counter could not be found
SystemException - if a system exception occurred

addActivityCounters

public static void addActivityCounters(SocialActivity activity)
                                throws PortalException,
                                       SystemException
Adds or increments activity counters related to an activity.

This method is called asynchronously from the social activity service when the user performs an activity defined in liferay-social.xml.

This method first calls the activity processor class, if there is one defined for the activity, checks for limits and increments all the counters that belong to the activity. Afterwards, it processes the activity with respect to achievement classes, if any. Lastly it increments the built-in user.activities and asset.activities counters.

Parameters:
activity - the social activity
Throws:
PortalException - if an expected group or expected previous activity counters could not be found
SystemException - if a system exception occurred

createActivityCounter

public static SocialActivityCounter createActivityCounter(long groupId,
                                                          long classNameId,
                                                          long classPK,
                                                          String name,
                                                          int ownerType,
                                                          int currentValue,
                                                          int totalValue,
                                                          int startPeriod,
                                                          int endPeriod)
                                                   throws PortalException,
                                                          SystemException
Deprecated. As of 6.2.0, replaced by addActivityCounter(long, long, long, String, int, int, long, int)

Creates an activity counter with a default period length, adding it into the database.

Parameters:
groupId - the primary key of the group
classNameId - the primary key of the entity's class this counter belongs to
classPK - the primary key of the entity this counter belongs to
name - the counter's name
ownerType - the counter's owner type. Acceptable values are TYPE_ACTOR, TYPE_ASSET and TYPE_CREATOR defined in SocialActivityCounterConstants.
currentValue - the counter's current value (optionally 0)
totalValue - the counter's total value (optionally 0)
startPeriod - the counter's start period
endPeriod - the counter's end period
Returns:
the created activity counter
Throws:
PortalException - if the group or a previous activity counter could not be found
SystemException - if a system exception occurred

createActivityCounter

public static SocialActivityCounter createActivityCounter(long groupId,
                                                          long classNameId,
                                                          long classPK,
                                                          String name,
                                                          int ownerType,
                                                          int currentValue,
                                                          int totalValue,
                                                          int startPeriod,
                                                          int endPeriod,
                                                          long previousActivityCounterId,
                                                          int periodLength)
                                                   throws PortalException,
                                                          SystemException
Deprecated. As of 6.2.0, replaced by addActivityCounter(long, long, long, String, int, int, long, int)

Creates an activity counter, adding it into the database.

This method actually creates the counter in the database. It requires a new transaction so that other threads can find the new counter when the lock in the calling method is released.

Parameters:
groupId - the primary key of the group
classNameId - the primary key of the entity's class this counter belongs to
classPK - the primary key of the entity this counter belongs to
name - the counter's name
ownerType - the counter's owner type. Acceptable values are TYPE_ACTOR, TYPE_ASSET and TYPE_CREATOR defined in SocialActivityCounterConstants.
currentValue - the counter's current value (optionally 0)
totalValue - the counter's total value of the counter (optionally 0)
startPeriod - the counter's start period
endPeriod - the counter's end period
previousActivityCounterId - the primary key of the activity counter for the previous time period (optionally 0, if this is the first)
periodLength - the period length in days, PERIOD_LENGTH_INFINITE for never ending counters or PERIOD_LENGTH_SYSTEM for the period length defined in portal-ext.properties. For more information see SocialActivityConstants.
Returns:
the created activity counter
Throws:
PortalException - if the group or the previous activity counter could not be found
SystemException - if a system exception occurred

deleteActivityCounters

public static void deleteActivityCounters(AssetEntry assetEntry)
                                   throws PortalException,
                                          SystemException
Deletes all activity counters, limits, and settings related to the asset.

This method subtracts the asset's popularity from the owner's contribution points. It also creates a new contribution period if the latest one does not belong to the current period.

Parameters:
assetEntry - the asset entry
Throws:
PortalException - if the new contribution counter could not be created
SystemException - if a system exception occurred

deleteActivityCounters

public static void deleteActivityCounters(long classNameId,
                                          long classPK)
                                   throws PortalException,
                                          SystemException
Deletes all activity counters, limits, and settings related to the entity identified by the class name ID and class primary key.

Parameters:
classNameId - the primary key of the entity's class
classPK - the primary key of the entity
Throws:
PortalException - if the entity is an asset and its owner's contribution counter could not be updated
SystemException - if a system exception occurred

deleteActivityCounters

public static void deleteActivityCounters(String className,
                                          long classPK)
                                   throws PortalException,
                                          SystemException
Deletes all activity counters for the entity identified by the class name and class primary key.

Parameters:
className - the entity's class name
classPK - the primary key of the entity
Throws:
PortalException - if the entity is an asset and its owner's contribution counter could not be updated
SystemException - if a system exception occurred

disableActivityCounters

public static void disableActivityCounters(long classNameId,
                                           long classPK)
                                    throws PortalException,
                                           SystemException
Disables all the counters of an asset identified by the class name ID and class primary key.

This method is used by the recycle bin to disable all counters of assets put into the recycle bin. It adjusts the owner's contribution score.

Parameters:
classNameId - the primary key of the asset's class
classPK - the primary key of the asset
Throws:
PortalException - if the asset owner's contribution counter could not be updated
SystemException - if a system exception occurred

disableActivityCounters

public static void disableActivityCounters(String className,
                                           long classPK)
                                    throws PortalException,
                                           SystemException
Disables all the counters of an asset identified by the class name and class primary key.

This method is used by the recycle bin to disable all counters of assets put into the recycle bin. It adjusts the owner's contribution score.

Parameters:
className - the asset's class name
classPK - the primary key of the asset
Throws:
PortalException - if the asset owner's contribution counter could not be updated
SystemException - if a system exception occurred

enableActivityCounters

public static void enableActivityCounters(long classNameId,
                                          long classPK)
                                   throws PortalException,
                                          SystemException
Enables all activity counters of an asset identified by the class name ID and class primary key.

This method is used by the recycle bin to enable all counters of assets restored from the recycle bin. It adjusts the owner's contribution score.

Parameters:
classNameId - the primary key of the asset's class
classPK - the primary key of the asset
Throws:
PortalException - if the asset owner's contribution counter could not be updated
SystemException - if a system exception occurred

enableActivityCounters

public static void enableActivityCounters(String className,
                                          long classPK)
                                   throws PortalException,
                                          SystemException
Enables all the counters of an asset identified by the class name and class primary key.

This method is used by the recycle bin to enable all counters of assets restored from the recycle bin. It adjusts the owner's contribution score.

Parameters:
className - the asset's class name
classPK - the primary key of the asset
Throws:
PortalException - if the asset owner's contribution counter could not be updated
SystemException - if a system exception occurred

fetchActivityCounterByEndPeriod

public static SocialActivityCounter fetchActivityCounterByEndPeriod(long groupId,
                                                                    long classNameId,
                                                                    long classPK,
                                                                    String name,
                                                                    int ownerType,
                                                                    int endPeriod)
                                                             throws SystemException
Returns the activity counter with the given name, owner, and end period that belong to the given entity.

Parameters:
groupId - the primary key of the group
classNameId - the primary key of the entity's class
classPK - the primary key of the entity
name - the counter name
ownerType - the owner type
endPeriod - the end period, -1 for the latest one
Returns:
the matching activity counter
Throws:
SystemException - if a system exception occurred

fetchActivityCounterByStartPeriod

public static SocialActivityCounter fetchActivityCounterByStartPeriod(long groupId,
                                                                      long classNameId,
                                                                      long classPK,
                                                                      String name,
                                                                      int ownerType,
                                                                      int startPeriod)
                                                               throws SystemException
Returns the activity counter with the given name, owner, and start period that belong to the given entity.

Parameters:
groupId - the primary key of the group
classNameId - the primary key of the entity's class
classPK - the primary key of the entity
name - the counter name
ownerType - the owner type
startPeriod - the start period
Returns:
the matching activity counter
Throws:
SystemException - if a system exception occurred

fetchLatestActivityCounter

public static SocialActivityCounter fetchLatestActivityCounter(long groupId,
                                                               long classNameId,
                                                               long classPK,
                                                               String name,
                                                               int ownerType)
                                                        throws SystemException
Returns the latest activity counter with the given name and owner that belong to the given entity.

Parameters:
groupId - the primary key of the group
classNameId - the primary key of the entity's class
classPK - the primary key of the entity
name - the counter name
ownerType - the owner type
Returns:
the matching activity counter
Throws:
SystemException - if a system exception occurred

getOffsetActivityCounters

public static List<SocialActivityCounter> getOffsetActivityCounters(long groupId,
                                                                    String name,
                                                                    int startOffset,
                                                                    int endOffset)
                                                             throws SystemException
Returns all the activity counters with the given name and period offsets.

The start and end offsets can belong to different periods. This method groups the counters by name and returns the sum of their current values.

Parameters:
groupId - the primary key of the group
name - the counter name
startOffset - the offset for the start period
endOffset - the offset for the end period
Returns:
the matching activity counters
Throws:
SystemException - if a system exception occurred

getOffsetDistributionActivityCounters

public static List<SocialActivityCounter> getOffsetDistributionActivityCounters(long groupId,
                                                                                String name,
                                                                                int startOffset,
                                                                                int endOffset)
                                                                         throws SystemException
Returns the distribution of the activity counters with the given name and period offsets.

The start and end offsets can belong to different periods. This method groups the counters by their owner entity (usually some asset) and returns a counter for each entity class with the sum of the counters' current values.

Parameters:
groupId - the primary key of the group
name - the counter name
startOffset - the offset for the start period
endOffset - the offset for the end period
Returns:
the distribution of matching activity counters
Throws:
SystemException - if a system exception occurred

getPeriodActivityCounters

public static List<SocialActivityCounter> getPeriodActivityCounters(long groupId,
                                                                    String name,
                                                                    int startPeriod,
                                                                    int endPeriod)
                                                             throws SystemException
Returns all the activity counters with the given name and time period.

The start and end period values can belong to different periods. This method groups the counters by name and returns the sum of their current values.

Parameters:
groupId - the primary key of the group
name - the counter name
startPeriod - the start period
endPeriod - the end period
Returns:
the matching activity counters
Throws:
SystemException - if a system exception occurred

getPeriodDistributionActivityCounters

public static List<SocialActivityCounter> getPeriodDistributionActivityCounters(long groupId,
                                                                                String name,
                                                                                int startPeriod,
                                                                                int endPeriod)
                                                                         throws SystemException
Returns the distribution of activity counters with the given name and time period.

The start and end period values can belong to different periods. This method groups the counters by their owner entity (usually some asset) and returns a counter for each entity class with the sum of the counters' current values.

Parameters:
groupId - the primary key of the group
name - the counter name
startPeriod - the start period
endPeriod - the end period
Returns:
the distribution of matching activity counters
Throws:
SystemException - if a system exception occurred

getUserActivityCounters

public static List<Tuple> getUserActivityCounters(long groupId,
                                                  String[] rankingNames,
                                                  String[] selectedNames,
                                                  int start,
                                                  int end)
                                           throws SystemException
Returns the range of tuples that contain users and a list of activity counters.

The counters returned for each user are passed to this method in the selectedNames array. The method also accepts an array of counter names that are used to rank the users.

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 QueryUtil.ALL_POS will return the full result set.

Parameters:
groupId - the primary key of the group
rankingNames - the ranking counter names
selectedNames - the counter names that will be returned with each user
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the range of matching tuples
Throws:
SystemException - if a system exception occurred

getUserActivityCountersCount

public static int getUserActivityCountersCount(long groupId,
                                               String[] rankingNames)
                                        throws SystemException
Returns the number of users having a rank based on the given counters.

Parameters:
groupId - the primary key of the group
rankingNames - the ranking counter names
Returns:
the number of matching users
Throws:
SystemException - if a system exception occurred

incrementUserAchievementCounter

public static void incrementUserAchievementCounter(long userId,
                                                   long groupId)
                                            throws PortalException,
                                                   SystemException
Increments the user.achievements counter for a user.

This method should be used by an external achievement class when the users unlocks an achievement.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group
Throws:
PortalException - if the group or an expected previous activity counter could not be found
SystemException - if a system exception occurred

getService

public static SocialActivityCounterLocalService getService()

setService

public void setService(SocialActivityCounterLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5