Skip navigation links

waggle.common.modules.chat.infos
Class XChatInfo

java.lang.Object
waggle.core.info.XDTO
waggle.common.modules.object.infos.XObjectInfo
waggle.common.modules.tag.infos.XTagableInfo
waggle.common.modules.artifact.infos.XArtifactInfo
waggle.common.modules.document.infos.XContentInfo
waggle.common.modules.document.infos.XDocumentInfo
waggle.common.modules.chat.infos.XChatInfo

public class XChatInfo

extends XDocumentInfo

Chat Information DTO.

Field Summary

XArtifactInfo	AnnotatedArtifactInfo The Artifact annotated by this Chat.
XAnnotationMarkupInfo	AnnotationMarkupInfo Annotation markup info if this is an annotation Chat.
XArtifactInfo	AssociatedArtifactInfo The Artifact associated with this Chat.
List<XChatInfo>	CommentByInfos List of all comment Chats on this Chat.
XObjectID	CommentOnID The Chat on which this Chat is a Comment.
List<XFollowupInfo>	FollowupInfos List of all Users which should followup on this Chat.
XNotificationGroup	Group The Notification group.
XNotificationGroup	GroupYou The Notification group for when the targeted (referenced) user is 'you'.
int	Ordinal The ordinal of this Chat message.
boolean	RemovableType Whether it is ever possible to remove the chat message.
boolean	System Whether the chat message text was System or User generated.
String	Text The text for this Chat.
int	TextVersion The version number for this Chat text.
XNotificationEvent	Type The Notification event.
XWidgetInfo	WidgetInfo The Widget that produced this Chat.

Fields inherited from class waggle.common.modules.document.infos.XDocumentInfo

AttachmentDocumentInfos, HeadVersionInfo, LockedByUserID, LockedUntil, RenditionsSupported, RepositoryData, RepositoryID

Fields inherited from class waggle.common.modules.document.infos.XContentInfo

ContentLength, ContentMimeType, ContentURL

Fields inherited from class waggle.common.modules.artifact.infos.XArtifactInfo

AnnotatedByChatIDs, AssociatedWithChatID, fLockStatus, GroupID, State

Fields inherited from class waggle.common.modules.tag.infos.XTagableInfo

TagInfos

Fields inherited from class waggle.common.modules.object.infos.XObjectInfo

ConversationID, CreatedByScaledPictureID, CreatedByUserID, CreatedByUserName, CreatedOnBehalfOfUserID, CreatedOnBehalfOfUserName, CreatedTimestamp, ID, Latitude, Longitude, ModifiedByScaledPictureID, ModifiedByUserID, ModifiedByUserName, ModifiedOnBehalfOfUserID, ModifiedOnBehalfOfUserName, ModifiedTimestamp, Name, ObjectType, ParentID, Removed, RemovedByUserID, RemovedTimestamp, TrackID

Constructor Summary

XChatInfo()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

Type

public XNotificationEvent Type

The Notification event.

Group

public XNotificationGroup Group

The Notification group.

GroupYou

public XNotificationGroup GroupYou

The Notification group for when the targeted (referenced) user is 'you'. If the targeted user is 'you' and GroupYou is null still use Group.

Ordinal

public int Ordinal

The ordinal of this Chat message.

Text

public String Text

The text for this Chat. The text's mime type will be in field ContentMimeType.

TextVersion

public int TextVersion

The version number for this Chat text. The value is 1 for the initial Chat 2-n for any edited versions of the Chat. The value is 0 if the Chat has been removed.

System

public boolean System

Whether the chat message text was System or User generated. True if the Chat text is system generated, false if user generated.

RemovableType

public boolean RemovableType

Whether it is ever possible to remove the chat message. Generally user, document, annotation, and conference messages can be removed; annotation groups, poll messages, widget messages, and previously removed messages cannot be removed. This boolean indicates if the chat message can generally be removed or not.

A Removable chat may not be removable in some contexts though. A conference chat cannot be removed if the conference is still in progress. See the XChatModule.Server.isRemovableNow() method for addressing those cases.

The rules boil down to this: 1 - clients should check to see if the conversation is closed. If so, no chats can be removed. 2 - clients should check to see if the individual chat's XChatInfo.RemovableType flag is true or false (if false, never allow it to be removed). And 3, if the chat belongs to a conference, then the client needs to check if the conference is still open or has closed. If it's open, then the chat cannot be removed (until the conference is closed). The XChatInfo.System boolean no longer has a role in determining if a chat can be removed or not.

AssociatedArtifactInfo

public XArtifactInfo AssociatedArtifactInfo

The Artifact associated with this Chat.

AnnotatedArtifactInfo

public XArtifactInfo AnnotatedArtifactInfo

The Artifact annotated by this Chat.

CommentOnID

public XObjectID CommentOnID

The Chat on which this Chat is a Comment.

CommentByInfos

public List<XChatInfo> CommentByInfos

List of all comment Chats on this Chat.

FollowupInfos

public List<XFollowupInfo> FollowupInfos

List of all Users which should followup on this Chat.

AnnotationMarkupInfo

public XAnnotationMarkupInfo AnnotationMarkupInfo

Annotation markup info if this is an annotation Chat. Otherwise null.

WidgetInfo

public XWidgetInfo WidgetInfo

The Widget that produced this Chat.

Constructor Detail

XChatInfo

public XChatInfo()

Skip navigation links