com.compoze.exchange.webdav
Class Document

java.lang.Object

  |

  +--com.compoze.exchange.webdav.AbstractItem

        |

        +--com.compoze.exchange.webdav.AbstractMessage

              |

              +--com.compoze.exchange.webdav.Document

All Implemented Interfaces:

java.lang.Cloneable, IItem, java.io.Serializable

public class Document

extends AbstractMessage

implements java.io.Serializable, java.lang.Cloneable

This class extends AbstractMessage to represent an message that is a Document in the Exchange store.

The following table contains the properties defined in the Exchange store schema and mappings to their corresponding Java enumeration and methods:

Exchange Store Property	Property Enumeration	Java Methods
urn:schemas-microsoft-com:office:office#Author	OfficeProperty.AUTHOR	getAuthor() setAuthor(String)
urn:schemas-microsoft-com:office:office#Category	OfficeProperty.CATEGORY	getCategories() setCategories(List)
urn:schemas-microsoft-com:office:office#Characters	OfficeProperty.CHARACTERS	getCharacterCount() setCharacterCount(int)
urn:schemas-microsoft-com:office:office#Checked_x0020_by	OfficeProperty.CHECKED_X0020_BY	getCheckedX0020By() setCheckedX0020By(String)
urn:schemas-microsoft-com:office:office#Client	OfficeProperty.CLIENT	getClient() setClient(String)
urn:schemas-microsoft-com:office:office#Company	OfficeProperty.COMPANY	getCompany() setCompany(String)
urn:schemas-microsoft-com:office:office#Created	OfficeProperty.CREATED	getDateCreated() setDateCreated(Date)
urn:schemas-microsoft-com:office:office#Date_x0020_completed	OfficeProperty.DATE_X0020_COMPLETED	getDateX0020Completed() setDateX0020Completed(String)
urn:schemas-microsoft-com:office:office#Department	OfficeProperty.DEPARTMENT	getDepartment() setDepartment(String)
urn:schemas-microsoft-com:office:office#Destination	OfficeProperty.DESTINATION	getDestination() setDestination(String)
urn:schemas-microsoft-com:office:office#Disposition	OfficeProperty.DISPOSITION	getDisposition() setDisposition(String)
urn:schemas-microsoft-com:office:office#Division	OfficeProperty.DIVISION	getDivision() setDivision(String)
urn:schemas-microsoft-com:office:office#Document_x0020_number	OfficeProperty.DOCUMENT_X0020_NUMBER	getDocumentX0020Number() setDocumentX0020Number(String)
urn:schemas-microsoft-com:office:office#Editor	OfficeProperty.EDITOR	getEditor() setEditor(String)
urn:schemas-microsoft-com:office:office#Forward_x0020_to	OfficeProperty.FORWARD_X0020_TO	getForwardX0020To() setForwardX0020To(String)
urn:schemas-microsoft-com:office:office#Group	OfficeProperty.GROUP	getGroup() setGroup(String)
urn:schemas-microsoft-com:office:office#HeadingPairs	OfficeProperty.HEADING_PAIRS	getHeadingPairs() setHeadingPairs(String)
urn:schemas-microsoft-com:office:office#HiddenSlides	OfficeProperty.HIDDEN_SLIDES	getHiddenSlideCount() setHiddenSlideCount(int)
urn:schemas-microsoft-com:office:office#Keywords	OfficeProperty.KEYWORDS	getKeywords() setKeywords(List)
urn:schemas-microsoft-com:office:office#Language	OfficeProperty.LANGUAGE	getLanguage() setLanguage(String)
urn:schemas-microsoft-com:office:office#LastAuthor	OfficeProperty.LAST_AUTHOR	getLastAuthor() setLastAuthor(String)
urn:schemas-microsoft-com:office:office#LastPrinted	OfficeProperty.LAST_PRINTED	getLastPrinted() setLastPrinted(Date)
urn:schemas-microsoft-com:office:office#LastSaved	OfficeProperty.LAST_SAVED	getLastSaved() setLastSaved(Date)
urn:schemas-microsoft-com:office:office#Lines	OfficeProperty.LINES	getLineCount() setLineCount(int)
urn:schemas-microsoft-com:office:office#LinksUpToDate	OfficeProperty.LINKS_UP_TO_DATE	isLinksUpToDate() setLinksUpToDate(boolean)
urn:schemas-microsoft-com:office:office#Mailstop	OfficeProperty.MAILSTOP	getMailStop() setMailStop(String)
urn:schemas-microsoft-com:office:office#Manager	OfficeProperty.MANAGER	getManager() setManager(String)
urn:schemas-microsoft-com:office:office#Matter	OfficeProperty.MATTER	getMatter() setMatter(String)
urn:schemas-microsoft-com:office:office#MultimediaClips	OfficeProperty.MULTIMEDIA_CLIPS	getMultimediaClipCount() setMultimediaClipCount(int)
urn:schemas-microsoft-com:office:office#NameOfApplication	OfficeProperty.NAME_OF_APPLICATION	getApplicationName() setApplicationName(String)
urn:schemas-microsoft-com:office:office#Notes	OfficeProperty.NOTES	getNoteCount() setNoteCount(int)
urn:schemas-microsoft-com:office:office#Office	OfficeProperty.OFFICE	getOffice() setOffice(String)
urn:schemas-microsoft-com:office:office#Owner	OfficeProperty.OWNER	getOwner() setOwner(String)
urn:schemas-microsoft-com:office:office#Pages	OfficeProperty.PAGES	getPageCount() setPageCount(int)
urn:schemas-microsoft-com:office:office#Paragraphs	OfficeProperty.PARAGRAPHS	getParagraphCount() setParagraphCount(int)
urn:schemas-microsoft-com:office:office#PartTitles	OfficeProperty.PART_TITLES	getPartTitles() setPartTitles(List)
urn:schemas-microsoft-com:office:office#PresentationFormat	OfficeProperty.PRESENTATION_FORMAT	getPresentationFormat() setPresentationFormat(String)
urn:schemas-microsoft-com:office:office#Project	OfficeProperty.PROJECT	getProject() setProject(String)
urn:schemas-microsoft-com:office:office#Publisher	OfficeProperty.PUBLISHER	getPublisher() setPublisher(String)
urn:schemas-microsoft-com:office:office#Purpose	OfficeProperty.PURPOSE	getPurpose() setPurpose(String)
urn:schemas-microsoft-com:office:office#Received	OfficeProperty.RECEIVED	getReceived() setReceived(String)
urn:schemas-microsoft-com:office:office#Recorded	OfficeProperty.RECORDED	getRecorded() setRecorded(String)
urn:schemas-microsoft-com:office:office#Recorded_x0020_date	OfficeProperty.RECORDED_X0020_DATE	getRecordedX0020Date() setRecordedX0020Date(String)
urn:schemas-microsoft-com:office:office#Reference	OfficeProperty.REFERENCE	getReference() setReference(String)
urn:schemas-microsoft-com:office:office#Revision	OfficeProperty.REVISION	getRevision() setRevision(int)
urn:schemas-microsoft-com:office:office#ScaleCrop	OfficeProperty.SCALE_CROP	isScaleCrop() setScaleCrop(boolean)
urn:schemas-microsoft-com:office:office#Security	OfficeProperty.SECURITY	getSecurity() setSecurity(int)
urn:schemas-microsoft-com:office:office#Slides	OfficeProperty.SLIDES	getSlideCount() setSlideCount(int)
urn:schemas-microsoft-com:office:office#Source	OfficeProperty.SOURCE	getSource() setSource(String)
urn:schemas-microsoft-com:office:office#Status	OfficeProperty.STATUS	getStatus() setStatus(String)
urn:schemas-microsoft-com:office:office#Subject	OfficeProperty.SUBJECT	getDocumentSubject() setDocumentSubject(String)
urn:schemas-microsoft-com:office:office#Telephone_x0020_number	OfficeProperty.TELEPHONE_X0020_NUMBER	getTelephoneX0020Number() setTelephoneX0020Number(String)
urn:schemas-microsoft-com:office:office#Template	OfficeProperty.TEMPLATE	getTemplate() setTemplate(String)
urn:schemas-microsoft-com:office:office#Title	OfficeProperty.TITLE	getTitle() setTitle(String)
urn:schemas-microsoft-com:office:office#Typist	OfficeProperty.TYPIST	getTypist() setTypist(String)
urn:schemas-microsoft-com:office:office#Version	OfficeProperty.VERSION	getVersion() setVersion(int)
urn:schemas-microsoft-com:office:office#Version	OfficeProperty.WORDS	getWordCount() setWordCount(int)

