|
Liferay 6.1.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface SocialEquityLogLocalServiceThe interface for the social equity log 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.
SocialEquityLogLocalServiceUtil,
com.liferay.portlet.social.service.base.SocialEquityLogLocalServiceBaseImpl,
com.liferay.portlet.social.service.impl.SocialEquityLogLocalServiceImpl| Method Summary | |
|---|---|
void |
addEquityLogs(long userId,
long assetEntryId,
String actionId)
Deprecated. Replaced by addEquityLogs(long, long, String,
String) to support the extraData parameter |
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. |
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. |
void |
addSocialEquityAssetEntry(AssetEntry assetEntry)
Inserts a new row for the asset entry into the SocialEquityAssetEntry table. |
SocialEquityLog |
addSocialEquityLog(SocialEquityLog socialEquityLog)
Adds the social equity log to the database. |
void |
addSocialEquityUser(long groupId,
User user)
Inserts a new row for the user into the SocialEquityUser
table. |
void |
checkEquityLogs()
This is a cleanup method to remove expired actions and any data associated with them. |
SocialEquityLog |
createSocialEquityLog(long equityLogId)
Creates a new social equity log with the primary key. |
void |
deactivateEquityLogs(long assetEntryId)
Removes all actions associated with the asset and adjusts equity scores accordingly. |
void |
deactivateEquityLogs(long userId,
long assetEntryId,
String actionId)
Deprecated. Replaced by deactivateEquityLogs(long, String, long,
String, String) to support the extraData
parameter |
void |
deactivateEquityLogs(long userId,
String className,
long classPK,
String actionId)
Deprecated. Replaced by deactivateEquityLogs(long, String, long,
String, String) to support the extraData
parameter |
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. |
void |
deactivateEquityLogs(String className,
long classPK,
String actionId,
String extraData)
Removes actions identified by action ID done on an asset by any user. |
void |
deactivateUserEquityLogs(long userId)
Removes all actions done by the user. |
void |
deleteSocialEquityLog(long equityLogId)
Deletes the social equity log with the primary key from the database. |
void |
deleteSocialEquityLog(SocialEquityLog socialEquityLog)
Deletes the social equity log from the database. |
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. |
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
SocialEquityLog |
getSocialEquityLog(long equityLogId)
Returns the social equity log with the primary key. |
List<SocialEquityLog> |
getSocialEquityLogs(int start,
int end)
Returns a range of all the social equity logs. |
int |
getSocialEquityLogsCount()
Returns the number of social equity logs. |
void |
incrementSocialEquityAssetEntry_IQ(long assetEntryId,
SocialEquityIncrementPayload equityPayload)
Increments the information equity value of the asset by the number set in the equity payload. |
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. |
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. |
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
updateRanks()
Updates user ranking for all groups. |
void |
updateRanks(long groupId)
Updates user ranking for a group. |
SocialEquityLog |
updateSocialEquityLog(SocialEquityLog socialEquityLog)
Updates the social equity log in the database or adds it if it does not yet exist. |
SocialEquityLog |
updateSocialEquityLog(SocialEquityLog socialEquityLog,
boolean merge)
Updates the social equity log in the database or adds it if it does not yet exist. |
| Method Detail |
|---|
SocialEquityLog addSocialEquityLog(SocialEquityLog socialEquityLog)
throws SystemException
socialEquityLog - the social equity log
SystemException - if a system exception occurredSocialEquityLog createSocialEquityLog(long equityLogId)
equityLogId - the primary key for the new social equity log
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
void deleteSocialEquityLog(SocialEquityLog socialEquityLog)
throws SystemException
socialEquityLog - the social equity log
SystemException - if a system exception occurred
List dynamicQuery(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
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
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
long dynamicQueryCount(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
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
@Transactional(propagation=SUPPORTS,
readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException,
SystemException
getPersistedModel in interface PersistedModelLocalServicePortalException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
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
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getSocialEquityLogsCount()
throws SystemException
SystemException - if a system exception occurred
SocialEquityLog updateSocialEquityLog(SocialEquityLog socialEquityLog)
throws SystemException
socialEquityLog - the social equity log
SystemException - if a system exception occurred
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 occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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 occurredvoid updateRanks()
void updateRanks(long groupId)
groupId - the primary key of the group
|
Liferay 6.1.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||