wt.folder
Interface FolderServiceSvr

All Known Implementing Classes:

StandardFolderServiceSvr

public interface FolderServiceSvr

Foldering methods that are not intended for general client usage generally because they implement lower level functionality compared to methods on the FolderService, or don't enforce transactional integrity on their own.

Supported API: false

Extendable: false

Method Summary

QueryResult	findCabinetsReadOnly(AccessPermission permission, boolean shared_cabinets_only) Deprecated. Replaced by getContainerToCabinetsMapReadOnly(WTCollection,boolean,AccessPermission)
QueryResult	findCabinetsReadOnly(AccessPermission permission, boolean shared_cabinets_only, WTContainerRef container) Deprecated. Replaced by getContainerToCabinetsMapReadOnly(WTCollection,boolean,AccessPermission)
QueryResult	findCabinetsReadOnly(String permission, boolean shared_cabinets_only) Deprecated. Replaced by getContainerToCabinetsMapReadOnly(WTCollection,boolean,AccessPermission)
QueryResult	findSubFoldersReadOnly(Folder folder, AccessPermission permission) Deprecated. Replaced by getParentToSubFoldersMapReadOnly(WTCollection,AccessPermission)
QueryResult	findSubFoldersReadOnly(Folder folder, String permission) Deprecated. Replaced by getParentToSubFoldersMapReadOnly(WTCollection,AccessPermission)
Cabinet	getCabinetReadOnly(String name) Deprecated. Replaced by #getCabinetsByNameReadOnly(WTList,List,AccessPermission)
Cabinet	getCabinetReadOnly(String name, WTContainerRef container) Deprecated. Replaced by #getCabinetsByNameReadOnly(WTList,List,AccessPermission)
WTList	getCabinetsByNameReadOnly(WTList containers, List names) Get the cabinets that correspond to the given name/container pairs.
WTKeyedMap	getContainerToCabinetsMapReadOnly(WTCollection containers, boolean shared_only, AccessPermission permission) Get a mapping of the given containers to their accessible cabinets Supported API: false
Folder	getFolder(ObjectIdentifier folder_oid) Deprecated. Use the collection's based refresh and inflate APIs to get a folder from a folder oid
Folder	getFolderReadOnly(String path) Deprecated. Replaced by #getFoldersByPathReadOnly(WTList,List,AccessPermission)
Folder	getFolderReadOnly(String path, WTContainerRef container) Deprecated. Replaced by #getFoldersByPathReadOnly(WTList,List,AccessPermission)
WTList	getFoldersByPathReadOnly(WTList containers, List paths) Get the folders that correspond to the given path/container pairs.
Folder	getParentFolder(ObjectIdentifier child_oid) Deprecated. Replaced by getSubFolderToParentMapReadOnly(WTCollection,AccessPermission)
WTKeyedMap	getParentToSubFoldersMapReadOnly(WTCollection parents, AccessPermission permission) Get a mapping of parent folders to WTSets of their subfolders Supported API: false
WTValuedMap	getSubFolderToParentMapReadOnly(WTCollection subfolders, AccessPermission permission) Get the parent folders for the given collection of SubFolders Supported API: false
void	prepareForCheckin(WTValuedMap checkedout_to_working_copies) Cleans up the folder membership for working copies that will now asusme the folder membership of their corresponding checked out copy.
void	removeFromFolder(Foldered member, Folder folder) Deprecated. This API is unsafe ans should no longer be used
void	setCabinetChange(CabinetMember member, Cabinet cabinet) Within the context of a caller's transaction, change any foldering related information inside a CabinetMember object so that it will be part of the supplied Cabinet.
void	setFolderChange(Foldered member, Folder folder) Deprecated. This API is unsafe and should no longer be used

Method Detail

removeFromFolder

public void removeFromFolder(Foldered member,
                             Folder folder)
                      throws WTException,
                             FolderException

Deprecated. This API is unsafe ans should no longer be used

Within the context of a caller's transaction, remove a Foldered object from a folder. The FolderMembership association between the Foldered and the Folder is deleted from the database. It does NOT delete the Foldered object from the database. The caller is expected to ensure that the Foldered object still resides in a Folder and is not left dangling.

Supported API: false

Parameters:

member -

folder -

Throws:

WTException

FolderException

setFolderChange

public void setFolderChange(Foldered member,
                            Folder folder)
                     throws WTException,
                            FolderException

Deprecated. This API is unsafe and should no longer be used