The above properties are used by Microsoft® Office applications. For a list of properties that pertain to all documents, see AbstractMessage.

Below is an example of how to create a document:

  Document document = new Document("document.txt",
      new ByteArrayInputStream (new String ("Here is some document data.").getBytes()));
  mailFolder.addItem(document);
 

See Also:

Serialized Form

Constructor Summary

Document(java.lang.String sName, java.io.InputStream srcIs)
Constructor.

Method Summary

void	addAttachment(Attachment attachment) Adds an attachement to this message.
java.lang.Object	clone() Creates and returns a copy of this object.
protected java.lang.String	createFilename(int iIndex) Creates a filename for this document.
java.lang.String	getApplicationName() Gets the name of the application.
java.lang.String	getAuthor() Gets the name of document author.
java.util.LinkedList	getBccAddresses() Gets the blind carbon copy (Bcc) addresses.
java.lang.String	getBccAddressesString() Gets the string representation of a list of blind carbon copy (Bcc) addresses.
com.compoze.util.mail.InternetAddress[]	getBccRecipients() Gets internet addresses of recipients set in the "Bcc" (blind carbon copy) field.
java.lang.String	getBody() Gets the body of this message.
java.lang.String[]	getCategories() Gets the list of categories for this document.
java.util.LinkedList	getCcAddresses() Gets the carbon copy (Cc) addresses.
java.lang.String	getCcAddressesString() Gets the string representation of a list of carbon copy (Cc) addresses.
com.compoze.util.mail.InternetAddress[]	getCcRecipients() Gets internet addresses of recipients set in the "Cc" (carbon copy) field.
int	getCharacterCount() Gets the number of characters in this document.
java.lang.String	getCheckedX0020By() Gets status property used by Microsoft Office Applications.
java.lang.String	getClient() Gets status property used by Microsoft Office Applications.
java.lang.String	getComments() Gets comments for the document.
java.lang.String	getCompany() Gets the company of this document's author.
java.lang.String[]	getContactNames() Gets the names of the contacts associated with this message.
java.util.Date	getDateCreated() Gets the date and time this office document was created.
java.lang.String	getDateX0020Completed() Gets status property used by Microsoft Office Applications.
java.lang.String	getDepartment() Gets the author's department.
java.lang.String	getDestination() Gets status property used by Microsoft Office Applications.
java.lang.String	getDisposition() Gets status property used by Microsoft Office Applications.
java.lang.String	getDivision() Gets status property used by Microsoft Office Applications.
java.lang.String	getDocumentSubject() Gets the subject of this document.
java.lang.String	getDocumentX0020Number() Gets status property used by Microsoft Office Applications.
java.lang.String	getEditor() Gets status property used by Microsoft Office Applications.
java.lang.String	getForwardX0020To() Gets status property used by Microsoft Office Applications.
java.lang.String	getGroup() Gets status property used by Microsoft Office Applications.
java.lang.String	getHeadingPairs() Gets status property used by Microsoft Office Applications.
int	getHiddenSlideCount() Gets the number of hidden slides in this document.
java.io.InputStream	getInputStream() Gets the input stream of this attachment to download from the Exchange server.
java.util.List	getKeywords() Gets the list of keywords.
java.lang.String	getLanguage() Gets the language the document was written.
java.lang.String	getLastAuthor() Gets the author who last saved the document.
java.util.Date	getLastPrinted() Gets the date and time this document was last printed.
java.util.Date	getLastSaved() Gets the date and time this document was last saved.
int	getLineCount() Gets the number of lines in this document.
java.lang.String	getMailStop() Gets status property used by Microsoft Office Applications.
java.lang.String	getManager() Gets the manager of the author of the document.
java.lang.String	getMatter() Gets status property used by Microsoft Office Applications.
int	getMultimediaClipCount() Gets the number of multimedia clips in the document.
int	getNoteCount() Gets the number of notes in the document.
java.lang.String	getOffice() Gets status property used by Microsoft Office Applications.
java.lang.String	getOwner() Gets status property used by Microsoft Office Applications.
int	getPageCount() Gets the number of pages in the document.
int	getParagraphCount() Gets the number of paragraphs in this document.
java.lang.String[]	getPartTitles()
java.lang.String	getPresentationFormat() Gets the presentation form for the document.
java.lang.String	getProject() Gets status property used by Microsoft Office Applications.
static java.util.List	getProperties() Gets a list of default properties pertaining to a document.
java.lang.String	getPublisher() Gets status property used by Microsoft Office Applications.
java.lang.String	getPurpose() Gets status property used by Microsoft Office Applications.
java.lang.String	getReceived() Gets status property used by Microsoft Office Applications.
java.lang.String	getRecorded() Gets status property used by Microsoft Office Applications.
java.lang.String	getRecordedX0020Date() Gets status property used by Microsoft Office Applications.
java.lang.String	getReference() Gets status property used by Microsoft Office Applications.
int	getRevision() Gets the revision number for the document.
int	getSecurity() Gets status property used by Microsoft Office Applications.
int	getSlideCount() Gets the number of slides in this document.
java.lang.String	getSource() Gets status property used by Microsoft Office Applications.
java.lang.String	getStatus() Gets status property used by Microsoft Office Applications.
java.lang.String	getTelephoneX0020Number() Gets status property used by Microsoft Office Applications.
java.lang.String	getTemplate() Gets the pathname for the template of the document.
java.lang.String	getTitle() Gets status property used by Microsoft Office Applications.
java.util.LinkedList	getToAddresses() Gets the principal (To) addresses.
java.lang.String	getToAddressesString() Gets the string representation of a list of principal (To) addresses.
com.compoze.util.mail.InternetAddress[]	getToRecipients() Gets internet addresses of recipients set in the "To" (principal) field.
java.lang.String	getTypist() Gets status property used by Microsoft Office Applications.
int	getVersion() Gets status property used by Microsoft Office Applications.
int	getWordCount() Gets the number of words in the document.
boolean	isLinksUpToDate() Determines if links are up-to-date.
boolean	isScaleCrop()
java.util.List	serverGetAttachments() Queries the server to get a list of the attachments of this message.
void	serverUpdate(boolean bServerRefresh) Requests the server to update the document of any changed properties.
void	setApplicationName(java.lang.String sName) Sets the name of the application.
void	setAuthor(java.lang.String sAuthor) Sets name of document author.
void	setBccAddresses(java.util.List addresses) Sets the blind carbon copy (Bcc) addresses.
void	setBccRecipients(com.compoze.util.mail.InternetAddress[] addressList) Sets "Bcc" (blind carbon copy) field with recipient's internet addresses.
void	setBccRecipients(java.lang.String sAddressList) Sets "Bcc" (blind carbon copy) field with sequence of recipient's internet addresses.
void	setBody(java.lang.String sBody) Sets the body of this message.
void	setCategories(java.util.List categories) Sets the list of categories for this document.
void	setCategories(java.lang.String[] categories) Sets the list of categories for the document.
void	setCcAddresses(java.util.List addresses) Sets the carbon copy (Cc) addresses.
void	setCcRecipients(com.compoze.util.mail.InternetAddress[] addressesList) Sets "Cc" (carbon copy) field with recipient's internet addresses.
void	setCcRecipients(java.lang.String sAddressList) Sets "Cc" (carbon copy) field with sequence of recipient's internet addresses.
void	setCharacterCount(int iCount) Sets the number of characters in this document.
void	setCheckedX0020By(java.lang.String sCheckedX0020By) Sets status property used by Microsoft Office Applications.
void	setClient(java.lang.String sClient) Sets status property used by Microsoft Office Applications.
void	setComments(java.lang.String sComments) Sets comments for the document.
void	setCompany(java.lang.String sCompany) Sets the company of this document's author.
void	setContactNames(java.util.List names) Sets the names of the contacts associated with this message.
void	setContactNames(java.lang.String[] names) Sets the names of the contacts associated with this message.
void	setDateCreated(java.util.Date created) Sets the date and time this office document was created.
void	setDateX0020Completed(java.lang.String sDateX0020Completed) Sets status property used by Microsoft Office Applications.
void	setDepartment(java.lang.String sDepartment) Sets the author's department.
void	setDestination(java.lang.String sDestination) Sets status property used by Microsoft Office Applications.
void	setDisposition(java.lang.String sDisposition) Sets status property used by Microsoft Office Applications.
void	setDivision(java.lang.String sDivision) Sets status property used by Microsoft Office Applications.
void	setDocumentSubject(java.lang.String sSubject) Sets the subject of this document.
void	setDocumentX0020Number(java.lang.String sDocumentX0020Number) Sets status property used by Microsoft Office Applications.
void	setEditor(java.lang.String sEditor) Sets status property used by Microsoft Office Applications.
void	setForwardX0020To(java.lang.String sForwardX0020To) Sets status property used by Microsoft Office Applications.
void	setGroup(java.lang.String sGroup) Sets status property used by Microsoft Office Applications.
void	setHeadingPairs(java.lang.String sHeadingPairs) Sets status property used by Microsoft Office Applications.
void	setHiddenSlideCount(int iCount) Gets the number of hidden slides in this document.
void	setKeywords(java.util.List keywords) Sets the list of keywords.
void	setLanguage(java.lang.String sLanguage) Sets the language the document was written.
void	setLastAuthor(java.lang.String sAuthor) Sets the author who last saved the document.
void	setLastPrinted(java.util.Date lastPrinted) Sets the date and time this document was last printed.
void	setLastSaved(java.util.Date lastSaved) Sets the date and time this document was last saved.
void	setLineCount(int iCount) Sets the number of lines in this document.
void	setLinksUpToDate(boolean bLinksUpToDate) Sets the link as up-to-date.
void	setMailStop(java.lang.String sMailStop) Sets status property used by Microsoft Office Applications.
void	setManager(java.lang.String sManager) Sets the manager of the author of the document.
void	setMatter(java.lang.String sMatter) Sets status property used by Microsoft Office Applications.
void	setMultimediaClipCount(int iCount) Sets the number of multimedia clips in the document.
void	setNoteCount(int iCount) Sets the number of notes in the document.
void	setOffice(java.lang.String sOffice) Sets status property used by Microsoft Office Applications.
void	setOwner(java.lang.String sOwner) Sets status property used by Microsoft Office Applications.
void	setPageCount(int iCount) Sets the number of pages in this document.
void	setParagraphCount(int iCount) Sets the number of paragraphs in this document.
void	setPartTitles(java.util.List partTitles)
void	setPartTitles(java.lang.String[] partTitles)
void	setPresentationFormat(java.lang.String sPresentationFormat) Sets the presentation form for the document.
void	setProject(java.lang.String sProject) Sets status property used by Microsoft Office Applications.
void	setPublisher(java.lang.String sPublisher) Sets status property used by Microsoft Office Applications.
void	setPurpose(java.lang.String sPurpose) Sets status property used by Microsoft Office Applications.
void	setReceived(java.lang.String sReceived) Sets status property used by Microsoft Office Applications.
void	setRecorded(java.lang.String sRecorded) Sets status property used by Microsoft Office Applications.
void	setRecordedX0020Date(java.lang.String sRecordedX0020Date) Sets status property used by Microsoft Office Applications.
void	setReference(java.lang.String sReference) Sets status property used by Microsoft Office Applications.
void	setRevision(int iRevision) Sets the revision number for the document.
void	setScaleCrop(boolean bScaleCrop) .
void	setSecurity(int iSecurity) Sets status property used by Microsoft Office Applications.
void	setSlideCount(int iCount) Gets the number of slides in this document.
void	setSource(java.lang.String sSource) Sets status property used by Microsoft Office Applications.
void	setStatus(java.lang.String sStatus) Sets status property used by Microsoft Office Applications.
void	setTelephoneX0020Number(java.lang.String sTelephoneX0020Number) Sets status property used by Microsoft Office Applications.
void	setTemplate(java.lang.String sTemplate) Sets the pathname for the template for the document
void	setTitle(java.lang.String sTitle) Sets status property used by Microsoft Office Applications.
void	setToAddresses(java.util.List addresses) Sets the principal (To) addresses.
void	setToRecipients(com.compoze.util.mail.InternetAddress[] addressList) Sets "To" (principal) field with recipient's internet addresses.
void	setToRecipients(java.lang.String sAddressList) Sets "To" (principal) field with sequence of recipient's internet addresses.
void	setTypist(java.lang.String sTypist) Sets status property used by Microsoft Office Applications.
void	setVersion(int iVersion) Sets status property used by Microsoft Office Applications.
void	setWordCount(int iWordCount) Sets the number of words in the document.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class com.compoze.exchange.webdav.AbstractMessage

