Overview | Package | Class | Tree | Deprecated | Index | Help
| Compoze Software, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.compoze.exchange
Class Journal

    java.lang.Object
      com.compoze.exchange.AbstractItem
          com.compoze.exchange.Message
              com.compoze.exchange.Journal

All Implemented Interfaces:
  java.io.Serializable

public class Journal
extends Message
implements java.io.Serializable

This class is an Exchange journal entry. Journal instances are obtained from the `Journals` class. Methods that access properites on the class require that the properties were loaded beforehand, when the message was initially retrieved. Any methods in this class that begin with the string `server` make a query to the server, and require that the `PropertyKey.MESSAGE_ID` and `PropertyKey.MESSAGE_TYPE` properties to be loaded beforehand. Any additional property requirements are indicated on each individual method.

See Also:
  Serialized Form

Field Summary
`static PropertyKey[]` | `ALL_PROPS` Contains an array of all of the properties available on a journal.

Fields inherited from class com.compoze.exchange.AbstractItem
`m_props, m_session`

Method Summary
`java.lang.String` | `getBillingInfo()` Gets the billing info of the journal.
`java.lang.String[]` | `getCompanies()` Gets the companies of the journal.
`java.lang.String[]` | `getContactNames()` Gets the contact names of the journal.
`int` | `getDuration()` Gets the duration of the journal.
`JournalEntryType` | `getEntryType()` Sets the entry type of the journal.
`java.lang.String` | `getMileage()` Gets the mileage of the journal.
`java.util.Date` | `getStartDate()` Gets the start date of the journal.
`void` | `setBillingInfo(java.lang.String sBillingInfo)` Sets the billing info of the journal.
`void` | `setCompanies(java.lang.String[] companies)` Sets the companies of the journal.
`void` | `setContactNames(java.lang.String[] contactNames)` Sets the contact names of the journal.
`void` | `setDuration(int iDuration)` Sets the duration of the journal.
`void` | `setEntryType(JournalEntryType type)` Sets the entry type of the journal.
`void` | `setMileage(java.lang.String sMileage)` Sets the mileage of the journal.
`void` | `setSender(AddressEntry addressEntry)` This method is not allowed on this `Message` type.
`void` | `setStartDate(java.util.Date startDate)` Sets the start date of the journal.

Methods inherited from class com.compoze.exchange.Message
`getActionStatus, getAttachmentCount, getAttachmentInfo, getAttachmentInfoArray, getCategories, getConversationIndex, getConversationTopic, getDeliveryReceipt, getEncrypted, getFlagStatus, getFlagText, getFolderID, getFolderName, getHtml, getHtml, getID, getImportance, getMessageType, getNormalizedSubject, getReadReceipt, getRecipientInfo, getRecipientInfoArray, getRichTextFormat, getRichTextFormatAsHtml, getRichTextFormatAsHtml, getRichTextFormatAsPlain, getSender, getSenderName, getSensitivity, getSent, getSigned, getSize, getStoreID, getSubject, getSubject, getSubmitted, getText, getTimeCreated, getTimeExpired, getTimeLastModified, getTimeReceived, getTimeReceivedString, getTimeSent, getUnread, hasAttachment, serverAddAttachment, serverCopyTo, serverDelete, serverDelete, serverDeleteAttachment, serverGetAttachment, serverGetAttachments, serverMoveTo, serverMoveTo, serverResolveRecipients, serverUpdate, serverUpdate, serverUpdate, setActionStatus, setCategories, setConversationIndex, setConversationTopic, setDeliveryReceipt, setEncrypted, setFlagStatus, setFlagText, setFlagText, setHtml, setImportance, setMessageType, setReadReceipt, setRichTextFormat, setSensitivity, setSent, setSigned, setSubject, setSubmitted, setText, setTimeExpired, setTimeReceived, setTimeSent, setUnread, toString`

