Package org.exoplatform.social.core.activity.model

Interface ExoSocialActivity

All Superinterfaces:
CacheEntry
All Known Implementing Classes:
ExoSocialActivityImpl
public interface ExoSocialActivity extends CacheEntry
ExoSocialActivity interface

  • Field Details

  • Method Details

    • getId

      String getId()

    • setId

      void setId(String id)

    • getExternalId

      String getExternalId()

    • setExternalId

      void setExternalId(String externalId)

    • getActivityStream

      ActivityStream getActivityStream()
      Gets activity stream associated with this activity.
      Returns:
      ActivityStream

    • setActivityStream

      void setActivityStream(ActivityStream as)
      Sets activity stream associated with this activity.
      Parameters:
      as - the activity stream

    • isComment

      boolean isComment()
      To indicate if this a comment to an activity.
      Returns:
      true if this is a comment or false

    • isComment

      void isComment(boolean isCommentOrNot)
      To indicate if this a comment to an activity.
      Parameters:
      isCommentOrNot - to know if this is a comment

    • getType

      String getType()
      The type of activity, this can be used for displaying activity with different ui components.
      Returns:
      the type of activity

    • setType

      void setType(String activityType)
      The type of activity, this can be used for displaying activity with different ui components.
      Parameters:
      activityType - the type of activity

    • getReplyToId

      String[] getReplyToId()
      Gets reply to identity id.
      Returns:
      the corresponding identity id

    • setReplyToId

      void setReplyToId(String[] replyToId)
      Sets reply to identity id.
      Parameters:
      replyToId - the identity id

    • isHidden

      boolean isHidden()
      To know if this is a hidden activity.
      Returns:
      true or false

    • isHidden

      void isHidden(boolean isHiddenOrNot)
      Sets to indicate if this is a hidden activity or not.
      Parameters:
      isHiddenOrNot - true or false

    • isLocked

      boolean isLocked()
      To know if this is a locked activity.
      Returns:
      true or false

    • isLocked

      void isLocked(boolean isLockedOrNot)
      Sets to indicate if this is a locked activity or not.
      Parameters:
      isLockedOrNot - true or false

    • isPinned

      boolean isPinned()
      To know if this is a pinned activity.
      Returns:
      true or false

    • setPinned

      void setPinned(boolean pinned)
      Sets to indicate if this is a pinned activity or not.
      Parameters:
      pinned - true or false

    • getPinDate

      String getPinDate()
      Gets the pin datetime.*

    • setPinDate

      void setPinDate(String pinDate)
      Set the pin datetime
      Parameters:
      pinDate - pin datetime

    • getPinAuthorId

      Long getPinAuthorId()
      Gets the Id of the identity that pinned the activity.
      Returns:
      Id of the identity that pinned the activity.

    • setPinAuthorId

      void setPinAuthorId(Long pinAuthorId)
      Sets the Id of the identity that pinned the activity.

    • getLikeIdentityIds

      String[] getLikeIdentityIds()
      Gets array of identityIds who like this activity.
      Returns:
      array of identityIds

    • getShareActions

      Set<ActivityShareAction> getShareActions()
      Gets array of identityIds who shared this activity.
      Returns:
      array of identityIds

    • getNumberOfLikes

      int getNumberOfLikes()
      Gets number of Liker who like this activity.
      Returns:
      number of liker

    • setLikeIdentityIds

      void setLikeIdentityIds(String[] identityIds)
      Sets array of identityIds who like this activity.
      Parameters:
      identityIds - array of identity Ids

    • setShareActions

      void setShareActions(Set<ActivityShareAction> shareActions)
      Sets share actions of the activity.
      Parameters:
      shareActions - Set share actions of user

    • getStreamOwner

      String getStreamOwner()
      Gets the stream owner, must be the remoteId of an identity.
      Returns:
      the stream owner

    • setStreamOwner

      void setStreamOwner(String so)
      Sets the stream owner, must be the remoteId of an identity.
      Parameters:
      so - the stream owner

    • getStreamId

      String getStreamId()
      The uuid of the node for this stream.
      Returns:
      stream id

    • setStreamId

      void setStreamId(String streamId)
      The uuid of the node for this stream.
      Parameters:
      streamId - the stream id

    • getName

      String getName()
      Gets the name; could be the name of the doc, the name of jira task or the page title.
      Returns:
      the name

    • setName

      void setName(String name)
      Sets the name; could be the name of the doc, the name of jira task or the page title.
      Parameters:
      name - the name

    • getTitle

      String getTitle()

    • setTitle

      void setTitle(String title)

    • getTitleId

      String getTitleId()

    • setTitleId

      void setTitleId(String titleId)

    • getSummary

      String getSummary()
      This string value provides a human readable description or summary of the activity object.
      Returns:
      the activity summary

    • setSummary

      void setSummary(String summary)
      Sets activity summary.
      Parameters:
      summary - the activity summary

    • getBody

      String getBody()

    • setBody

      void setBody(String body)

    • getBodyId

      String getBodyId()

    • setBodyId

      void setBodyId(String bodyId)

    • getAppId

      String getAppId()

    • setAppId

      void setAppId(String appId)

    • getPostedTime

      Long getPostedTime()

    • setPostedTime

      void setPostedTime(Long postedTime)

    • getUrl

      String getUrl()

    • setUrl

      void setUrl(String url)

    • getTemplateParams

      Map<String,String> getTemplateParams()

    • setTemplateParams

      void setTemplateParams(Map<String,String> templateParams)

    • getPermaLink

      String getPermaLink()
      Gets the permanent link.
      Could be the link to the doc, the jira task, or the link
      Returns:
      a permalink string, possibly null

    • setPermanLink

      void setPermanLink(String permaLink)
      Sets the permanent link. Could be the link to the doc, the jira task, or the link
      Parameters:
      permaLink - the permalink link

    • getStreamFaviconUrl

      String getStreamFaviconUrl()

    • getStreamSourceUrl

      String getStreamSourceUrl()

    • getStreamTitle

      String getStreamTitle()

    • getStreamUrl

      String getStreamUrl()

    • getMentionedIds

      String[] getMentionedIds()
      Gets array of identityIds who like this activity.
      Returns:
      array of identityIds

    • setMentionedIds

      void setMentionedIds(String[] identityIds)
      Sets array of identityIds who like this activity.
      Parameters:
      identityIds - array of identity Ids

    • getCommentedIds

      String[] getCommentedIds()
      Gets array of identityIds who comment this activity.
      Returns:
      array of identityIds

    • setCommentedIds

      void setCommentedIds(String[] identityIds)
      Sets array of identityIds who comment this activity.
      Parameters:
      identityIds - array of identity Ids

    • getUpdated

      Date getUpdated()

    • setUpdated

      void setUpdated(Long updated)
      Set the last update datetime
      Parameters:
      updated - last update datetime

    • getPosterId

      String getPosterId()
      Gets id of identity who is poster.
      Returns:
      Id of poster.

    • setPosterId

      void setPosterId(String posterId)
      Sets poster id.
      Parameters:
      posterId -

    • getParentCommentId

      String getParentCommentId()
      Get id of parent activity comment.
      Returns:
      Id of parent activity

    • setParentCommentId

      void setParentCommentId(String parentCommentId)
      Set parent activity comment id
      Parameters:
      parentCommentId -

    • getParentId

      String getParentId()
      Get id of parent activity.
      Returns:
      Id of parent activity

    • setParentId

      void setParentId(String parentId)
      Set parent activity id
      Parameters:
      parentId -

    • getFiles

      List<ActivityFile> getFiles()
      Get files of the activity.
      Returns:
      Files of the activity

    • setFiles

      void setFiles(List<ActivityFile> files)
      Set activity files
      Parameters:
      files -

    • getMetadatas

      Map<String,List<MetadataItem>> getMetadatas()
      Returns:
      Map of MetadataItem of the activity grouped by Metadata type

    • setMetadatas

      void setMetadatas(Map<String,List<MetadataItem>> metadatas)
      Set a Map of MetadataItem of the activity grouped by Metadata type
      Parameters:
      metadatas -

    • getUserId

      String getUserId()

    • setUserId

      void setUserId(String userId)

    • getSpaceId

      String getSpaceId()

    • setSpaceId

      void setSpaceId(String spaceId)

    • getPriority

      Float getPriority()

    • setPriority

      void setPriority(Float priority)

    • getLinkedProcessedEntities

      Map<String,Object> getLinkedProcessedEntities()

    • setLinkedProcessedEntities

      void setLinkedProcessedEntities(Map<String,Object> linkedProcessedEntities)

    • getMetadataObjectType

      String getMetadataObjectType()
      Returns:
      MetadataObject type associated to current activity

    • getMetadataObjectId

      String getMetadataObjectId()
      Returns:
      MetadataObject id associated to current activity

    • getMetadataObjectParentId

      String getMetadataObjectParentId()
      Returns:
      MetadataObject parentId associated to current activity

    • setMetadataObjectType

      void setMetadataObjectType(String objectType)
      Set MetadataObject type for current activity
      Parameters:
      objectType -

    • setMetadataObjectId

      void setMetadataObjectId(String objectId)
      Set MetadataObject id for current activity
      Parameters:
      objectId -

    • setMetadataObjectParentId

      void setMetadataObjectParentId(String objectParentId)
      Set MetadataObject parentId for current activity
      Parameters:
      objectParentId -

    • getMetadataObject

      MetadataObject getMetadataObject()
      Returns:
      MetadataObject with specific type and id for current activity

    • hasSpecificMetadataObject

      boolean hasSpecificMetadataObject()
      Returns:
      true if Activity has a specific MetadataObject type

    • getCategoryIds

      List<Long> getCategoryIds()
      Returns:
      List of associated Category Identifiers

    • setCategoryIds

      void setCategoryIds(List<Long> categoryIds)
      Set the List of associated Category Identifiers
      Parameters:
      categoryIds - List