com.compoze.exchange.webdav
Class JournalFolder

java.lang.Object

  |

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

        |

        +--com.compoze.exchange.webdav.Folder

              |

              +--com.compoze.exchange.webdav.JournalFolder

All Implemented Interfaces:

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

public class JournalFolder

extends Folder

implements java.io.Serializable

This class extends Folder to represent a folder that primarily contains journal items. This class provides access methods to retrieve collections of journal entries.

See Also:

Serialized Form

Fields inherited from class com.compoze.exchange.webdav.Folder

m_folders, m_iRelDepth, m_messages

Constructor Summary

JournalFolder(java.lang.String sName)
Constructor.

Method Summary

JournalEntries	getEntries(JournalEntryFilter filter) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, JournalEntryFilter, SortOrder, RowRange)
JournalEntries	getEntries(java.util.List props) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, SortOrder, RowRange)
JournalEntries	getEntries(java.util.List properties, int iScope, JournalEntryFilter filter, SortOrder order, RowRange range) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, int, JournalEntryFilter, SortOrder, RowRange)
JournalEntries	getEntries(java.util.List props, JournalEntryFilter filter) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, JournalEntryFilter, SortOrder, RowRange)
JournalEntries	getEntries(java.util.List properties, JournalEntryFilter filter, SortOrder order, RowRange range) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, JournalEntryFilter, SortOrder, RowRange)
JournalEntries	getEntries(java.util.List properties, SortOrder order, RowRange range) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, SortOrder, RowRange)
JournalEntries	serverGetEntries(java.util.List properties, int iScope, JournalEntryFilter filter, SortOrder order, RowRange range) Queries the server for a list of journal entries.
JournalEntries	serverGetEntries(java.util.List properties, JournalEntryFilter filter, SortOrder order, RowRange range) Queries the server for a list of journal entries.
JournalEntries	serverGetEntries(java.util.List properties, SortOrder order, RowRange range) Queries the server for a list of journal entries.

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

addItem, addItem, clone, createFilename, deleteItem, deleteItem, equals, getDefaultProperties, getFolder, getFolder, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getLocalFolders, getLocalItems, getLocalMessages, getMessageCount, getProperties, getRelativeDepth, getSize, getType, getUnreadCount, getUnreadCount, getUnreadMessageCount, getVisibleCount, getVisibleCount, getVisibleCount, getVisibleCount, hasSubFolders, isDeletedItemsFolder, isDraftsFolder, isInboxFolder, isOutboxFolder, isSentItemsFolder, rename, serverAddItem, serverAddItem, serverDelete, serverDeleteItem, serverDeleteItem, serverGetFolders, serverGetFolders, serverGetFolders, serverGetFolders, serverGetMessageCount, serverGetMessageCount, serverGetMessages, serverGetMessages, serverGetMessages, serverGetUnreadMessageCount, serverRename, serverUpdate, setRelativeDepth, setType, toString

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, 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

JournalFolder

public JournalFolder(java.lang.String sName)

Constructor.

Parameters:

sName - the name of the folder.

Method Detail

serverGetEntries

public JournalEntries serverGetEntries(java.util.List properties,
                                       SortOrder order,
                                       RowRange range)
                                throws ExchangeException

Queries the server for a list of journal entries.

Parameters:

properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)

order - the order to sort by

range - the range of rows to return

Returns:

a list of JournalEntry objects

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

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

java.lang.IllegalArgumentException - if properties are not specified

serverGetEntries

public JournalEntries serverGetEntries(java.util.List properties,
                                       JournalEntryFilter filter,
                                       SortOrder order,
                                       RowRange range)
                                throws ExchangeException

Queries the server for a list of journal entries.

Parameters:

properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)

filter - the conditions to search by

order - the order to sort by

range - the range of rows to return

Returns:

a list of JournalEntry objects

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

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

java.lang.IllegalArgumentException - if properties are not specified

serverGetEntries

public JournalEntries serverGetEntries(java.util.List properties,
                                       int iScope,
                                       JournalEntryFilter filter,
                                       SortOrder order,
                                       RowRange range)
                                throws ExchangeException

Queries the server for a list of journal entries.

If no sort order is provided (order == null), the following sort order is used:

