com.jivesoftware.community
Interface Draft

All Superinterfaces:

JiveObject

public interface Draft
extends JiveObject

A container for a draft of a message of any type. Every draft lives in a container specified by the draftContainerObjectType and draftContainerObjectID which means a draft can be created for any type of object in the system that has a subject and body. Each draft can have an arbitrary number of extended properties, which allow extra data about the draft to be stored.

Method Summary

java.lang.String	getBody() Returns the body of the draft.
long	getDraftContainerObjectID() Returns the ID of the object that contains this draft.
int	getDraftContainerObjectType() Returns the type of the object that contains this draft.
int	getDraftObjectType() Returns the type of object this draft represents.
java.util.List<Image>	getImages() Returns a list of images for the draft, or an empty list if no images are associated with the draft.
java.util.Date	getModificationDate() Returns the date that the draft was last modified.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns a map of properties associated with this draft.
java.lang.String	getSubject() Returns the subject of the draft.
long	getUserID() Returns the ID of the user that authored this draft.
void	setBody(java.lang.String body) Sets the body of the draft.
void	setImages(java.util.List<Image> images) Sets a list of images for the draft.
void	setModificationDate(java.util.Date modificationDate) Sets the draft modification date.
void	setProperties(java.util.Map<java.lang.String,java.lang.String> properties) Sets the properties associated with this draft.
void	setSubject(java.lang.String subject) Set the subject of the draft.

Methods inherited from interface com.jivesoftware.community.JiveObject

getID, getObjectType

Method Detail

getUserID

long getUserID()

Returns the ID of the user that authored this draft.

Returns:

the ID of the user that authored this draft.

getDraftObjectType

int getDraftObjectType()

Returns the type of object this draft represents.

Returns:

the type of object this draft represents.

getDraftContainerObjectID

long getDraftContainerObjectID()

Returns the ID of the object that contains this draft.

Returns:

the ID of the object that contains this draft.

getDraftContainerObjectType

int getDraftContainerObjectType()

Returns the type of the object that contains this draft.

Returns:

the type of the object that contains this draft.

getSubject

java.lang.String getSubject()

Returns the subject of the draft.

Returns:

the subject of the draft.

setSubject

void setSubject(java.lang.String subject)

Set the subject of the draft.

Parameters:

subject - the subject of the draft.

getBody

java.lang.String getBody()

Returns the body of the draft.

Returns:

the body of the draft.

setBody

void setBody(java.lang.String body)

Sets the body of the draft.

Parameters:

body - the body of the draft.

getImages

java.util.List<Image> getImages()

Returns a list of images for the draft, or an empty list if no images are associated with the draft.

Returns:

a list of images associated with the draft

setImages

void setImages(java.util.List<Image> images)

Sets a list of images for the draft.

Parameters:

images - a list of images for the draft.

getModificationDate

java.util.Date getModificationDate()

Returns the date that the draft was last modified.

Returns:

the date that the draft was last modified.

setModificationDate

void setModificationDate(java.util.Date modificationDate)

Sets the draft modification date.

Parameters:

modificationDate - the date that the draft was last modified.

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns a map of properties associated with this draft.

Returns:

a map of properties associated with this draft

setProperties

void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Sets the properties associated with this draft.

Parameters:

properties - the properties associated with this draft.