Methods inherited from class com.compoze.exchange.AbstractItem
`get, getBoolean, getByteArray, getDate, getDouble, getInt, getInvalidPropertyValues, getPropertyKeys, getString, getStringArray, getUpdatedPropertyValues, set, setBoolean, setByteArray, setDate, setDouble, setInt, setString, setStringArray`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### ALL_PROPS

    public static final PropertyKey[] ALL_PROPS

  Contains an array of all of the properties available on a journal. Although this can be used when specifying property keys to retrieve, it's preferable to only specify the keys that are required as the number of properties that are pulled back from the server has a direct impact on performance.

Method Detail

### getBillingInfo

    public java.lang.String getBillingInfo()
                                    throws ExchangeException

  Gets the billing info of the journal.

  Returns:
    the billing info of the journal
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.BILLING_INFO`

### setBillingInfo

    public void setBillingInfo(java.lang.String sBillingInfo)
                        throws ExchangeException

  Sets the billing info of the journal.

  Parameters:
    `sBillingInfo` - the billing info of the journal
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.BILLING_INFO`

### getMileage

    public java.lang.String getMileage()
                                throws ExchangeException

  Gets the mileage of the journal.

  Returns:
    the mileage of the journal
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.MILEAGE`

### setMileage

    public void setMileage(java.lang.String sMileage)
                    throws ExchangeException

  Sets the mileage of the journal.

  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.MILEAGE`

### getContactNames

    public java.lang.String[] getContactNames()
                                       throws ExchangeException

  Gets the contact names of the journal.

  Returns:
    the contact names of the journal
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.CONTACT_NAMES`

### setContactNames

    public void setContactNames(java.lang.String[] contactNames)
                         throws ExchangeException

  Sets the contact names of the journal.

  Parameters:
    `contactNames` - the contact names of the journal
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.CONTACT_NAMES`

### getCompanies

    public java.lang.String[] getCompanies()
                                    throws ExchangeException

  Gets the companies of the journal.

  Returns:
    the companies of the journal
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.COMPANIES`

### setCompanies

    public void setCompanies(java.lang.String[] companies)
                      throws ExchangeException

  Sets the companies of the journal.

  Parameters:
    `companies` - the companies of the journal
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.COMPANIES`

### getStartDate

    public java.util.Date getStartDate()
                                throws ExchangeException

  Gets the start date of the journal.

  Returns:
    the start date of the journal
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.JOURNAL_START_DATE`

### setStartDate

    public void setStartDate(java.util.Date startDate)
                      throws ExchangeException

  Sets the start date of the journal.

  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.JOURNAL_START_DATE`

### getDuration

    public int getDuration()
                    throws ExchangeException

  Gets the duration of the journal.

  Returns:
    the duration of the journal (in minutes)
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.JOURNAL_DURATION`

### setDuration

    public void setDuration(int iDuration)
                     throws ExchangeException

  Sets the duration of the journal.

  Returns:
    the duration of the journal (in minutes)
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.JOURNAL_DURATION`

### getEntryType

    public JournalEntryType getEntryType()
                                  throws ExchangeException

  Sets the entry type of the journal.

  Returns:
    the entry type of the journal
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.JOURNAL_ENTRY_TYPE`

### setEntryType

    public void setEntryType(JournalEntryType type)
                      throws ExchangeException

  Sets the entry type of the journal.

  Returns:
    the entry type of the journal
  Throws:
    `ExchangeException`
  See Also:
    `PropertyKey.JOURNAL_ENTRY_TYPE`

### setSender

    public void setSender(AddressEntry addressEntry)
                   throws ExchangeException

  This method is not allowed on this `Message` type.

  Overrides:
    `setSender` in class `Message`
  Parameters:
    `addressEntry` - the address entry of the sender
  Throws:
    `ExchangeException` - this method is not allowed

Overview | Package | Class | Tree | Deprecated | Index | Help
| Compoze Software, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright ©1999-2003 Compoze Software, Inc. All rights reserved.