equals, getAttachments, getDateReceived, getDefaultProperties, getFrom, getFromAddresses, getFromAddressesString, getFromEmailAddress, getFromName, getImportance, getNormalizedSubject, getSensitivity, getSize, getSubject, getTextDescription, getType, hasAttachment, isRead, serverDeleteAttachment, setDateReceived, setFrom, setFrom, setFromAddress, setFromAddresses, setImportance, setRead, setSensitivity, setSubject, setTextDescription, setType

Methods inherited from class com.compoze.exchange.webdav.AbstractItem

copy, copy, copy, createFilename, delete, equals, getComment, getContentClass, getCreationDate, getDateLastModified, getDisplayName, getFile, getHRef, getID, getParentFolder, getPermanentURL, getUID, isFolder, isHidden, isReadOnly, isRoot, move, move, move, serverCopyTo, serverCopyTo, serverCopyTo, serverCopyTo, serverDelete, serverGetParentFolder, serverMoveTo, serverMoveTo, serverMoveTo, serverMoveTo, serverUpdate, setComment, setContentClass, setContentClass, setHidden, setReadOnly, setReleased, setType, setUID, update, update, validate

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Document

public Document(java.lang.String sName,
                java.io.InputStream srcIs)
         throws java.io.IOException

Constructor.

Parameters:

sName - name of the document.

srcIs - input stream of the document.

Method Detail

getPartTitles

public java.lang.String[] getPartTitles()

See Also:

OfficeProperty.PART_TITLES

setPartTitles

public void setPartTitles(java.util.List partTitles)

See Also:

OfficeProperty.PART_TITLES

setPartTitles

public void setPartTitles(java.lang.String[] partTitles)

See Also:

OfficeProperty.PART_TITLES

getAuthor

public java.lang.String getAuthor()

Gets the name of document author.

Returns:

name of author

See Also:

OfficeProperty.AUTHOR

setAuthor

public void setAuthor(java.lang.String sAuthor)

Sets name of document author.

Parameters:

sAuthor - name of author

See Also:

OfficeProperty.AUTHOR

getCategories

public java.lang.String[] getCategories()

Gets the list of categories for this document.

Overrides:

getCategories in class AbstractMessage

Returns:

list of categories for the document.

See Also:

OfficeProperty.CATEGORY

setCategories

public void setCategories(java.util.List categories)

Sets the list of categories for this document.

Overrides:

setCategories in class AbstractMessage

Parameters:

categories - list of categories for the document.

See Also:

OfficeProperty.CATEGORY

setCategories

public void setCategories(java.lang.String[] categories)

Sets the list of categories for the document.

Overrides:

setCategories in class AbstractMessage

Parameters:

categories - list of categories for the document.

See Also:

OfficeProperty.CATEGORY

getCharacterCount

public int getCharacterCount()

Gets the number of characters in this document.