Within the context of a caller's transaction, change any foldering related cookie information inside a Foldered object so that it will be part of the supplied Folder. No FolderMembership link manipulations are performed -- that is the responsibility of the caller. The caller is expected to ensure that the Foldered object is persisted in the database, this API will not persist the change.

Supported API: false

Parameters:

member -

folder -

Throws:

WTException

FolderException

setCabinetChange

public void setCabinetChange(CabinetMember member,
                             Cabinet cabinet)
                      throws WTException,
                             FolderException

Within the context of a caller's transaction, change any foldering related information inside a CabinetMember object so that it will be part of the supplied Cabinet. The caller is expected to ensure that the CabinetMember object is persisted in the database, this API will not persist the change.

Supported API: false

Parameters:

member -

cabinet -

Throws:

WTException

FolderException

getCabinetReadOnly

public Cabinet getCabinetReadOnly(String name)
                           throws WTException,
                                  FolderNotFoundException

Deprecated. Replaced by #getCabinetsByNameReadOnly(WTList,List,AccessPermission)

Returns a read only copy of the cabinet that has the specified name. NOTE: this cabinet comes directly from the folder cache and should not be modified.

Supported API: false

Parameters:

name -

Returns:

Cabinet

Throws:

WTException

FolderNotFoundException

getCabinetReadOnly

public Cabinet getCabinetReadOnly(String name,
                                  WTContainerRef container)
                           throws WTException,
                                  FolderNotFoundException

Deprecated. Replaced by #getCabinetsByNameReadOnly(WTList,List,AccessPermission)

Supported API: false

Parameters:

name -

container -

Returns:

Cabinet

Throws:

WTException

FolderNotFoundException

getFolderReadOnly

public Folder getFolderReadOnly(String path)
                         throws WTException,
                                FolderNotFoundException

Deprecated. Replaced by #getFoldersByPathReadOnly(WTList,List,AccessPermission)

Return the Folder object that has the specified path. NOTE: this folder comes directly from the folder cache and should not be modified

Supported API: false

Parameters:

path -

Returns:

Folder

Throws:

WTException

FolderNotFoundException

getFolderReadOnly

public Folder getFolderReadOnly(String path,
                                WTContainerRef container)
                         throws WTException,
                                FolderNotFoundException

Deprecated. Replaced by #getFoldersByPathReadOnly(WTList,List,AccessPermission)

Supported API: false

Parameters:

path -

container -

Returns:

Folder

Throws:

WTException

FolderNotFoundException

findCabinetsReadOnly

public QueryResult findCabinetsReadOnly(AccessPermission permission,
                                        boolean shared_cabinets_only)
                                 throws WTException

Deprecated. Replaced by getContainerToCabinetsMapReadOnly(WTCollection,boolean,AccessPermission)

Find all cabinets that the session user has the specified permission to access. NOTE: these cabinets come directly from the folder cache and should not be modified.

Supported API: false

Parameters:

permission -

shared_cabinets_only -

Returns:

QueryResult

Throws:

WTException

See Also:

Cabinet, AccessPermission

findCabinetsReadOnly

public QueryResult findCabinetsReadOnly(AccessPermission permission,
                                        boolean shared_cabinets_only,
                                        WTContainerRef container)
                                 throws WTException

Deprecated. Replaced by getContainerToCabinetsMapReadOnly(WTCollection,boolean,AccessPermission)

Supported API: false

Parameters:

permission -

shared_cabinets_only -

container -

Returns:

QueryResult

Throws:

WTException

findSubFoldersReadOnly

public QueryResult findSubFoldersReadOnly(Folder folder,
                                          AccessPermission permission)
                                   throws WTException

Deprecated. Replaced by getParentToSubFoldersMapReadOnly(WTCollection,AccessPermission)

Return all the SubFolders of this folder. NOTE: these folders come directly from the folder cache and should not be modified.

Supported API: false

Parameters:

folder -

permission -

Returns:

QueryResult

Throws:

WTException

See Also:

SubFolder

findCabinetsReadOnly

public QueryResult findCabinetsReadOnly(String permission,
                                        boolean shared_cabinets_only)
                                 throws WTException

Deprecated. Replaced by getContainerToCabinetsMapReadOnly(WTCollection,boolean,AccessPermission)

Find all cabinets that the session user has the specified permission to access. NOTE: these cabinets come directly from the folder cache and should not be modified.

Supported API: false

Parameters:

permission -

shared_cabinets_only -

