oracle.webcenter.likes

Interface LikesManager

public interface LikesManager

Method Summary

Modifier and Type	Method and Description
LikesSummary	createLikesSummary(ActivityElement activity, int count) Create the LikesSummary.
LikesSummary	createLikesSummary(ActivityObject object, int count) Create the LikesSummary.
void	deleteLike(java.lang.String likeId) Delete the Like.
Like	getLike(ActivityElement activity) Retrieve the Like voted by the current user on an activity.
Like	getLike(ActivityElement activity, java.lang.String votedBy) Retrieve the Like voted by a user on an activity.
Like	getLike(ActivityObject object) Retrieve the Like voted by the current user on an object.
Like	getLike(ActivityObject object, java.lang.String votedBy) Retrieve the Like voted by a user on an object.
java.lang.Object	getLikeById(java.lang.String likeId)
java.util.List<Like>	getLikes(ActivityElement activity) Retrive the list of Like voted on an activity.
java.util.List<Like>	getLikes(ActivityElement activity, int startIndex, int itemsPerPage) Retrive the list of Like voted on an activity.
java.util.List<Like>	getLikes(ActivityObject object) Retrive the list of Like voted on an object.
java.util.List<Like>	getLikes(ActivityObject object, int startIndex, int itemsPerPage) Retrive the list of Like voted on an object.
LikesSummary	getLikesSummary(ActivityElement activity) Retrieve the LikesSummary.
LikesSummary	getLikesSummary(ActivityObject object) Retrieve the LikesSummary.
Like	like(ActivityElement activity, oracle.webcenter.framework.service.Scope scope) Express like on an activity by the current user;
Like	like(ActivityElement activity, oracle.webcenter.framework.service.Scope scope, java.lang.String activityId) Express like on an activity by the current user;
Like	like(ActivityElement activity, java.lang.String votedBy, oracle.webcenter.framework.service.Scope scope) Express like on an activity by the a user;
Like	like(ActivityElement activity, java.lang.String votedBy, oracle.webcenter.framework.service.Scope scope, java.lang.String activityId) Express like on an activity by the a user;
Like	like(ActivityObject object, oracle.webcenter.framework.service.Scope scope) Express like on an object by the current user;
Like	like(ActivityObject object, oracle.webcenter.framework.service.Scope scope, java.lang.String activityId) Express like on an object by the current user;
Like	like(ActivityObject object, java.lang.String votedBy, oracle.webcenter.framework.service.Scope scope) Express like on an object by the a user;
Like	like(ActivityObject object, java.lang.String votedBy, oracle.webcenter.framework.service.Scope scope, java.lang.String activityId) Express like on an object by the a user;
void	unlike(ActivityElement activity) Reverse the like on an activity by the current user.
void	unlike(ActivityElement activity, java.lang.String votedBy) Reverse the like on an activity by the user.
void	unlike(ActivityObject object) Reverse the like on an object by the current user.
void	unlike(ActivityObject object, java.lang.String votedBy) Reverse the like on an object by the user.

Method Detail

getLikes

java.util.List<Like> getLikes(ActivityObject object)
                       throws LikesException

Retrive the list of Like voted on an object.

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String)on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

Returns:

The list of Like.

Throws:

LikesException

getLikes

java.util.List<Like> getLikes(ActivityObject object,
                              int startIndex,
                              int itemsPerPage)
                       throws LikesException

Retrive the list of Like voted on an object.

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String)on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

startIndex - The start index for the query (1 based)

itemsPerPage - The number of items to return

Returns:

The list of Like.

Throws:

LikesException

getLike

Like getLike(ActivityObject object,
             java.lang.String votedBy)
      throws LikesException

Retrieve the Like voted by a user on an object.

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

votedBy - The user ID who voted.

Returns:

The Like

Throws:

LikesException

getLike

Like getLike(ActivityObject object)
      throws LikesException

Retrieve the Like voted by the current user on an object.

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

Returns:

The Like

Throws:

LikesException

like

Like like(ActivityObject object,
          java.lang.String votedBy,
          oracle.webcenter.framework.service.Scope scope,
          java.lang.String activityId)
   throws LikesException

Express like on an object by the a user;

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

votedBy - The user who like the object.

scope - The WebCenter scope to which the object belongs

activityId - An optional activity ID representing the original activity which led the user to like this object. The timestamp of the original activity is advanced to move the activity to the top of the user's activity stream.

Returns:

The Like

Throws:

LikesException

like

Like like(ActivityObject object,
          java.lang.String votedBy,
          oracle.webcenter.framework.service.Scope scope)
   throws LikesException

Express like on an object by the a user;

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

votedBy - The user who like the object.

scope - The WebCenter scope to which the object belongs

Returns:

The Like

Throws:

LikesException

like

Like like(ActivityObject object,
          oracle.webcenter.framework.service.Scope scope)
   throws LikesException

Express like on an object by the current user;

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

scope - The WebCenter scope to which the object belongs.

Returns:

The Like being creatd.

Throws:

LikesException

like

Like like(ActivityObject object,
          oracle.webcenter.framework.service.Scope scope,
          java.lang.String activityId)
   throws LikesException

Express like on an object by the current user;

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

scope - The WebCenter scope to which the object belongs.

activityId - An optional activity ID representing the original activity which led the user to like this object. The timestamp of the original activity is advanced to move the activity to the top of the user's activity stream.

Returns:

The Like being creatd.

Throws:

LikesException

unlike

void unlike(ActivityObject object,
            java.lang.String votedBy)
     throws LikesException

Reverse the like on an object by the user.

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

votedBy - The user who unlike this object.

