|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.compoze.exchange.Folders
This class contains the methods used for folder manipulation.
Method Summary | |
void |
serverCopyFolders(java.lang.String[] srcFolderIDs,
java.lang.String sFolderID,
java.lang.String sNewName,
boolean bRecursive)
Hits the server to copy folders to another folder. |
Folder |
serverCreateFolder(java.lang.String sFolderID,
java.lang.String sName,
PropertyValue[] values,
PropertyKey[] keys)
Hits the server to add a folder. |
void |
serverDeleteFolders(java.lang.String[] folderIDs,
boolean bDeletedItems)
Hits the server to delete a folder. |
Folder |
serverGetFolder(DefaultFolderType type,
PropertyKey[] keys)
Queries the server to get the specified default folder type. |
Folder |
serverGetFolder(java.lang.String sFolderID,
PropertyKey[] keys)
Queries the server to get a single folder. |
PropertyValue[][] |
serverGetFolderProperties(java.lang.String[] folderIDs,
PropertyKey[] keys)
Queries the server to get properties from folders. |
Folder[] |
serverGetFolders(DefaultFolderType[] defaultFolderTypes,
PropertyKey[] keys,
int iDepth,
java.lang.String[] expandedFolderIDs,
FolderType[] folderTypes)
Queries the server to get sub-folders off of a folder. |
Folder[] |
serverGetFolders(DefaultFolderType defaultFolderType,
PropertyKey[] keys,
int iDepth,
java.lang.String[] expandedFolderIDs,
FolderType[] folderTypes)
Queries the server to get sub-folders off of a folder. |
Folder[] |
serverGetFolders(java.lang.String sFolderID,
PropertyKey[] keys,
int iDepth,
java.lang.String[] expandedFolderIDs,
FolderType[] folderTypes)
Queries the server to get subfolders off of a folder. |
void |
serverMoveFolders(java.lang.String[] srcFolderIDs,
java.lang.String sFolderID)
Hits the server to move folders to another folder. |
void |
serverUpdateFolders(java.lang.String[] folderIDs,
PropertyValue[] values)
Hits the server to update folders on the server. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public Folder serverGetFolder(java.lang.String sFolderID, PropertyKey[] keys) throws ExchangeException
sFolderID
- the folder ID (if null
then root
folder is retrieved)keys
- the properties to fetch for each folderpublic Folder[] serverGetFolders(DefaultFolderType defaultFolderType, PropertyKey[] keys, int iDepth, java.lang.String[] expandedFolderIDs, FolderType[] folderTypes) throws ExchangeException
defaultFolderType
- the default folder type (may not be null
)keys
- the properties to fetch for each folderiDepth
- the depth of folders to retrieve (0 for
only starting folder, N for depth of N, -1 for
infinite depth)expandedFolderIDs
- the IDs of folders below a depth of 1 which
are to be expandedfolderTypes
- the types of folders to retrievepublic Folder[] serverGetFolders(DefaultFolderType[] defaultFolderTypes, PropertyKey[] keys, int iDepth, java.lang.String[] expandedFolderIDs, FolderType[] folderTypes) throws ExchangeException
defaultFolderTypes
- the default folder types (may not be null
)keys
- the properties to fetch for each folderiDepth
- the depth of folders to retrieve (0 for
only starting folder, N for depth of N, -1 for
infinite depth)expandedFolderIDs
- the IDs of folders below a depth of 1 which
are to be expandedfolderTypes
- the types of folders to retrievepublic Folder[] serverGetFolders(java.lang.String sFolderID, PropertyKey[] keys, int iDepth, java.lang.String[] expandedFolderIDs, FolderType[] folderTypes) throws ExchangeException
sFolderID
- the folder ID (if null
then root
folders are retrieved)keys
- the properties to fetch for each folderiDepth
- the depth of folders to retrieve (0 for
only starting folder, N for depth of N, -1 for
infinite depth)expandedFolderIDs
- the IDs of folders below a depth of 1 which
are to be expandedfolderTypes
- the types of folders to retrievepublic Folder serverCreateFolder(java.lang.String sFolderID, java.lang.String sName, PropertyValue[] values, PropertyKey[] keys) throws ExchangeException
sFolderID
- the ID of the parent foldersName
- the name of the new foldervalues
- any initial property values to setkeys
- the properties to bring back from the new folderkeys
public void serverDeleteFolders(java.lang.String[] folderIDs, boolean bDeletedItems) throws ExchangeException
folderIDs
- the IDs of the folders to deletebDeletedItems
- if true
, place folder into deleted itemspublic void serverCopyFolders(java.lang.String[] srcFolderIDs, java.lang.String sFolderID, java.lang.String sNewName, boolean bRecursive) throws ExchangeException
srcFolderIDs
- the ID of the source folderssFolderID
- the ID of the target foldersNewName
- the name for the new folder (or null
to keep the same namebRecursive
- if true
, also copy subfolderspublic void serverMoveFolders(java.lang.String[] srcFolderIDs, java.lang.String sFolderID) throws ExchangeException
srcFolderIDs
- the ID of the source folderssFolderID
- the ID of the target folderpublic void serverUpdateFolders(java.lang.String[] folderIDs, PropertyValue[] values) throws ExchangeException
folderIDs
- the IDs of the folder to updatevalues
- the values to update on the serverpublic PropertyValue[][] serverGetFolderProperties(java.lang.String[] folderIDs, PropertyKey[] keys) throws ExchangeException
folderIDs
- the folder IDs to get the properties forkeys
- keys for the properties to getpublic Folder serverGetFolder(DefaultFolderType type, PropertyKey[] keys) throws ExchangeException
type
- the default folder type to getkeys
- keys for the properties to getnull
if not available
|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |