|
Liferay 6.1.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.social.service.SocialEquityLogLocalServiceUtil
public class SocialEquityLogLocalServiceUtil
The utility for the social equity log local service. This utility wraps com.liferay.portlet.social.service.impl.SocialEquityLogLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.
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.
SocialEquityLogLocalService,
com.liferay.portlet.social.service.base.SocialEquityLogLocalServiceBaseImpl,
com.liferay.portlet.social.service.impl.SocialEquityLogLocalServiceImpl| Constructor Summary | |
|---|---|
SocialEquityLogLocalServiceUtil()
|
|
| Method Summary | |
|---|---|
static void |
addEquityLogs(long userId,
long assetEntryId,
String actionId)
Deprecated. Replaced by addEquityLogs(long, long, String,
String) to support the extraData parameter |
static void |
addEquityLogs(long userId,
long assetEntryId,
String actionId,
String extraData)
Records the social equity action and adjusts social equity scores based on the user's action done on the target asset entry. |
static void |
addEquityLogs(long userId,
String className,
long classPK,
String actionId,
String extraData)
Records the social equity action and adjusts social equity scores based on the user's action done on the target asset entry identified by the className/classPK pair. |
static void |
addSocialEquityAssetEntry(AssetEntry assetEntry)
Inserts a new row for the asset entry into the SocialEquityAssetEntry table. |
static SocialEquityLog |
addSocialEquityLog(SocialEquityLog socialEquityLog)
Adds the social equity log to the database. |
static void |
addSocialEquityUser(long groupId,
User user)
Inserts a new row for the user into the SocialEquityUser
table. |
static void |
checkEquityLogs()
This is a cleanup method to remove expired actions and any data associated with them. |
static SocialEquityLog |
createSocialEquityLog(long equityLogId)
Creates a new social equity log with the primary key. |
static void |
deactivateEquityLogs(long assetEntryId)
Removes all actions associated with the asset and adjusts equity scores accordingly. |
static void |
deactivateEquityLogs(long userId,
long assetEntryId,
String actionId)
Deprecated. Replaced by deactivateEquityLogs(long, String, long,
String, String) to support the extraData
parameter |
static void |
deactivateEquityLogs(long userId,
String className,
long classPK,
String actionId)
Deprecated. Replaced by deactivateEquityLogs(long, String, long,
String, String) to support the extraData
parameter |
static void |
deactivateEquityLogs(long userId,
String className,
long classPK,
String actionId,
String extraData)
Removes actions identified by the acting user, the action ID and the target asset's className/classPK pair. |
static void |
deactivateEquityLogs(String className,
long classPK,
String actionId,
String extraData)
Removes actions identified by action ID done on an asset by any user. |
static void |
deactivateUserEquityLogs(long userId)
Removes all actions done by the user. |
static void |
deleteSocialEquityLog(long equityLogId)
Deletes the social equity log with the primary key from the database. |
static void |
deleteSocialEquityLog(SocialEquityLog socialEquityLog)
Deletes the social equity log from the database. |
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 String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
static SocialEquityLogLocalService |
getService()
|
static SocialEquityLog |
getSocialEquityLog(long equityLogId)
Returns the social equity log with the primary key. |
static List<SocialEquityLog> |
getSocialEquityLogs(int start,
int end)
Returns a range of all the social equity logs. |
static int |
getSocialEquityLogsCount()
Returns the number of social equity logs. |
static void |
incrementSocialEquityAssetEntry_IQ(long assetEntryId,
SocialEquityIncrementPayload equityPayload)
Increments the information equity value of the asset by the number set in the equity payload. |
static void |
incrementSocialEquityUser_CQ(long groupId,
long userId,
SocialEquityIncrementPayload equityPayload)
Increments the contribution equity value of the user by the number set in the equity payload. |
static void |
incrementSocialEquityUser_PQ(long groupId,
long userId,
SocialEquityIncrementPayload equityPayload)
Increments the participation equity value of the user by the number set in the equity payload. |
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(SocialEquityLogLocalService service)
|
static void |
updateRanks()
Updates user ranking for all groups. |
static void |
updateRanks(long groupId)
Updates user ranking for a group. |
static SocialEquityLog |
updateSocialEquityLog(SocialEquityLog socialEquityLog)
Updates the social equity log in the database or adds it if it does not yet exist. |
static SocialEquityLog |
updateSocialEquityLog(SocialEquityLog socialEquityLog,
boolean merge)
Updates the social equity log 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 |
|---|
public SocialEquityLogLocalServiceUtil()
| Method Detail |
|---|
public static SocialEquityLog addSocialEquityLog(SocialEquityLog socialEquityLog)
throws SystemException
socialEquityLog - the social equity log
SystemException - if a system exception occurredpublic static SocialEquityLog createSocialEquityLog(long equityLogId)
equityLogId - the primary key for the new social equity log
public static void deleteSocialEquityLog(long equityLogId)
throws PortalException,
SystemException
equityLogId - the primary key of the social equity log
PortalException - if a social equity log with the primary key could not be found
SystemException - if a system exception occurred
public static void deleteSocialEquityLog(SocialEquityLog socialEquityLog)
throws SystemException
socialEquityLog - the social equity log
SystemException - if a system exception occurred
public static List dynamicQuery(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
public static List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
throws SystemException
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.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
SystemException - if a system exception occurred
public static List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
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.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)orderByComparator - the comparator to order the results by (optionally null)
SystemException - if a system exception occurred
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
public static SocialEquityLog getSocialEquityLog(long equityLogId)
throws PortalException,
SystemException
equityLogId - the primary key of the social equity log
PortalException - if a social equity log with the primary key could not be found
SystemException - if a system exception occurred
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException,
SystemException
PortalException
SystemException
public static List<SocialEquityLog> getSocialEquityLogs(int start,
int end)
throws SystemException
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.
start - the lower bound of the range of social equity logsend - the upper bound of the range of social equity logs (not inclusive)
SystemException - if a system exception occurred
public static int getSocialEquityLogsCount()
throws SystemException
SystemException - if a system exception occurred
public static SocialEquityLog updateSocialEquityLog(SocialEquityLog socialEquityLog)
throws SystemException
socialEquityLog - the social equity log
SystemException - if a system exception occurred
public static SocialEquityLog updateSocialEquityLog(SocialEquityLog socialEquityLog,
boolean merge)
throws SystemException
socialEquityLog - the social equity logmerge - whether to merge the social equity log with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
SystemException - if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
public static void addEquityLogs(long userId,
long assetEntryId,
String actionId)
throws PortalException,
SystemException
addEquityLogs(long, long, String,
String) to support the extraData parameter
userId - the primary key of the acting userassetEntryId - the primary key of the target asset entryactionId - the ID of the action
PortalException - if the asset entry could not be found
SystemException - if a system exception occurred
public static void addEquityLogs(long userId,
long assetEntryId,
String actionId,
String extraData)
throws PortalException,
SystemException
The extraData parameter can contain further information
about the action such as the file name for a download action. It is used
to distinguish between otherwise equal actions, such as multiple
downloads of message boards attachments.
userId - the primary key of the acting userassetEntryId - the primary key of the target asset entryactionId - the ID of the actionextraData - the extra data associated with the action
PortalException - if the asset entry could not be found
SystemException - if a system exception occurred
public static void addEquityLogs(long userId,
String className,
long classPK,
String actionId,
String extraData)
throws PortalException,
SystemException
The extraData parameter can contain further information
about the action such as the file name for a download action. It is used
to distinguish between otherwise equal actions, such as multiple
downloads of message boards attachments.
userId - the primary key of the acting userclassName - the class name of the target assetclassPK - the primary key of the target asset (not the asset entry
referring to it)actionId - the ID of the actionextraData - the extra data associated with the action
PortalException - if the asset entry could not be found
SystemException - if a system exception occurred
public static void addSocialEquityAssetEntry(AssetEntry assetEntry)
throws SystemException
SocialEquityAssetEntry table.
This method should not be used directly by portlets. It is made public so that it can be in its own transaction to safeguard against concurrency issues.
assetEntry - the asset entry
SystemException - if a system exception occurred
public static void addSocialEquityUser(long groupId,
User user)
throws SystemException
SocialEquityUser
table.
This method should not be used directly by portlets. It is made public so that it can be in its own transaction to safeguard against concurrency issues.
groupId - the primary key of the group the user is currently
acting inuser - the acting user
SystemException - if a system exception occurred
public static void checkEquityLogs()
throws SystemException
This method should normally only be called by the portal.
By default it is run by the scheduler once a day, but the frequency can
be modified by overriding the
social.equity.equity.log.check.interval property found in
portal.properties.
SystemException - if a system exception occurred
public static void deactivateEquityLogs(long assetEntryId)
throws SystemException
This method is called by the AssetEntry service
automatically when an asset entry is deleted.
assetEntryId - the primary key of the asset entry
SystemException - if a system exception occurred
public static void deactivateEquityLogs(long userId,
long assetEntryId,
String actionId)
throws PortalException,
SystemException
deactivateEquityLogs(long, String, long,
String, String) to support the extraData
parameter
userId - the primary key of the acting userassetEntryId - the primary key of the target asset entryactionId - the ID of the action
PortalException - if the asset entry could not be found
SystemException - if a system exception occurred
public static void deactivateEquityLogs(long userId,
String className,
long classPK,
String actionId)
throws PortalException,
SystemException
deactivateEquityLogs(long, String, long,
String, String) to support the extraData
parameter
userId - the primary key of the acting userclassName - the class name of the target assetclassPK - the primary key of the target asset (not the asset
entry referring to it)actionId - the ID of the action
PortalException - if the asset entry cannot be retrieved
SystemException - if a system exception occurred
public static void deactivateEquityLogs(long userId,
String className,
long classPK,
String actionId,
String extraData)
throws PortalException,
SystemException
The extraData parameter can be used to further identify the
action.
userId - the primary key of the acting userclassName - the class name of the target assetclassPK - the primary key of the target asset (not the asset entry
referring to it)actionId - the ID of the actionextraData - the extra data associated with the action
PortalException - if the asset entry cannot be retrieved
SystemException - if a system exception occurred
public static void deactivateEquityLogs(String className,
long classPK,
String actionId,
String extraData)
throws PortalException,
SystemException
className - the class name of the target assetclassPK - the primary key of the target asset (not the asset entry
referring to it)actionId - the ID of the actionextraData - the extra data associated with the action
PortalException - if the asset entry cannot be retrieved
SystemException - if a system exception occurred
public static void deactivateUserEquityLogs(long userId)
throws SystemException
This method is called by the portal when a user is deleted.
userId - the primary key of the user
SystemException - if a system exception occurred
public static void incrementSocialEquityAssetEntry_IQ(long assetEntryId,
SocialEquityIncrementPayload equityPayload)
throws SystemException
This method is annotated with the BufferedIncrement
annotation, which means that in case of heavy load, invocations of this
method can be aggregated into one method call containing the sum of the
individual increments.
This method should not be called directly by portlets. It is made
public only to accommodate the BufferedIncrement
annotation.
assetEntryId - the primary key of the target asset entryequityPayload - the equity payload containing the increments
SystemException - if a system exception occurred
public static void incrementSocialEquityUser_CQ(long groupId,
long userId,
SocialEquityIncrementPayload equityPayload)
throws SystemException
This method is annotated with the BufferedIncrement
annotation, which means that in case of heavy load, invocations of this
method can be aggregated into one method call containing the sum of the
individual increments.
This method should not be called directly by portlets. It is made
public only to accommodate the BufferedIncrement
annotation.
groupId - the primary key of the group in which the user is actinguserId - the primary key of the acting userequityPayload - the equity payload containing the increments
SystemException - if a system exception occurred
public static void incrementSocialEquityUser_PQ(long groupId,
long userId,
SocialEquityIncrementPayload equityPayload)
throws SystemException
This method is annotated with the BufferedIncrement
annotation, which means that in case of heavy load, invocations of this
method can be aggregated into one method call containing the sum of the
individual increments.
This method should not be called directly by portlets. It is made
public only to accommodate the BufferedIncrement
annotation.
groupId - the primary key of the group in which the user is actinguserId - the primary key of the acting userequityPayload - the equity payload containing the increments
SystemException - if a system exception occurredpublic static void updateRanks()
public static void updateRanks(long groupId)
groupId - the primary key of the grouppublic static SocialEquityLogLocalService getService()
public void setService(SocialEquityLogLocalService service)
|
Liferay 6.1.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||