Liferay 6.1.2-ce-ga3

com.liferay.portlet.social.service
Interface SocialActivityCounterLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
SocialActivityCounterLocalServiceBaseImpl, SocialActivityCounterLocalServiceImpl, SocialActivityCounterLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SocialActivityCounterLocalService
extends BaseLocalService, PersistedModelLocalService

The interface for the social activity counter local service.

This is a local service. 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:
SocialActivityCounterLocalServiceUtil, SocialActivityCounterLocalServiceBaseImpl, SocialActivityCounterLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 SocialActivityCounter addActivityCounter(long groupId, long classNameId, long classPK, String name, int ownerType, int currentValue, int totalValue, int startPeriod, int endPeriod)
           
 SocialActivityCounter addActivityCounter(long groupId, long classNameId, long classPK, String name, int ownerType, int currentValue, int totalValue, int startPeriod, int endPeriod, long previousActivityCounterId, int periodLength)
           
 void addActivityCounters(SocialActivity activity)
           
 SocialActivityCounter addSocialActivityCounter(SocialActivityCounter socialActivityCounter)
          Adds the social activity counter to the database.
 SocialActivityCounter createActivityCounter(long groupId, long classNameId, long classPK, String name, int ownerType, int currentValue, int totalValue, int startPeriod, int endPeriod)
          Deprecated. createActivityCounter(long, long, long, String, int, int, int, int, int, long, int)
 SocialActivityCounter createActivityCounter(long groupId, long classNameId, long classPK, String name, int ownerType, int currentValue, int totalValue, int startPeriod, int endPeriod, long previousActivityCounterId, int periodLength)
           
 SocialActivityCounter createSocialActivityCounter(long activityCounterId)
          Creates a new social activity counter with the primary key.
 void deleteActivityCounters(AssetEntry assetEntry)
           
 void deleteActivityCounters(long classNameId, long classPK)
           
 SocialActivityCounter deleteSocialActivityCounter(long activityCounterId)
          Deletes the social activity counter with the primary key from the database.
 SocialActivityCounter deleteSocialActivityCounter(SocialActivityCounter socialActivityCounter)
          Deletes the social activity counter from the database.
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 SocialActivityCounter fetchActivityCounterByEndPeriod(long groupId, long classNameId, long classPK, String name, int ownerType, int endPeriod)
           
 SocialActivityCounter fetchActivityCounterByStartPeriod(long groupId, long classNameId, long classPK, String name, int ownerType, int startPeriod)
           
 SocialActivityCounter fetchLatestActivityCounter(long groupId, long classNameId, long classPK, String name, int ownerType)
           
 SocialActivityCounter fetchSocialActivityCounter(long activityCounterId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<SocialActivityCounter> getOffsetActivityCounters(long groupId, String name, int startOffset, int endOffset)
           
 List<SocialActivityCounter> getOffsetDistributionActivityCounters(long groupId, String name, int startOffset, int endOffset)
           
 List<SocialActivityCounter> getPeriodActivityCounters(long groupId, String name, int startPeriod, int endPeriod)
           
 List<SocialActivityCounter> getPeriodDistributionActivityCounters(long groupId, String name, int startPeriod, int endPeriod)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 SocialActivityCounter getSocialActivityCounter(long activityCounterId)
          Returns the social activity counter with the primary key.
 List<SocialActivityCounter> getSocialActivityCounters(int start, int end)
          Returns a range of all the social activity counters.
 int getSocialActivityCountersCount()
          Returns the number of social activity counters.
 List<Tuple> getUserActivityCounters(long groupId, String[] rankingNames, String[] selectedNames, int start, int end)
           
 int getUserActivityCountersCount(long groupId, String[] rankingNames)
           
 void incrementUserAchievementCounter(long userId, long groupId)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 SocialActivityCounter updateSocialActivityCounter(SocialActivityCounter socialActivityCounter)
          Updates the social activity counter in the database or adds it if it does not yet exist.
 SocialActivityCounter updateSocialActivityCounter(SocialActivityCounter socialActivityCounter, boolean merge)
          Updates the social activity counter in the database or adds it if it does not yet exist.
 

Method Detail

addSocialActivityCounter

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

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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.

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

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.

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

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

fetchSocialActivityCounter

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialActivityCounter fetchSocialActivityCounter(long activityCounterId)
                                                 throws SystemException
Throws:
SystemException

getSocialActivityCounter

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getSocialActivityCounters

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

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

updateSocialActivityCounter

SocialActivityCounter updateSocialActivityCounter(SocialActivityCounter socialActivityCounter,
                                                  boolean merge)
                                                  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
merge - whether to merge the social activity counter with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the social activity counter that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addActivityCounter

SocialActivityCounter addActivityCounter(long groupId,
                                         long classNameId,
                                         long classPK,
                                         String name,
                                         int ownerType,
                                         int currentValue,
                                         int totalValue,
                                         int startPeriod,
                                         int endPeriod)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

addActivityCounter

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
Throws:
PortalException
SystemException

addActivityCounters

void addActivityCounters(SocialActivity activity)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

createActivityCounter

SocialActivityCounter createActivityCounter(long groupId,
                                            long classNameId,
                                            long classPK,
                                            String name,
                                            int ownerType,
                                            int currentValue,
                                            int totalValue,
                                            int startPeriod,
                                            int endPeriod)
                                            throws PortalException,
                                                   SystemException
Deprecated. createActivityCounter(long, long, long, String, int, int, int, int, int, long, int)

Throws:
PortalException
SystemException

createActivityCounter

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
Throws:
PortalException
SystemException

deleteActivityCounters

void deleteActivityCounters(AssetEntry assetEntry)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

deleteActivityCounters

void deleteActivityCounters(long classNameId,
                            long classPK)
                            throws SystemException
Throws:
SystemException

fetchActivityCounterByEndPeriod

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialActivityCounter fetchActivityCounterByEndPeriod(long groupId,
                                                                                               long classNameId,
                                                                                               long classPK,
                                                                                               String name,
                                                                                               int ownerType,
                                                                                               int endPeriod)
                                                      throws SystemException
Throws:
SystemException

fetchActivityCounterByStartPeriod

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialActivityCounter fetchActivityCounterByStartPeriod(long groupId,
                                                                                                 long classNameId,
                                                                                                 long classPK,
                                                                                                 String name,
                                                                                                 int ownerType,
                                                                                                 int startPeriod)
                                                        throws SystemException
Throws:
SystemException

fetchLatestActivityCounter

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialActivityCounter fetchLatestActivityCounter(long groupId,
                                                                                          long classNameId,
                                                                                          long classPK,
                                                                                          String name,
                                                                                          int ownerType)
                                                 throws SystemException
Throws:
SystemException

getOffsetActivityCounters

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivityCounter> getOffsetActivityCounters(long groupId,
                                                                                               String name,
                                                                                               int startOffset,
                                                                                               int endOffset)
                                                      throws SystemException
Throws:
SystemException

getOffsetDistributionActivityCounters

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivityCounter> getOffsetDistributionActivityCounters(long groupId,
                                                                                                           String name,
                                                                                                           int startOffset,
                                                                                                           int endOffset)
                                                                  throws SystemException
Throws:
SystemException

getPeriodActivityCounters

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivityCounter> getPeriodActivityCounters(long groupId,
                                                                                               String name,
                                                                                               int startPeriod,
                                                                                               int endPeriod)
                                                      throws SystemException
Throws:
SystemException

getPeriodDistributionActivityCounters

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivityCounter> getPeriodDistributionActivityCounters(long groupId,
                                                                                                           String name,
                                                                                                           int startPeriod,
                                                                                                           int endPeriod)
                                                                  throws SystemException
Throws:
SystemException

getUserActivityCounters

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Tuple> getUserActivityCounters(long groupId,
                                                                             String[] rankingNames,
                                                                             String[] selectedNames,
                                                                             int start,
                                                                             int end)
                                    throws SystemException
Throws:
SystemException

getUserActivityCountersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserActivityCountersCount(long groupId,
                                                                          String[] rankingNames)
                                 throws SystemException
Throws:
SystemException

incrementUserAchievementCounter

void incrementUserAchievementCounter(long userId,
                                     long groupId)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

Liferay 6.1.2-ce-ga3