Throws:

LikesException

unlike

void unlike(ActivityObject object)
     throws LikesException

Reverse the like on an object by the current user.

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents. Reverse the like on an object by the current user.

Throws:

LikesException

createLikesSummary

LikesSummary createLikesSummary(ActivityObject object,
                                int count)
                         throws LikesException

Create the LikesSummary.

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

count - The likes count.

Returns:

The LikesSummary

Throws:

LikesException

getLikesSummary

LikesSummary getLikesSummary(ActivityObject object)
                      throws LikesException

Retrieve the LikesSummary.

Parameters:

object - Object carrying information identifying the WebCenter object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

Returns:

The LikesSummary

Throws:

LikesException

getLikes

java.util.List<Like> getLikes(ActivityElement activity)
                       throws LikesException

Retrive the list of Like voted on an activity.

Parameters:

activity - Object carrying information identifying the activity object for which likes are to be retreived.

Returns:

The list of Like.

Throws:

LikesException

getLikes

java.util.List<Like> getLikes(ActivityElement activity,
                              int startIndex,
                              int itemsPerPage)
                       throws LikesException

Retrive the list of Like voted on an activity.

Parameters:

activity - Object carrying information identifying the activity object for which likes are to be retreived.

startIndex - The start index for the query (1 based)

itemsPerPage - The number of items to return

Returns:

The list of Like.

Throws:

LikesException

getLike

Like getLike(ActivityElement activity,
             java.lang.String votedBy)
      throws LikesException

Retrieve the Like voted by a user on an activity.

Parameters:

activity - Object carrying information identifying the activity object for which likes are to be retreived.

votedBy - The user ID who voted.

Returns:

The Like

Throws:

LikesException

getLike

Like getLike(ActivityElement activity)
      throws LikesException

Retrieve the Like voted by the current user on an activity.

Parameters:

activity - Object carrying information identifying the activity object for which likes are to be retreived.

Returns:

The Like

Throws:

LikesException

like

Like like(ActivityElement activity,
          java.lang.String votedBy,
          oracle.webcenter.framework.service.Scope scope,
          java.lang.String activityId)
   throws LikesException

Express like on an activity by the a user;

Parameters:

activity - Object carrying information identifying the activity object for which likes are to be retreived.

votedBy - The user who like the object.

scope - The WebCenter scope to which the object belongs

activityId - An optional activity ID representing the original activity which led the user to like this object. The timestamp of the original activity is advanced to move the activity to the top of the user's activity stream.

Returns:

The Like

Throws:

LikesException

like

Like like(ActivityElement activity,
          java.lang.String votedBy,
          oracle.webcenter.framework.service.Scope scope)
   throws LikesException

Express like on an activity by the a user;

Parameters:

activity - Object carrying information identifying the activity object for which likes are to be retreived.

votedBy - The user who like the object.

scope - The WebCenter scope to which the object belongs

Returns:

The Like

Throws:

LikesException

like

Like like(ActivityElement activity,
          oracle.webcenter.framework.service.Scope scope)
   throws LikesException

Express like on an activity by the current user;

Parameters:

activity - Object carrying information identifying the activity object for which likes are to be retreived.

scope - The WebCenter scope to which the object belongs.

Returns:

The Like being creatd.

Throws:

LikesException

like

Like like(ActivityElement activity,
          oracle.webcenter.framework.service.Scope scope,
          java.lang.String activityId)
   throws LikesException

Express like on an activity by the current user;

Parameters:

activity - Object carrying information identifying the activity object for which likes are to be retreived.

scope - The WebCenter scope to which the object belongs.

activityId - An optional activity ID representing the original activity which led the user to like this object. The timestamp of the original activity is advanced to move the activity to the top of the user's activity stream.

Returns:

The Like being creatd.

Throws:

LikesException

unlike

void unlike(ActivityElement activity,
            java.lang.String votedBy)
     throws LikesException

Reverse the like on an activity by the user.

Parameters:

activity - Object carrying information identifying the activity object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

votedBy - The user who unlike this object.

Throws:

LikesException

unlike

void unlike(ActivityElement activity)
     throws LikesException

Reverse the like on an activity by the current user.

Parameters:

activity - Object carrying information identifying the acvitity object for which likes are to be retreived. Reverse the like on an object by the current user.

Throws:

LikesException

createLikesSummary

LikesSummary createLikesSummary(ActivityElement activity,
                                int count)
                         throws LikesException

Create the LikesSummary.

Parameters:

activity - Object carrying information identifying the activity object for which likes are to be retreived.

count - The likes count.

Returns:

The LikesSummary

Throws:

LikesException

getLikesSummary

LikesSummary getLikesSummary(ActivityElement activity)
                      throws LikesException

Retrieve the LikesSummary.

Parameters:

object - activity carrying information identifying the activity object for which likes are to be retreived. The key properties needed to be specified on it are the service ID, the object type, and the object ID. It can be constructed by calling ActivityStreamingService.createObject(java.lang.String, oracle.webcenter.framework.service.ServiceObjectType, java.lang.String) passing in the appropriate object ID and object type, and then calling ActivityObject.setServiceID(java.lang.String) on it. The display name on the ActivityObject can be any non-null non-empty string, and need not even be the correct display name of the actual WebCenter object it represents.

Returns:

The LikesSummary

Throws:

LikesException

deleteLike

void deleteLike(java.lang.String likeId)
         throws LikesException

Delete the Like.

Parameters:

likeId - The like ID.

Throws:

LikesException

getLikeById

java.lang.Object getLikeById(java.lang.String likeId)
                      throws LikesException

Throws:

LikesException