com.compoze.exchange.webdav
Class NoteFolder

java.lang.Object

  |

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

        |

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

              |

              +--com.compoze.exchange.webdav.NoteFolder

All Implemented Interfaces:

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

public class NoteFolder

extends Folder

implements java.io.Serializable

This class extends Folder to represent a folder that primarily contains note items. This class provides access methods to retrieve collections of stick notes.

See Also:

Serialized Form

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

m_folders, m_iRelDepth, m_messages

Constructor Summary

NoteFolder(java.lang.String sName)
Constructor.

Method Summary

Notes	getNotes(java.util.List props) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetNotes(List, SortOrder, RowRange)
Notes	getNotes(java.util.List properties, int iScope, NoteFilter filter, SortOrder order, RowRange range) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetNotes(List, int, NoteFilter, SortOrder, RowRange)
Notes	getNotes(java.util.List props, NoteFilter filter) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetNotes(List, NoteFilter, SortOrder, RowRange)
Notes	getNotes(java.util.List properties, NoteFilter filter, SortOrder order, RowRange range) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetNotes(List, NoteFilter, SortOrder, RowRange)
Notes	getNotes(java.util.List properties, SortOrder order, RowRange range) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetNotes(List, SortOrder, RowRange)
Notes	getNotes(NoteFilter filter) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetNotes(List, NoteFilter, SortOrder, RowRange)
Notes	serverGetNotes(java.util.List properties, int iScope, NoteFilter filter, SortOrder order, RowRange range) Queries the server for a list of notes.
Notes	serverGetNotes(java.util.List properties, NoteFilter filter, SortOrder order, RowRange range) Queries the server for a list of notes.
Notes	serverGetNotes(java.util.List properties, SortOrder order, RowRange range) Queries the server for a list of notes.

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

NoteFolder

public NoteFolder(java.lang.String sName)

Constructor.

Parameters:

sName - the name of the folder.

Method Detail

serverGetNotes

public Notes serverGetNotes(java.util.List properties,
                            SortOrder order,
                            RowRange range)
                     throws ExchangeException

Queries the server for a list of notes.

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

serverGetNotes

public Notes serverGetNotes(java.util.List properties,
                            NoteFilter filter,
                            SortOrder order,
                            RowRange range)
                     throws ExchangeException

Queries the server for a list of notes.

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

serverGetNotes

public Notes serverGetNotes(java.util.List properties,
                            int iScope,
                            NoteFilter filter,
                            SortOrder order,
                            RowRange range)
                     throws ExchangeException

Queries the server for a list of notes.

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

• HttpMailProperty.DATE_RECEIVED, SortOrder.DESCENDING

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

getNotes

public Notes getNotes(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 serverGetNotes(List, SortOrder, RowRange)

Queries the server for a list of notes.

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

getNotes

public Notes getNotes(java.util.List properties,
                      NoteFilter filter,
                      SortOrder order,
                      RowRange range)
               throws ExchangeException

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

Queries the server for a list of notes.

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

getNotes

public Notes getNotes(java.util.List properties,
                      int iScope,
                      NoteFilter filter,
                      SortOrder order,
                      RowRange range)
               throws ExchangeException

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

Queries the server for a list of notes.

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

• HttpMailProperty.DATE_RECEIVED, SortOrder.DESCENDING

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

getNotes

public Notes getNotes(java.util.List props)
               throws ExchangeException

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

Queries the server for a list of notes.

Parameters:

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

Returns:

a list of Note 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:

Note.getDefaultProperties(), Note.getProperties()

getNotes

public Notes getNotes(NoteFilter filter)
               throws ExchangeException

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

Queries the server for a list of notes.

Parameters:

filter - the conditions to filter by.

Returns:

a list of Note 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

getNotes

public Notes getNotes(java.util.List props,
                      NoteFilter filter)
               throws ExchangeException

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

Queries the server for a list of notes.

Parameters:

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

filter - the conditions to filter by.

Returns:

a list of Note 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:

Note.getDefaultProperties(), Note.getProperties()