Returns:

number of characters in the document.

See Also:

OfficeProperty.CHARACTERS

setCharacterCount

public void setCharacterCount(int iCount)

Sets the number of characters in this document.

Parameters:

iCount - number of characters in the document.

See Also:

OfficeProperty.CHARACTERS

getCheckedX0020By

public java.lang.String getCheckedX0020By()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.CHECKED_X0020_BY

setCheckedX0020By

public void setCheckedX0020By(java.lang.String sCheckedX0020By)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sCheckedX0020By - status property

See Also:

OfficeProperty.CHECKED_X0020_BY

getClient

public java.lang.String getClient()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.CLIENT

setClient

public void setClient(java.lang.String sClient)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sClient - status property

See Also:

OfficeProperty.CLIENT

getComments

public java.lang.String getComments()

Gets comments for the document. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

comments

See Also:

OfficeProperty.COMMENTS

setComments

public void setComments(java.lang.String sComments)

Sets comments for the document. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sComments - comments

See Also:

OfficeProperty.COMMENTS

getCompany

public java.lang.String getCompany()

Gets the company of this document's author. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

the company of the document's author.

See Also:

OfficeProperty.COMPANY

setCompany

public void setCompany(java.lang.String sCompany)

Sets the company of this document's author. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sCompany - the company of the document's author.

See Also:

OfficeProperty.COMPANY

getDateCreated

public java.util.Date getDateCreated()

Gets the date and time this office document was created.

Returns:

date the document was created

See Also:

OfficeProperty.CREATED

setDateCreated

public void setDateCreated(java.util.Date created)

Sets the date and time this office document was created.

Parameters:

created - date the document was created.

See Also:

OfficeProperty.CREATED

getDateX0020Completed

public java.lang.String getDateX0020Completed()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.DATE_X0020_COMPLETED

setDateX0020Completed

public void setDateX0020Completed(java.lang.String sDateX0020Completed)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sDateX0020Completed - status property

See Also:

OfficeProperty.DATE_X0020_COMPLETED

getDepartment

public java.lang.String getDepartment()

Gets the author's department. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

author's department

See Also:

OfficeProperty.DEPARTMENT

setDepartment

public void setDepartment(java.lang.String sDepartment)

Sets the author's department. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sDepartment - the author's department

See Also:

OfficeProperty.DEPARTMENT

getDestination

public java.lang.String getDestination()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.DESTINATION

setDestination

public void setDestination(java.lang.String sDestination)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sDestination - status property

See Also:

OfficeProperty.DESTINATION

getDisposition

public java.lang.String getDisposition()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.DISPOSITION

setDisposition

public void setDisposition(java.lang.String sDisposition)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sDisposition - status property

See Also:

OfficeProperty.DISPOSITION

getDivision

public java.lang.String getDivision()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.DIVISION

setDivision

public void setDivision(java.lang.String sDivision)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sDivision - status property

See Also:

OfficeProperty.DIVISION

getDocumentX0020Number

public java.lang.String getDocumentX0020Number()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.DOCUMENT_X0020_NUMBER

setDocumentX0020Number

public void setDocumentX0020Number(java.lang.String sDocumentX0020Number)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sDocumentX0020Number - status property

See Also:

OfficeProperty.DOCUMENT_X0020_NUMBER

getEditor

public java.lang.String getEditor()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.EDITOR

setEditor

public void setEditor(java.lang.String sEditor)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sEditor - status property

See Also:

OfficeProperty.EDITOR

getForwardX0020To

public java.lang.String getForwardX0020To()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.FORWARD_X0020_TO

setForwardX0020To

public void setForwardX0020To(java.lang.String sForwardX0020To)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sForwardX0020To - status property

See Also:

OfficeProperty.FORWARD_X0020_TO

getGroup

public java.lang.String getGroup()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.GROUP

setGroup

public void setGroup(java.lang.String sGroup)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sGroup - status property

See Also:

OfficeProperty.GROUP

getHeadingPairs

public java.lang.String getHeadingPairs()

Gets status property used by Microsoft Office Applications.

Returns:

status property

See Also:

OfficeProperty.HEADING_PAIRS

setHeadingPairs

public void setHeadingPairs(java.lang.String sHeadingPairs)

Sets status property used by Microsoft Office Applications.

Parameters:

sHeadingPairs - status property

See Also:

OfficeProperty.HEADING_PAIRS

getHiddenSlideCount

public int getHiddenSlideCount()

Gets the number of hidden slides in this document.

Returns:

number of hidden slides in the document.

See Also:

OfficeProperty.HIDDEN_SLIDES

setHiddenSlideCount

public void setHiddenSlideCount(int iCount)

Gets the number of hidden slides in this document.

Parameters:

iCount - number of hidden slides in the document.

See Also:

OfficeProperty.HIDDEN_SLIDES

getKeywords

public java.util.List getKeywords()

Gets the list of keywords.

Returns:

list of keywords

See Also:

OfficeProperty.KEYWORDS

setKeywords

public void setKeywords(java.util.List keywords)

Sets the list of keywords.

Parameters:

keywords - list of keywords

See Also:

OfficeProperty.KEYWORDS

getLanguage

public java.lang.String getLanguage()

Gets the language the document was written. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

the language

See Also:

OfficeProperty.LANGUAGE

setLanguage

public void setLanguage(java.lang.String sLanguage)

Sets the language the document was written. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sLanguage - the language

See Also:

OfficeProperty.LANGUAGE

getLastAuthor

public java.lang.String getLastAuthor()

Gets the author who last saved the document.

Returns:

the author

See Also:

OfficeProperty.LAST_AUTHOR

setLastAuthor

public void setLastAuthor(java.lang.String sAuthor)

Sets the author who last saved the document.

Parameters:

sAuthor - the author

See Also:

OfficeProperty.LAST_AUTHOR

getLastPrinted

public java.util.Date getLastPrinted()

Gets the date and time this document was last printed.

Returns:

date and time the document was last printed.

See Also:

OfficeProperty.LAST_PRINTED

setLastPrinted

public void setLastPrinted(java.util.Date lastPrinted)