Returns:

QueryResult

Throws:

WTException

See Also:

Cabinet, AccessPermission

findSubFoldersReadOnly

public QueryResult findSubFoldersReadOnly(Folder folder,
                                          String permission)
                                   throws WTException

Deprecated. Replaced by getParentToSubFoldersMapReadOnly(WTCollection,AccessPermission)

Return all the SubFolders of this folder. NOTE: these folders come directly from the folder cache and should not be modified.

Supported API: false

Parameters:

folder -

permission -

Returns:

QueryResult

Throws:

WTException

See Also:

SubFolder

getFolder

public Folder getFolder(ObjectIdentifier folder_oid)
                 throws WTException,
                        FolderNotFoundException

Deprecated. Use the collection's based refresh and inflate APIs to get a folder from a folder oid

Retrieves a Folder, given itsObjectIdentifier.

Supported API: false

Parameters:

folder_oid -

Returns:

Folder

Throws:

WTException

FolderNotFoundException

getParentFolder

public Folder getParentFolder(ObjectIdentifier child_oid)
                       throws WTException,
                              FolderNotFoundException

Deprecated. Replaced by getSubFolderToParentMapReadOnly(WTCollection,AccessPermission)

Given the ObjectIdentifier of a child Folder, return its parent Folder.

Supported API: false

Parameters:

child_oid -

Returns:

Folder

Throws:

WTException

FolderNotFoundException

prepareForCheckin

public void prepareForCheckin(WTValuedMap checkedout_to_working_copies)
                       throws WTException

Cleans up the folder membership for working copies that will now asusme the folder membership of their corresponding checked out copy. The working copies are modified but not persisted; ensuring the modifications are persisted is up to the caller.

Supported API: false

Parameters:

checkedout_to_working_copies - A mapping of checked out copies to their corresponding working copies

Throws:

WTException

getCabinetsByNameReadOnly

public WTList getCabinetsByNameReadOnly(WTList containers,
                                        List names)
                                 throws WTException

Get the cabinets that correspond to the given name/container pairs. This API needs to be list-based since neither the names nor the containers can provide a unique key for use in a map. The resulting cabinets are not filtered by access control

Supported API: false

Parameters:

containers - The containers within which the corresponding name should be looked for. This may either contain one container per name or a single container that is used with all names.

names - The cabinet names to find folders for

Returns:

A WTList of Cabinets corresponding to the order in the name/container list

Throws:

FolderNotFoundException - If any of the cabinets can't be found

WTException

getFoldersByPathReadOnly

public WTList getFoldersByPathReadOnly(WTList containers,
                                       List paths)
                                throws WTException

Get the folders that correspond to the given path/container pairs. This API needs to be list-based since neither the paths nor the containers can provide a unique key for use in a map. The resulting folders are not filtered by access control

Supported API: false

Parameters:

containers - The containers within which the corresponding path should be looked for. This may either contain one container per path or a single container that is used with all paths.

paths - The folder paths to find folders for

Returns:

A WTList of Folders corresponding to the order in the path/container list

Throws:

FolderNotFoundException - If any of the folders can't be found

WTException

getContainerToCabinetsMapReadOnly

public WTKeyedMap getContainerToCabinetsMapReadOnly(WTCollection containers,
                                                    boolean shared_only,
                                                    AccessPermission permission)
                                             throws WTException

Get a mapping of the given containers to their accessible cabinets

Supported API: false

Parameters:

containers - The containers to search in

shared_only - Whether or not to limit the result to shared cabinets

permission -

Returns:

A map of containers to WTSets of their cabinets

Throws:

WTException

getParentToSubFoldersMapReadOnly

public WTKeyedMap getParentToSubFoldersMapReadOnly(WTCollection parents,
                                                   AccessPermission permission)
                                            throws WTException

Get a mapping of parent folders to WTSets of their subfolders

Supported API: false

Parameters:

parents - The parent folders to search in

permission -

Returns:

A map of the parent folders to WTSets of their subfolders

Throws:

WTException

getSubFolderToParentMapReadOnly

public WTValuedMap getSubFolderToParentMapReadOnly(WTCollection subfolders,
                                                   AccessPermission permission)
                                            throws WTException

Get the parent folders for the given collection of SubFolders

Supported API: false

Parameters:

subfolders -

permission -

Returns:

A mapping of the subfolders to their parent folders

Throws:

FolderNotFoundException - If the current user doesn't have the required permission to any of the resulting folders

WTException