• MapiProperty.JOURNAL_ENTRY_TYPE, SortOrder.ASCENDING
• MapiProperty.JOURNAL_START_DATE, SortOrder.ASCENDING
• HttpMailProperty.NORMALIZED_SUBJECT, SortOrder.ASCENDING
• HttpMailProperty.DATE_RECEIVED, SortOrder.ASCENDING

DO NOT SORT BY HttpMailProperty.SUBJECT. This property is not searchable because its value is only calculated when used and not stored in the Exchange store. Use HttpMailProperty.NORMALIZED_SUBJECT or MailHeaderProperty.SUBJECT.

Parameters:

properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)

iScope - the scope of the search

filter - the conditions to search by

order - the order to sort by

range - the range of rows to return

Returns:

a list of JournalEntry objects

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

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

java.lang.IllegalArgumentException - if properties are not specified

getEntries

public JournalEntries getEntries(java.util.List properties,
                                 SortOrder order,
                                 RowRange range)
                          throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, SortOrder, RowRange)

Queries the server for a list of journal entries.

Parameters:

properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)

order - the order to sort by

range - the range of rows to return

Returns:

a list of JournalEntry objects

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

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

java.lang.IllegalArgumentException - if properties are not specified

getEntries

public JournalEntries getEntries(java.util.List properties,
                                 JournalEntryFilter filter,
                                 SortOrder order,
                                 RowRange range)
                          throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, JournalEntryFilter, SortOrder, RowRange)

Queries the server for a list of journal entries.

Parameters:

properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)

filter - the conditions to search by

order - the order to sort by

range - the range of rows to return

Returns:

a list of JournalEntry objects

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

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

java.lang.IllegalArgumentException - if properties are not specified

getEntries

public JournalEntries getEntries(java.util.List properties,
                                 int iScope,
                                 JournalEntryFilter filter,
                                 SortOrder order,
                                 RowRange range)
                          throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, int, JournalEntryFilter, SortOrder, RowRange)

Queries the server for a list of journal entries.

If no sort order is provided (order == null), the following sort order is used:

• MapiProperty.JOURNAL_ENTRY_TYPE, SortOrder.ASCENDING
• MapiProperty.JOURNAL_START_DATE, SortOrder.ASCENDING
• HttpMailProperty.NORMALIZED_SUBJECT, SortOrder.ASCENDING
• HttpMailProperty.DATE_RECEIVED, SortOrder.ASCENDING

DO NOT SORT BY HttpMailProperty.SUBJECT. This property is not searchable because its value is only calculated when used and not stored in the Exchange store. Use HttpMailProperty.NORMALIZED_SUBJECT or MailHeaderProperty.SUBJECT.

Parameters:

properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)

iScope - the scope of the search

filter - the conditions to search by

order - the order to sort by

range - the range of rows to return

Returns:

a list of JournalEntry objects

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

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

java.lang.IllegalArgumentException - if properties are not specified

getEntries

public JournalEntries getEntries(java.util.List props)
                          throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, SortOrder, RowRange)

Queries the server for a list of journal entries.

Parameters:

props - list of properies (see JournalEntry) to return from the query.

Returns:

a list of JournalEntry objects

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

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

java.lang.IllegalArgumentException - if properties are not specified

See Also:

JournalEntry.getDefaultProperties(), JournalEntry.getProperties()

getEntries

public JournalEntries getEntries(JournalEntryFilter filter)
                          throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, JournalEntryFilter, SortOrder, RowRange)

Queries the server for a list of journal entries.

Parameters:

filter - the conditions to filter by.

Returns:

a list of JournalEntry objects

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

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

See Also:

JournalEntry.getDefaultProperties(), JournalEntry.getProperties()

getEntries

public JournalEntries getEntries(java.util.List props,
                                 JournalEntryFilter filter)
                          throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetEntries(List, JournalEntryFilter, SortOrder, RowRange)

Queries the server for a list of journal entries.

Parameters:

props - list of properies (see JournalEntry) to return from the query.

filter - the conditions to filter by.

Returns:

a list of JournalEntry objects

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

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

java.lang.IllegalArgumentException - if properties are not specified

See Also:

JournalEntry.getDefaultProperties(), JournalEntry.getProperties()