Package lumis.portal.activitystream

Class ActivityObject

  • All Implemented Interfaces:
    java.io.Serializable
    @StableMinor(version="17.0",
             sinceVersion="8.2")
public class ActivityObject
extends java.lang.Object
implements java.io.Serializable
    Object on which an action is applied during an Activity.
    Since:
    8.2.0
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      ActivityObject()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDisplayName()
      Returns the display name of this object.
      java.lang.String getId()
      Returns the identifier of this object.
      java.lang.String getIntroduction()
      Returns the introduction text of this object.
      java.lang.String getIntroductionImageUrl()
      Returns the URL of the introduction image of this object.
      java.util.Locale getLocale()
      Returns the locale of this object.
      ActivityObjectType getType()
      Returns the type of this object.
      java.lang.String getUrl()
      Returns the URL to the main page of this object.
      void setDisplayName​(java.lang.String displayName)
      Sets the display name of this object.
      void setId​(java.lang.String id)
      Sets the identifier of this object.
      void setIntroduction​(java.lang.String introduction)
      Sets the introduction text of this object.
      void setIntroductionImageUrl​(java.lang.String introductionImageUrl)
      Sets the introduction image URL of this object.
      void setLocale​(java.util.Locale locale)
      Sets the locale of this object.
      void setType​(ActivityObjectType type)
      Sets the type of this object.
      void setUrl​(java.lang.String url)
      Sets the URL to the main page of this object.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ActivityObject

        public ActivityObject()

    • Method Detail

      • getId

        public java.lang.String getId()
        Returns the identifier of this object. Typically a content identifier.
        Returns:
        the identifier of this object, or null if it does not have a direct object.
        Since:
        8.2.0

      • setId

        public void setId​(java.lang.String id)
        Sets the identifier of this object.
        Parameters:
        objectId - the identifier of this object.
        Since:
        8.2.0

      • getType

        public ActivityObjectType getType()
        Returns the type of this object.
        Returns:
        the type of this object, or null if it does not have a direct object.
        Since:
        8.2.0

      • setType

        public void setType​(ActivityObjectType type)
        Sets the type of this object.
        Parameters:
        type - the type to set.
        Since:
        8.2.0

      • getDisplayName

        public java.lang.String getDisplayName()
        Returns the display name of this object.
        Returns:
        a plain-text value that is the display name of this object, or null if this object does not have a display name.
        Since:
        8.2.0

      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
        Sets the display name of this object.
        Parameters:
        displayName - plain-text value to use as the display name of this object.
        Since:
        8.2.0

      • getIntroduction

        public java.lang.String getIntroduction()
        Returns the introduction text of this object.
        Returns:
        a plain-text value that is the introduction of this object, or null if this object does not have an introduction.
        Since:
        8.2.0

      • setIntroduction

        public void setIntroduction​(java.lang.String introduction)
        Sets the introduction text of this object.
        Parameters:
        introduction - plain-text value to use as the introduction of this object.
        Since:
        8.2.0

      • getIntroductionImageUrl

        public java.lang.String getIntroductionImageUrl()
        Returns the URL of the introduction image of this object.
        Returns:
        an absolute URL; a URI relative to portal application root; or null if there is no image.
        Since:
        8.2.0

      • setIntroductionImageUrl

        public void setIntroductionImageUrl​(java.lang.String introductionImageUrl)
        Sets the introduction image URL of this object.
        Parameters:
        introductionImageUrl - an absolute URL or a URI relative to portal application root that will be post-processed during rendering.
        Since:
        8.2.0

      • getUrl

        public java.lang.String getUrl()
        Returns the URL to the main page of this object.
        Returns:
        an absolute URL; a URI relative to portal application root; or null if there is no URL for this object.
        Since:
        8.2.0

      • setUrl

        public void setUrl​(java.lang.String url)
        Sets the URL to the main page of this object.
        Parameters:
        url - an absolute URL or a URI relative to portal application root that will be post-processed during rendering.
        Since:
        8.2.0

      • getLocale

        public java.util.Locale getLocale()
        Returns the locale of this object.
        Returns:
        the locale of this object, or null if this object has no locale specified.
        Since:
        8.2.0

      • setLocale

        public void setLocale​(java.util.Locale locale)
        Sets the locale of this object.
        Parameters:
        locale - the locale, or null if the locale is undefined.
        Since:
        8.2.0