public interface

AnnotationBean

implements WebBean
com.microstrategy.web.beans.AnnotationBean

Class Overview

The AnnotationBean is used to editing, updating or adding an annotation to a report or document. This feature may also be known as collaboration, or information in the user interface

Summary

Constants
int ANNOTATION_BEAN_MODE_ADD Mode where the user is adding to existing annotations/information.
int ANNOTATION_BEAN_MODE_EDIT Mode where the user is editing existing annotations/information
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void appendAnnotation(String annotation)
Adds an annotation to the already existing information of the target object.
abstract String getAnnotations()
Returns the annotations of the target object.
abstract int getMode()
Returns the mode of the AnnotationBean.
abstract String getPostfix(boolean isAppend)
Retrieves the postfix used when appending or editing annotation.
abstract String getPrefix(String locale)
Retrieves the prefix used when appending annotation.
abstract WebObjectInfo getTarget()
Gets the WebObjectInfo of the target object.
abstract boolean hasAnnotations()
Returns wether anotation of the target object exsits or not.
abstract void setMode(int mode)
Sets the mode of the AnnotationBean.
abstract void setTarget(WebObjectInfo target)
Sets the target object
abstract void updateAnnotation(String annotation)
Updates the annotations of the target object.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int ANNOTATION_BEAN_MODE_ADD

Mode where the user is adding to existing annotations/information. This is the default mode

Constant Value: 1 (0x00000001)

public static final int ANNOTATION_BEAN_MODE_EDIT

Mode where the user is editing existing annotations/information

Constant Value: 0 (0x00000000)

Public Methods

public abstract void appendAnnotation (String annotation)

Adds an annotation to the already existing information of the target object. This method will append the passed in annotation to the end of the existing information of the object along with a carriage return.

Throws
WebBeanException

public abstract String getAnnotations ()

Returns the annotations of the target object.

Throws
WebBeanException

public abstract int getMode ()

Returns the mode of the AnnotationBean.

Returns

public abstract String getPostfix (boolean isAppend)

Retrieves the postfix used when appending or editing annotation. It's "\r\n---\r\n" for append and "\r\n" for editing

Parameters
isAppend true if doing append false for editing case
Returns
  • the postfix string

public abstract String getPrefix (String locale)

Retrieves the prefix used when appending annotation. It's a combination of user name followed by time stamp.

Parameters
locale the locale used to display the time stamp.
Returns
  • the prefix string

public abstract WebObjectInfo getTarget ()

Gets the WebObjectInfo of the target object.

Throws
WebBeanException

public abstract boolean hasAnnotations ()

Returns wether anotation of the target object exsits or not.

Throws
WebBeanException

public abstract void setMode (int mode)

Sets the mode of the AnnotationBean. Possible values for mode are ANNOTATION_BEAN_MODE_ADD and ANNOTATION_BEAN_MODE_EDIT

public abstract void setTarget (WebObjectInfo target)

Sets the target object

public abstract void updateAnnotation (String annotation)

Updates the annotations of the target object. This method will replaced the entire information of the object with the passed in annotation.

Throws
WebBeanException