Sets the date and time this document was last printed.

Parameters:

lastPrinted - date and time the document was last printed.

See Also:

OfficeProperty.LAST_PRINTED

getLastSaved

public java.util.Date getLastSaved()

Gets the date and time this document was last saved.

Returns:

date and time the document was last saved.

See Also:

OfficeProperty.LAST_SAVED

setLastSaved

public void setLastSaved(java.util.Date lastSaved)

Sets the date and time this document was last saved.

Parameters:

lastSaved - date and time the document was last saved.

See Also:

OfficeProperty.LAST_SAVED

getLineCount

public int getLineCount()

Gets the number of lines in this document.

Returns:

number of lines in the document.

See Also:

OfficeProperty.LINES

setLineCount

public void setLineCount(int iCount)

Sets the number of lines in this document.

Parameters:

iCount - number of lines in the document

See Also:

OfficeProperty.LINES

isLinksUpToDate

public boolean isLinksUpToDate()

Determines if links are up-to-date.

Returns:

true if links up-to-date.

See Also:

OfficeProperty.LINKS_UP_TO_DATE

setLinksUpToDate

public void setLinksUpToDate(boolean bLinksUpToDate)

Sets the link as up-to-date.

Parameters:

bLinksUpToDate - true if links up-to-date; false otherwise

See Also:

OfficeProperty.LINKS_UP_TO_DATE

getMailStop

public java.lang.String getMailStop()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.MAILSTOP

setMailStop

public void setMailStop(java.lang.String sMailStop)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sMailStop - status property

See Also:

OfficeProperty.MAILSTOP

getManager

public java.lang.String getManager()

Gets the manager of the author of the document.

Returns:

the name of the manager

See Also:

OfficeProperty.MANAGER

setManager

public void setManager(java.lang.String sManager)

Sets the manager of the author of the document.

Parameters:

sManager - the name of the manager

See Also:

OfficeProperty.MANAGER

getMatter

public java.lang.String getMatter()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.MATTER

setMatter

public void setMatter(java.lang.String sMatter)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sMatter - status property

See Also:

OfficeProperty.MATTER

getMultimediaClipCount

public int getMultimediaClipCount()

Gets the number of multimedia clips in the document.

Returns:

number of multimedia clips in the document.

See Also:

OfficeProperty.MULTIMEDIA_CLIPS

setMultimediaClipCount

public void setMultimediaClipCount(int iCount)

Sets the number of multimedia clips in the document.

Parameters:

iCount - number of multimedia clips in the document.

See Also:

OfficeProperty.MULTIMEDIA_CLIPS

getApplicationName

public java.lang.String getApplicationName()

Gets the name of the application.

Returns:

name of application

See Also:

OfficeProperty.NAME_OF_APPLICATION

setApplicationName

public void setApplicationName(java.lang.String sName)

Sets the name of the application.

Parameters:

sName - name of application

See Also:

OfficeProperty.NAME_OF_APPLICATION

getNoteCount

public int getNoteCount()

Gets the number of notes in the document.

Returns:

number of notes in the document

See Also:

OfficeProperty.NOTES

setNoteCount

public void setNoteCount(int iCount)

Sets the number of notes in the document.

Parameters:

iCount - number of notes in the document.

See Also:

OfficeProperty.NOTES

getOffice

public java.lang.String getOffice()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.OFFICE

setOffice

public void setOffice(java.lang.String sOffice)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sOffice - status property

See Also:

OfficeProperty.OFFICE

getOwner

public java.lang.String getOwner()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.OWNER

setOwner

public void setOwner(java.lang.String sOwner)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sOwner - status property

See Also:

OfficeProperty.OWNER

getPageCount

public int getPageCount()

Gets the number of pages in the document.

Returns:

number of pages in the document.

See Also:

OfficeProperty.PAGES

setPageCount

public void setPageCount(int iCount)

Sets the number of pages in this document.

Parameters:

iCount - number of pages in the document.

See Also:

OfficeProperty.PAGES

getParagraphCount

public int getParagraphCount()

Gets the number of paragraphs in this document.

Returns:

number of paragraphs in the document.

See Also:

OfficeProperty.PARAGRAPHS

setParagraphCount

public void setParagraphCount(int iCount)

Sets the number of paragraphs in this document.

Parameters:

iCount - number of paragraphs in the document.

See Also:

OfficeProperty.PARAGRAPHS

getPresentationFormat

public java.lang.String getPresentationFormat()

Gets the presentation form for the document.

Returns:

the presentation format

See Also:

OfficeProperty.PRESENTATION_FORMAT

setPresentationFormat

public void setPresentationFormat(java.lang.String sPresentationFormat)

Sets the presentation form for the document.

Parameters:

sPresentationFormat - the presentation format

See Also:

OfficeProperty.PRESENTATION_FORMAT

getProject

public java.lang.String getProject()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.PROJECT

setProject

public void setProject(java.lang.String sProject)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sProject - status property

See Also:

OfficeProperty.PROJECT

getPublisher

public java.lang.String getPublisher()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.PUBLISHER

setPublisher

public void setPublisher(java.lang.String sPublisher)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sPublisher - status property

See Also:

OfficeProperty.PUBLISHER

getPurpose

public java.lang.String getPurpose()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.PURPOSE

setPurpose

public void setPurpose(java.lang.String sPurpose)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sPurpose - status property

See Also:

OfficeProperty.PURPOSE

getReceived

public java.lang.String getReceived()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.RECEIVED

setReceived

public void setReceived(java.lang.String sReceived)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sReceived - status property

See Also:

OfficeProperty.RECEIVED

getRecorded

public java.lang.String getRecorded()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.RECORDED

setRecorded

public void setRecorded(java.lang.String sRecorded)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sRecorded - status property

See Also:

OfficeProperty.RECORDED

getRecordedX0020Date

public java.lang.String getRecordedX0020Date()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.RECORDED_X0020_DATE

setRecordedX0020Date

public void setRecordedX0020Date(java.lang.String sRecordedX0020Date)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sRecordedX0020Date - status property

See Also:

OfficeProperty.RECORDED_X0020_DATE

getReference

public java.lang.String getReference()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.REFERENCE

setReference

public void setReference(java.lang.String sReference)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sReference - status property

See Also:

OfficeProperty.REFERENCE

getRevision

public int getRevision()

Gets the revision number for the document.

Returns:

the revision number

See Also:

OfficeProperty.REVISION

setRevision

public void setRevision(int iRevision)

Sets the revision number for the document.

Parameters:

iRevision - the revision number

See Also:

OfficeProperty.REVISION

isScaleCrop

public boolean isScaleCrop()

See Also:

OfficeProperty.SCALE_CROP

setScaleCrop

public void setScaleCrop(boolean bScaleCrop)

.

See Also:

OfficeProperty.SCALE_CROP

getSecurity

public int getSecurity()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.SECURITY

setSecurity

public void setSecurity(int iSecurity)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

iSecurity - status property

See Also:

OfficeProperty.SECURITY

getSlideCount

public int getSlideCount()

Gets the number of slides in this document.

Returns:

number of slides in the document

See Also:

OfficeProperty.SLIDES

setSlideCount

public void setSlideCount(int iCount)

Gets the number of slides in this document.

Parameters:

iCount - number of slides in the document.

See Also:

OfficeProperty.SLIDES

getSource

public java.lang.String getSource()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.SOURCE

setSource

public void setSource(java.lang.String sSource)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sSource - status property

See Also:

OfficeProperty.SOURCE

getStatus

public java.lang.String getStatus()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.STATUS

setStatus

public void setStatus(java.lang.String sStatus)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sStatus - status property

See Also:

OfficeProperty.STATUS

getDocumentSubject

public java.lang.String getDocumentSubject()

Gets the subject of this document. The method AbstractMessage.getSubject(), for a document, is used for display purposes.

Returns:

the subject of the document

See Also:

OfficeProperty.SUBJECT

setDocumentSubject

public void setDocumentSubject(java.lang.String sSubject)

Sets the subject of this document. The method AbstractMessage.setSubject(String), for a document, is used for display purposes.

Parameters:

sSubject - the subject of the document

See Also:

OfficeProperty.SUBJECT

getTelephoneX0020Number

public java.lang.String getTelephoneX0020Number()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.TELEPHONE_X0020_NUMBER

setTelephoneX0020Number

public void setTelephoneX0020Number(java.lang.String sTelephoneX0020Number)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sTelephoneX0020Number - status property

See Also:

OfficeProperty.TELEPHONE_X0020_NUMBER

getTemplate

public java.lang.String getTemplate()

Gets the pathname for the template of the document.

Returns:

the template pathname

See Also:

OfficeProperty.TEMPLATE

setTemplate

public void setTemplate(java.lang.String sTemplate)

Sets the pathname for the template for the document

Parameters:

sTemplate - the template pathname

See Also:

OfficeProperty.TEMPLATE

getTitle

public java.lang.String getTitle()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.TITLE

setTitle

public void setTitle(java.lang.String sTitle)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sTitle - status property

See Also:

OfficeProperty.TITLE

getTypist

public java.lang.String getTypist()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.TYPIST

setTypist

public void setTypist(java.lang.String sTypist)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

sTypist - status property

See Also:

OfficeProperty.TYPIST

getVersion

public int getVersion()

Gets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Returns:

status property

See Also:

OfficeProperty.VERSION

setVersion

public void setVersion(int iVersion)

Sets status property used by Microsoft Office Applications. This field is located on the Custom tab in the Properties dialog box within Office applications.

Parameters:

iVersion - status property

See Also:

OfficeProperty.VERSION

getWordCount

public int getWordCount()

Gets the number of words in the document.

Returns:

the number of words

See Also:

OfficeProperty.WORDS

setWordCount

public void setWordCount(int iWordCount)

Sets the number of words in the document.

Parameters:

iWordCount - the number of words

See Also:

OfficeProperty.WORDS

getBody

public java.lang.String getBody()

Description copied from class: AbstractMessage

Gets the body of this message.

Overrides:

getBody in class AbstractMessage

Throws:

UnsupportedOperationException - if the getBody operation is not supported by this document.

setBody

public void setBody(java.lang.String sBody)

Description copied from class: AbstractMessage

Sets the body of this message.

Overrides:

setBody in class AbstractMessage

Throws:

UnsupportedOperationException - if the setBody operation is not supported by this document.

getContactNames

public java.lang.String[] getContactNames()

Description copied from class: AbstractMessage

Gets the names of the contacts associated with this message.

Overrides:

getContactNames in class AbstractMessage

Throws:

UnsupportedOperationException - if the getContactNames operation is not supported by this document.

setContactNames

public void setContactNames(java.util.List names)

Description copied from class: AbstractMessage

Sets the names of the contacts associated with this message.

Overrides:

setContactNames in class AbstractMessage

Throws:

UnsupportedOperationException - if the setContactNames operation is not supported by this document.

setContactNames

public void setContactNames(java.lang.String[] names)

Description copied from class: AbstractMessage

Sets the names of the contacts associated with this message.

Overrides:

setContactNames in class AbstractMessage

Throws:

UnsupportedOperationException - if the setContactNames operation is not supported by this document.

getToAddressesString

public java.lang.String getToAddressesString()

Description copied from class: AbstractMessage

Gets the string representation of a list of principal (To) addresses.

Overrides:

getToAddressesString in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getToAddresses

public java.util.LinkedList getToAddresses()

Description copied from class: AbstractMessage

Gets the principal (To) addresses.

Overrides:

getToAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

setToAddresses

public void setToAddresses(java.util.List addresses)

Description copied from class: AbstractMessage

Sets the principal (To) addresses.

Overrides:

setToAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getToRecipients

public com.compoze.util.mail.InternetAddress[] getToRecipients()
                                                        throws com.compoze.util.mail.AddressException

Gets internet addresses of recipients set in the "To" (principal) field.

Overrides:

getToRecipients in class AbstractMessage

Returns:

array of InternetAddress objects; or null if not set

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.TO

setToRecipients

public void setToRecipients(java.lang.String sAddressList)
                     throws com.compoze.util.mail.AddressException

Sets "To" (principal) field with sequence of recipient's internet addresses.

Overrides:

setToRecipients in class AbstractMessage

Parameters:

sAddressList - sequence of internet addresses

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.TO

setToRecipients

public void setToRecipients(com.compoze.util.mail.InternetAddress[] addressList)

Sets "To" (principal) field with recipient's internet addresses.

Overrides:

setToRecipients in class AbstractMessage

Parameters:

addressList - array of InternetAddress objects

Throws:

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.TO

getCcAddressesString

public java.lang.String getCcAddressesString()

Description copied from class: AbstractMessage

Gets the string representation of a list of carbon copy (Cc) addresses.

Overrides:

getCcAddressesString in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getCcAddresses

public java.util.LinkedList getCcAddresses()

Description copied from class: AbstractMessage

Gets the carbon copy (Cc) addresses.

Overrides:

getCcAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

setCcAddresses

public void setCcAddresses(java.util.List addresses)

Description copied from class: AbstractMessage

Sets the carbon copy (Cc) addresses.

Overrides:

setCcAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getCcRecipients

public com.compoze.util.mail.InternetAddress[] getCcRecipients()
                                                        throws com.compoze.util.mail.AddressException

Gets internet addresses of recipients set in the "Cc" (carbon copy) field.

Overrides:

getCcRecipients in class AbstractMessage

Returns:

array of InternetAddress objects; or null if not set

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.CC

setCcRecipients

public void setCcRecipients(java.lang.String sAddressList)
                     throws com.compoze.util.mail.AddressException

Sets "Cc" (carbon copy) field with sequence of recipient's internet addresses.

Overrides:

setCcRecipients in class AbstractMessage

Parameters:

sAddressList - sequence of internet addresses

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.CC

setCcRecipients

public void setCcRecipients(com.compoze.util.mail.InternetAddress[] addressesList)

Sets "Cc" (carbon copy) field with recipient's internet addresses.

Overrides:

setCcRecipients in class AbstractMessage

Parameters:

addressesList - array of InternetAddress objects

Throws:

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.CC

getBccAddressesString

public java.lang.String getBccAddressesString()

Description copied from class: AbstractMessage

Gets the string representation of a list of blind carbon copy (Bcc) addresses.

Overrides:

getBccAddressesString in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getBccAddresses

public java.util.LinkedList getBccAddresses()

Description copied from class: AbstractMessage

Gets the blind carbon copy (Bcc) addresses.

Overrides:

getBccAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

setBccAddresses

public void setBccAddresses(java.util.List addresses)

Description copied from class: AbstractMessage

Sets the blind carbon copy (Bcc) addresses.

Overrides:

setBccAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getBccRecipients

public com.compoze.util.mail.InternetAddress[] getBccRecipients()
                                                         throws com.compoze.util.mail.AddressException

Gets internet addresses of recipients set in the "Bcc" (blind carbon copy) field.

Overrides:

getBccRecipients in class AbstractMessage

Returns:

array of InternetAddress objects; or null if not set

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.BCC

setBccRecipients

public void setBccRecipients(java.lang.String sAddressList)
                      throws com.compoze.util.mail.AddressException

Sets "Bcc" (blind carbon copy) field with sequence of recipient's internet addresses.

Overrides:

setBccRecipients in class AbstractMessage

Parameters:

sAddressList - sequence of internet addresses

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.BCC

setBccRecipients

public void setBccRecipients(com.compoze.util.mail.InternetAddress[] addressList)

Sets "Bcc" (blind carbon copy) field with recipient's internet addresses.

Overrides:

setBccRecipients in class AbstractMessage

Parameters:

addressList - array of InternetAddress objects

Throws:

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.BCC

addAttachment

public void addAttachment(Attachment attachment)
                   throws ExchangeException

Description copied from class: AbstractMessage

Adds an attachement to this message. Call this method multiple times to add more than one attachment.

Overrides:

addAttachment in class AbstractMessage

Throws:

UnsupportedOperationException - if the addAttachment operation is not supported by this document.

serverGetAttachments

public java.util.List serverGetAttachments()
                                    throws ExchangeException

Description copied from class: AbstractMessage

Queries the server to get a list of the attachments of this message. Use hasAttachment() first to determine if this message has attachments.

Overrides:

serverGetAttachments in class AbstractMessage

Throws:

UnsupportedOperationException - if the getAttachments operation is not supported by this document.

getInputStream

public java.io.InputStream getInputStream()
                                   throws ExchangeException

Gets the input stream of this attachment to download from the Exchange server.

Returns:

the input stream

serverUpdate

public void serverUpdate(boolean bServerRefresh)
                  throws ExchangeException

Requests the server to update the document of any changed properties.

If the document does not exist in the Exchange store, it is created, else the existing document is updated.

An AttachmentException is thrown if any conflicts occur attaching (uploading) files to the document. The exception will state what files failed to attach. The document is still updated and can be sent, but will exclude the failed attachments.

Overrides:

serverUpdate in class AbstractMessage

Parameters:

bServerRefresh - true requests the server to refresh the properties

Throws:

AttachmentException - if any files failed to attached to this document.

ExchangeException - if a problem occurred while connecting to or interaction with Exchange Server

ExchangeRuntimeException - if this object has been released and can no longer be used

createFilename

protected java.lang.String createFilename(int iIndex)

Creates a filename for this document.

Overrides:

createFilename in class AbstractMessage

Parameters:

iIndex - the index to append

Returns:

the filename

See Also:

AbstractItem.createFilename(int)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates and returns a copy of this object.

Overrides:

clone in class AbstractMessage

Returns:

a clone of this instance.

Throws:

java.lang.CloneNotSupportedException - if the object's class does not support the Cloneable interface.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class AbstractMessage

Returns:

the string representation of the object.

getProperties

public static java.util.List getProperties()

Gets a list of default properties pertaining to a document.

Returns:

a list (unmodifiable) of properties.

See Also:

AbstractMessage.getProperties()