wt.folder
Interface FolderService

All Known Implementing Classes:

FolderServiceFwd, StandardFolderService

public interface FolderService

Defines foldering related business operations.

All CabinetBased objects have a path made by constructing the path for their parent Folder with their name. All paths begin with the root character ('/') followed by a Cabinet name, followed by folder separator character ('/'), followed by the name of the Foldered object.

Supported API: true

Extendable: false

Field Summary

static char	FOLDER_ROOT Defines the root character for the start of a folder path.
static char	FOLDER_SEPARATOR Defines the separator character between entries in a folder path.

Method Summary

Shortcut	addShortcut(Folder folder, CabinetBased target) Add a shortcut to a Foldered object to the specified Folder.
WTCollection	assignLocation(WTCollection wtColl, Folder folder) Deprecated. replaced by FolderHelper.assignLocation(WTCollection,Folder)
WTValuedMap	assignLocations(WTValuedMap folderedItemToFolderMap) Deprecated. Replaced by FolderHelper.assignLocations(WTValuedMap)
Foldered	changeFolder(Foldered member, Folder newFolder) Deprecated. Replaced by changeFolder(WTValuedMap)
FolderEntry	changeFolder(FolderEntry entry, Folder new_folder) Move a FolderEntry from one folder to another.
WTSet	changeFolder(WTValuedMap targets_to_destinations) Move a set of FolderEntry objects to new folders as designated by their mappings in the WTValuedMap parameter.
Cabinet	createCabinet(String name, AdminDomainRef domain_ref, String description, WTContainerRef container_ref) The AdministrativeDomain and WTContainer must already exist.
Cabinet	createCabinet(String name, AdminDomainRef domain_ref, String description, WTPrincipal owner, boolean is_personal) Deprecated. Use createPersonalCabinet() to create a personal cabinet, and createCabinet(String, AdminDomainRef, String, WTContainerRef) to create a shared cabinet.
Cabinet	createCabinet(String name, AdministrativeDomain administrative_domain, String description, String owner) Deprecated. Use createPersonalCabinet() to create a personal cabinet, and createCabinet(String, AdminDomainRef, String, WTContainerRef) to create a shared cabinet.
Cabinet	createCabinet(String name, AdministrativeDomain administrative_domain, String description, WTPrincipal owner) Deprecated. Use createPersonalCabinet() to create a personal cabinet, and createCabinet(String, AdminDomainRef, String, WTContainerRef) to create a shared cabinet.
Cabinet	createCabinet(String name, String administrative_domain, String description, String owner) Deprecated. Use createPersonalCabinet() to create a personal cabinet, and createCabinet(String, AdminDomainRef, String, WTContainerRef) to create a shared cabinet.
Cabinet	createCabinet(String name, String domain_path, String description, String owner, boolean is_personal) Deprecated. Use createPersonalCabinet() to create a personal cabinet, and createCabinet(String, AdminDomainRef, String, WTContainerRef) to create a shared cabinet.
Cabinet	createPersonalCabinet(String name) Deprecated. Replaced by createPersonalCabinet(WTPrincipal)
Cabinet	createPersonalCabinet(String name, AdminDomainRef domain_ref, String description) Deprecated. Replaced by createPersonalCabinet(WTPrincipal, AdminDomainRef)
Cabinet	createPersonalCabinet(WTPrincipal principal) Create a cabinet in the User administrative domain for the specified Principal.
Cabinet	createPersonalCabinet(WTPrincipal principal, AdminDomainRef domain_ref) Create a cabinet in the specified domain for the specified Principal.
SubFolder	createSubFolder(String path) Create a SubFolder with the supplied path.
SubFolder	createSubFolder(String path, AdminDomainRef domainRef) Deprecated. Replaced by createSubFolder(String,AdminDomainRef,WTContainerRef)
SubFolder	createSubFolder(String path, AdminDomainRef domain_ref, WTContainerRef container_ref) The AdministrativeDomain and WTContainer must already exist.
SubFolder	createSubFolder(String path, WTContainerRef container_ref) The WTContainer must already exist.
QueryResult	findCabinets(AccessPermission permission, boolean shared_cabinets_only) Deprecated. Replaced by #getContainerToCabinetsMap(WTCollection)
QueryResult	findCabinets(AccessPermission permission, boolean shared_cabinets_only, WTContainerRef container) Deprecated. Replaced by #getContainerToCabinetsMap(WTCollection)
QueryResult	findCabinets(String permission) Deprecated. Replaced by #getContainerToCabinetsMap(WTCollection)
QueryResult	findCabinets(String permission, boolean shared_cabinets_only) Deprecated. Replaced by findCabinets(AccessPermission, boolean)
QueryResult	findFolderContents(Folder folder) Returns all instances of FolderEntry in the given Folder.
QueryResult	findFolderContents(Folder[] folders) Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)
QueryResult	findFolderContents(Folder[] folders, Class entry_class) Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)
QueryResult	findFolderContents(Folder[] folders, Class entry_class, boolean include_shared) Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)
QueryResult	findFolderContents(Folder folder, Class entry_class) Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)
QueryResult	findFolderContents(String path, WTContainerRef[] container_refs) Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)
QueryResult	findFolderContents(String path, WTContainerRef[] container_refs, Class entry_class) Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)
QueryResult	findShortcuts(CabinetBased target) Return all the Shortcuts to the specified object.
QueryResult	findSubFolders(Folder folder) finds all the SubFolders of the specified folder Supported API: true
QueryResult	findSubFolders(Folder folder, AccessPermission permission) Deprecated. Replaced by getParentToSubFoldersMap(WTCollection)
QueryResult	findSubFolders(Folder folder, String permission) Deprecated. Replaced by getParentToSubFoldersMap(WTCollection)
QueryResult	findSubFolders(String folder, AccessPermission permission) Deprecated. replaced by getParentToSubFoldersMap(WTCollection)
QueryResult	findSubFolders(String folder, AccessPermission permission, WTContainerRef container) Deprecated. Replaced by getParentToSubFoldersMap(WTCollection)
QueryResult	findSubFolders(String folder, String permission) Deprecated. Replaced by getParentToSubFoldersMap(WTCollection)
Cabinet	getCabinet(String name) Deprecated. Replaced by #getCabinetsByName(WTCollection containers)
Cabinet	getCabinet(String name, WTContainerRef container) Supported API: false
WTValuedMap	getCabinetBasedToCabinetMap(WTCollection objects) Get the cabinets for the given set of CabinetBased objects.
WTValuedMap	getCabinetBasedToFolderMap(WTCollection objects) Get the parent folders for the given collection of CabinetBased objects.
WTKeyedMap	getCabinetBasedToLocationMap(WTCollection objects) Get the locations for the given CabinetBased objects.
WTKeyedMap	getCabinetBasedToPathMap(WTCollection objects) Get the paths for the given CabinetBased objects.
Vector	getCabinetNames() Deprecated. Replaced by #getContainerToCabinetNamesMap(WTCollection)
Vector	getCabinetNames(WTContainerRef container) Deprecated. Replaced by #getContainerToCabinetNamesMap(WTCollection)
WTList	getCabinetsByName(WTList containers, List names) Get the cabinets that correspond to the given name/container pairs.
WTKeyedMap	getContainerToCabinetNamesMap(WTCollection containers, boolean shared_only) Get a mapping of the given containers to thei names of their accessible cabinets Supported API: false
WTKeyedMap	getContainerToCabinetsMap(WTCollection containers, boolean shared_only) Get a mapping of the given containers to their accessible cabinets Supported API: false
WTValuedMap	getEntryToMembershipMap(WTCollection entries) Get the FolderMemberships for the given FolderEntry objects.
Folder	getFolder(Foldered member) Deprecated. Replaced by getCabinetBasedToFolderMap(WTCollection)
Folder	getFolder(FolderEntry member) gets the Folder that the specified member belongs to Supported API: true
Folder	getFolder(String path) Deprecated. Replaced by getFoldersByPath(WTList, List)
Folder	getFolder(String path, WTContainerRef container) Supported API: true
WTValuedMap	getFolderedToFolderMap(WTCollection folderedColl) Deprecated. Replaced by getCabinetBasedToFolderMap(WTCollection)
FolderEntry	getFolderEntry(String path) Return a FolderEntry object for the given path.
FolderEntry	getFolderEntry(String path, WTContainerRef container) Supported API: false
String	getFolderPath(Cabinet cabinet) Deprecated. Replaced by getCabinetBasedToPathMap(WTCollection)
String	getFolderPath(FolderEntry entry) Deprecated. Replaced by getCabinetBasedToPathMap(WTCollection)
Object[]	getFolderPaths(CabinetBased[] objects) Deprecated. Replaced by getCabinetBasedToPathMap(WTCollection)
ArrayList	getFolderPathsFromFolderOids(ArrayList folderOids) Deprecated. Replaced by getCabinetBasedToPathMap(WTCollection)
HashMap	getFolders(List cabinetBasedObjects) Deprecated. Replaced by getCabinetBasedToFolderMap(WTCollection)
HashMap	getFoldersByPath(List folderPaths) Deprecated. Replaced by getFoldersByPath(WTList, List)
WTList	getFoldersByPath(WTList containers, List paths) Get the folders that correspond to the given path/container pairs.
WTKeyedMap	getFolderToContentsMap(WTSet folders, Class entry_class, boolean include_shared) Get the contents of the given set of folders.
String	getLocation(CabinetBased object) gets the location of the specified CabinetBased object as a String folder path Supported API: false
Object[]	getLocations(CabinetBased[] objects) Deprecated. Replaced by getCabinetBasedToLocationMap(WTCollection)
ArrayList	getMemberships(List members) Deprecated. Replaced by getEntryToMembershipMap(wt.fc.collections.WTCollection)
WTSet	getObjsInPersonalCabinets(WTCollection objsToCheck) Given an input WTCollection of CabinetBased objects, this routine returns the subset which reside in personal cabinets.
WTKeyedMap	getParentToSubFoldersMap(WTCollection parents) Get a mapping of parent folders to WTSets of their subfolders Supported API: false
Cabinet	getPersonalCabinet(WTPrincipal principal) Return the personal cabinet for the specified Principal.
WTValuedMap	getUserToCabinetMap(WTCollection users) Get the personal cabinets for the given users.
boolean	inPersonalCabinet(CabinetBased cabinetBased) Returns true if the entry resides in a personal cabinet, returns false if in an shared cabinet.
void	removeShortcut(Shortcut shortcut) Deprecated. Replaced by PersistenceManager.delete(Persistable)
Folder	saveFolderPath(String path, WTContainerRef container_ref) Ensures that every folder specified by the path argument exists in the given container.
Cabinet	updateCabinet(Cabinet cabinet, String name, AdminDomainRef domain_ref) Update a Cabinet, changing the identity to the specified name, and changing the administrative domain to the domain specified by domain_ref.
SubFolder	updateSubFolder(SubFolder folder, String name, AdminDomainRef domain_ref, boolean inherits) Update a SubFolder, changing the identity to the specified name, and changing the administrative domain to the domain specified by domain_ref.

Field Detail

FOLDER_SEPARATOR

public static final char FOLDER_SEPARATOR

Defines the separator character between entries in a folder path. The character is a '/'.

Supported API: false

See Also:

Constant Field Values

FOLDER_ROOT

public static final char FOLDER_ROOT

Defines the root character for the start of a folder path. The character is a '/'.

Supported API: false

See Also:

Constant Field Values

Method Detail

addShortcut

public Shortcut addShortcut(Folder folder,
                            CabinetBased target)
                     throws WTException

Add a shortcut to a Foldered object to the specified Folder.

Supported API: true

Parameters:

folder -

target -

Returns:

Shortcut

Throws:

WTException

changeFolder

public FolderEntry changeFolder(FolderEntry entry,
                                Folder new_folder)
                         throws WTException

Move a FolderEntry from one folder to another. The user must have modify permission to both the source and destination folders. In addition, if the FolderEntry has inheritedDomain=true, then the user must have create permission in the domain of the destination folder.

Supported API: true

Parameters:

entry -

new_folder -

Returns:

FolderEntry

Throws:

WTException

See Also:

changeFolder(WTValuedMap)

createCabinet

public Cabinet createCabinet(String name,
                             AdminDomainRef domain_ref,
                             String description,
                             WTContainerRef container_ref)
                      throws WTException

The AdministrativeDomain and WTContainer must already exist.

Supported API: false

Parameters:

name -

domain_ref -

description -

container_ref -

Returns:

Cabinet

Throws:

WTException

createCabinet

public Cabinet createCabinet(String name,
                             String domain_path,
                             String description,
                             String owner,
                             boolean is_personal)
                      throws WTException

Deprecated. Use createPersonalCabinet() to create a personal cabinet, and createCabinet(String, AdminDomainRef, String, WTContainerRef) to create a shared cabinet.

Supported API: false

Parameters:

name -

domain_path -

description -

owner -

is_personal -

Returns:

Cabinet

Throws:

WTException

See Also:

AdministrativeDomain, DomainAdministered, Ownable, WTPrincipal

createCabinet

public Cabinet createCabinet(String name,
                             AdminDomainRef domain_ref,
                             String description,
                             WTPrincipal owner,
                             boolean is_personal)
                      throws WTException

Deprecated. Use createPersonalCabinet() to create a personal cabinet, and createCabinet(String, AdminDomainRef, String, WTContainerRef) to create a shared cabinet.

Supported API: false

Parameters:

name -

domain_ref -

description -

owner -

is_personal -

Returns:

Cabinet

Throws:

WTException

See Also:

AdministrativeDomain, DomainAdministered, Ownable, WTPrincipal

createCabinet

public Cabinet createCabinet(String name,
                             String administrative_domain,
                             String description,
                             String owner)
                      throws WTException

Deprecated. Use createPersonalCabinet() to create a personal cabinet, and createCabinet(String, AdminDomainRef, String, WTContainerRef) to create a shared cabinet.

If the domain is the User domain, create a personal cabinet, otherwise create a shared cabinet. The administrative domain and owner must previously exist.

Supported API: false

Parameters:

name -

administrative_domain -

description -

owner -

Returns:

Cabinet

Throws:

WTException

See Also:

AdministrativeDomain, DomainAdministered, Ownable, WTPrincipal

createCabinet

public Cabinet createCabinet(String name,
                             AdministrativeDomain administrative_domain,
                             String description,
                             String owner)
                      throws WTException

Deprecated. Use createPersonalCabinet() to create a personal cabinet, and createCabinet(String, AdminDomainRef, String, WTContainerRef) to create a shared cabinet.

If the domain is the User domain, create a personal cabinet, otherwise create a shared cabinet. The administrative domain and owner must previously exist.

Supported API: false

Parameters:

name -

administrative_domain -

description -

owner -

Returns:

Cabinet

Throws:

WTException

See Also:

AdministrativeDomain, AdministrativeDomainHelper, DomainAdministered, Ownable, WTPrincipal

createCabinet

public Cabinet createCabinet(String name,
                             AdministrativeDomain administrative_domain,
                             String description,
                             WTPrincipal owner)
                      throws WTException

Deprecated. Use createPersonalCabinet() to create a personal cabinet, and createCabinet(String, AdminDomainRef, String, WTContainerRef) to create a shared cabinet.

If the domain is the User domain, create a personal cabinet, otherwise create a shared cabinet. The administrative domain and owner must previously exist.

Supported API: false

Parameters:

name -

administrative_domain -

description -

owner -

Returns:

Cabinet

Throws:

WTException

See Also:

AdministrativeDomain, DomainAdministered, Ownable, WTPrincipal

createPersonalCabinet

public Cabinet createPersonalCabinet(String name)
                              throws WTException

Deprecated. Replaced by createPersonalCabinet(WTPrincipal)

Create a cabinet in the User administrative domain for the specified Principal. The owner will be the principal. The Principal must already exist.

Supported API: false

Parameters:

name -

Returns:

Cabinet

Throws:

WTException

See Also:

WTUser

createPersonalCabinet

public Cabinet createPersonalCabinet(WTPrincipal principal)
                              throws WTException

Create a cabinet in the User administrative domain for the specified Principal. The owner will be the principal. The Principal must already exist.

Supported API: true

Parameters:

principal -

Returns:

Cabinet

Throws:

WTException

createSubFolder

public SubFolder createSubFolder(String path)
                          throws WTException

Create a SubFolder with the supplied path. The parent Folders must previously exist.

Supported API: true

Parameters:

path -

Returns:

SubFolder

Throws:

WTException

See Also:

SubFolder

findCabinets

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

Deprecated. Replaced by findCabinets(AccessPermission, boolean)

Find all Cabinets that the current user has the specified permission to access. Optionally can return only shared Cabinets, excluding personal Cabinets.

Supported API: false

Parameters:

permission - one of the permission constants defined in wt.access.WTPermission

shared_cabinets_only - if true only shared cabinets are returned, else if false all cabinets are returned

Returns:

QueryResult

Throws:

WTException

See Also:

Cabinet, AccessPermission

getCabinetNames

public Vector getCabinetNames()
                       throws WTException

Deprecated. Replaced by #getContainerToCabinetNamesMap(WTCollection)

gets the names of all Cabinets in the system to which the current user has read access

Supported API: true

Returns:

Vector a Vector of Cabinet names (Strings)

Throws:

WTException - if a low level error occurs

getCabinetNames

public Vector getCabinetNames(WTContainerRef container)
                       throws WTException

Deprecated. Replaced by #getContainerToCabinetNamesMap(WTCollection)

Supported API: false

Parameters:

container -

Returns:

Vector

Throws:

WTException

findFolderContents

public QueryResult findFolderContents(Folder folder)
                               throws WTException

Returns all instances of FolderEntry in the given Folder.

Supported API: true

Parameters:

folder -

Returns:

QueryResult

Throws:

WTException

See Also:

getFolderToContentsMap(wt.fc.collections.WTSet, java.lang.Class, boolean)

findFolderContents

public QueryResult findFolderContents(Folder folder,
                                      Class entry_class)
                               throws WTException

Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)

Returns all instances of entry_class in the given Folder.

Supported API: true

Parameters:

folder -

entry_class -

Returns:

QueryResult

Throws:

WTException

See Also:

findFolderContents(Folder[],Class)

findFolderContents

public QueryResult findFolderContents(Folder[] folders)
                               throws WTException

Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)

Returns all instances of FolderEntry in the given set of Folders.

Supported API: false

Parameters:

folders -

Returns:

QueryResult

Throws:

WTException

findFolderContents

public QueryResult findFolderContents(Folder[] folders,
                                      Class entry_class)
                               throws WTException

Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)

Returns all instances of entry_class in the given set of Folders. This includes:

• Objects that are members of the folder
• Objects that have shortcuts in the folder
• Objects that are shared into the folder, both by iteration and by version.

Supported API: false

Parameters:

folders -

entry_class -

Returns:

QueryResult

Throws:

WTException

See Also:

FolderEntry

findFolderContents

public QueryResult findFolderContents(Folder[] folders,
                                      Class entry_class,
                                      boolean include_shared)
                               throws WTException

Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)

Returns all instances of entry_class in the given set of Folders. This includes:

• Objects that are members of the folder
• Objects that have shortcuts in the folder
• If include_shared is true, objects that are shared into the folder, both by iteration and by version.

Supported API: false

Parameters:

folders -

entry_class -

include_shared -

Returns:

QueryResult

Throws:

WTException

See Also:

FolderEntry

findFolderContents

public QueryResult findFolderContents(String path,
                                      WTContainerRef[] container_refs)
                               throws WTException

Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)

Returns all instances of FolderEntry that are in folders of the given path within any of the given containers. If the given folder path does not exist in one of the containers, the container is skipped.

Supported API: false

Parameters:

path -

container_refs -

Returns:

QueryResult

Throws:

WTException

See Also:

findFolderContents(Folder[],Class)

findFolderContents

public QueryResult findFolderContents(String path,
                                      WTContainerRef[] container_refs,
                                      Class entry_class)
                               throws WTException

Deprecated. Replaced by #getFolderToContentsMap(WTSet,Class)

Returns all instances of entry_class that are in folders of the given path within any of the given containers. If the given folder path does not exist in one of the containers, the container is skipped.

Supported API: false

Parameters:

path -

container_refs -

entry_class -

Returns:

QueryResult

Throws:

WTException

See Also:

findFolderContents(Folder[],Class)

findShortcuts

public QueryResult findShortcuts(CabinetBased target)
                          throws WTException

Return all the Shortcuts to the specified object.

Supported API: true

Parameters:

target -

Returns:

QueryResult

Throws:

WTException

See Also:

Shortcut

findSubFolders

public QueryResult findSubFolders(Folder folder)
                           throws WTException

finds all the SubFolders of the specified folder

Supported API: true

Parameters:

folder - a Folder object

Returns:

QueryResult

Throws:

WTException - if a low level error occurs

See Also:

SubFolder, getParentToSubFoldersMap(wt.fc.collections.WTCollection)

findSubFolders

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

Deprecated. Replaced by getParentToSubFoldersMap(WTCollection)

finds all the SubFolders of the specified folder that the current user has the specified permission to access

Supported API: false

Parameters:

folder - a Folder object

permission - one of the permission constants defined in wt.access.WTPermission

Returns:

QueryResult

Throws:

WTException

See Also:

SubFolder, AccessPermission

findSubFolders

public QueryResult findSubFolders(String folder,
                                  String permission)
                           throws WTException,
                                  FolderNotFoundException

Deprecated. Replaced by getParentToSubFoldersMap(WTCollection)

finds all the SubFolders of the folder, specified as a path, that the current user has the specified permission to access

Supported API: false

Parameters:

folder - a Folder path, e.g. "/Design/Gagets"

permission - one of the permission constants defined in wt.access.WTPermission

Returns:

QueryResult

Throws:

FolderNotFoundException - if the specified folder doesn't exist

WTException - if a low level error occurs

See Also:

SubFolder, AccessPermission

getCabinet

public Cabinet getCabinet(String name)
                   throws WTException,
                          FolderNotFoundException

Deprecated. Replaced by #getCabinetsByName(WTCollection containers)

gets the Cabinet that has the specified name

Supported API: true

Parameters:

name - the name of a Cabinet

Returns:

Cabinet

Throws:

FolderNotFoundException - if there is no Cabinet with the specified name

WTException - if a low level error occurs

getCabinet

public Cabinet getCabinet(String name,
                          WTContainerRef container)
                   throws WTException

Supported API: false

Parameters:

name -

container -

Returns:

Cabinet

Throws:

WTException

See Also:

getCabinetsByName(wt.fc.collections.WTList, java.util.List)

getFolder

public Folder getFolder(FolderEntry member)
                 throws WTException

gets the Folder that the specified member belongs to

Supported API: true

Parameters:

member -

Returns:

null if the member has not been assigned to a Folder yet

Throws:

WTException - if a low level error occurs

See Also:

getCabinetBasedToFolderMap(wt.fc.collections.WTCollection)

getFolder

public Folder getFolder(String path)
                 throws WTException,
                        FolderNotFoundException

Deprecated. Replaced by getFoldersByPath(WTList, List)

gets the Folder object that has the specified path

Supported API: true

Parameters:

path - a Folder path, e.g. "/Design/Gagets"

Returns:

Folder

Throws:

FolderNotFoundException - if there is no Folder with the specified path

WTException - if a low level error occurs

getFolder

public Folder getFolder(String path,
                        WTContainerRef container)
                 throws WTException

Supported API: true

Parameters:

path -

container -

Returns:

Folder

Throws:

WTException

See Also:

getFoldersByPath(java.util.List)

getFolderEntry

public FolderEntry getFolderEntry(String path)
                           throws WTException

Return a FolderEntry object for the given path.

Supported API: true

Parameters:

path -

Returns:

FolderEntry

Throws:

WTException

getFolderEntry

public FolderEntry getFolderEntry(String path,
                                  WTContainerRef container)
                           throws WTException

Supported API: false

Parameters:

path -

container -

Returns:

FolderEntry

Throws:

WTException

getLocation

public String getLocation(CabinetBased object)
                   throws WTException

gets the location of the specified CabinetBased object as a String folder path

Supported API: false

Parameters:

object -

Returns:

null if the object has not been assigned to a Folder yet

Throws:

WTException - if a low level error occurs

See Also:

getCabinetBasedToLocationMap(wt.fc.collections.WTCollection)

getPersonalCabinet

public Cabinet getPersonalCabinet(WTPrincipal principal)
                           throws WTException,
                                  FolderNotFoundException

Return the personal cabinet for the specified Principal. If no principal is specified, the session principal is assumed.

Supported API: true

Parameters:

principal -

Returns:

Cabinet

Throws:

WTException

FolderNotFoundException

See Also:

#getUserToCabinetsMap

findCabinets

public QueryResult findCabinets(String permission)
                         throws WTException

Deprecated. Replaced by #getContainerToCabinetsMap(WTCollection)

Find all cabinets that the session user has the specified permission to access.

Supported API: false

Parameters:

permission -

Returns:

QueryResult

Throws:

WTException

See Also:

Cabinet, AccessPermission

changeFolder

public Foldered changeFolder(Foldered member,
                             Folder newFolder)
                      throws WTException

Deprecated. Replaced by changeFolder(WTValuedMap)

Change the folder that an object Foldered object resides in -- ie move it.

Supported API: false

Parameters:

member -

newFolder -

Returns:

Foldered

Throws:

WTException

getFolder

public Folder getFolder(Foldered member)
                 throws WTException

Deprecated. Replaced by getCabinetBasedToFolderMap(WTCollection)

Returns the Folder object that this object is a member of.

Supported API: true

Parameters:

member -

Returns:

Folder

Throws:

WTException

getFolderPath

public String getFolderPath(FolderEntry entry)
                     throws WTException

Deprecated. Replaced by getCabinetBasedToPathMap(WTCollection)

Calculate the path for the FolderEntry.

Supported API: false

Parameters:

entry -

Returns:

String

Throws:

WTException

getFolderPath

public String getFolderPath(Cabinet cabinet)
                     throws WTException

Deprecated. Replaced by getCabinetBasedToPathMap(WTCollection)

Return the path of the cabinet, ie '/' + cabinet name.

Supported API: false

Parameters:

cabinet -

Returns:

String

Throws:

WTException

removeShortcut

public void removeShortcut(Shortcut shortcut)
                    throws WTException

Deprecated. Replaced by PersistenceManager.delete(Persistable)

Remove a shortcut from a folder.

Supported API: false

Parameters:

shortcut -

Throws:

WTException

createSubFolder

public SubFolder createSubFolder(String path,
                                 AdminDomainRef domainRef)
                          throws WTException

Deprecated. Replaced by createSubFolder(String,AdminDomainRef,WTContainerRef)

Create a SubFolder with the supplied path, and administered in the domain specified by domainRef. The parent Folders and the AdministrativeDomain must previously exist. The SubFolder's inheritedDomain flag will be set to false.

Supported API: true

Parameters:

path -

domainRef -

Returns:

SubFolder

Throws:

WTException

See Also:

SubFolder

createSubFolder

public SubFolder createSubFolder(String path,
                                 AdminDomainRef domain_ref,
                                 WTContainerRef container_ref)
                          throws WTException

The AdministrativeDomain and WTContainer must already exist.

Supported API: false

Parameters:

path -

domain_ref -

container_ref -

Returns:

SubFolder

Throws:

WTException

createSubFolder

public SubFolder createSubFolder(String path,
                                 WTContainerRef container_ref)
                          throws WTException

The WTContainer must already exist.

Supported API: false

Parameters:

path -

container_ref -

Returns:

SubFolder

Throws:

WTException

createPersonalCabinet

public Cabinet createPersonalCabinet(WTPrincipal principal,
                                     AdminDomainRef domain_ref)
                              throws WTException

Create a cabinet in the specified domain for the specified Principal. The Cabinet's name will be set to the principal's name, and the principal will be its owner. The Principal and the AdministrativeDomain must already exist.

Supported API: true

Parameters:

principal -

domain_ref -

Returns:

Cabinet

Throws:

WTException

createPersonalCabinet

public Cabinet createPersonalCabinet(String name,
                                     AdminDomainRef domain_ref,
                                     String description)
                              throws WTException

Deprecated. Replaced by createPersonalCabinet(WTPrincipal, AdminDomainRef)

Create a personal cabinet for a principal specified by name, in the specified domain, with the specified description. The principal will be the cabinet's owner. The principal's name will be used as the cabinet name. The principal and the AdministrativeDomain must already exist.

Supported API: false

Parameters:

name -

domain_ref -

description -

Returns:

Cabinet

Throws:

WTException

updateCabinet

public Cabinet updateCabinet(Cabinet cabinet,
                             String name,
                             AdminDomainRef domain_ref)
                      throws WTException,
                             WTPropertyVetoException

Update a Cabinet, changing the identity to the specified name, and changing the administrative domain to the domain specified by domain_ref.

Supported API: false

Parameters:

cabinet -

name -

domain_ref -

Returns:

Cabinet

Throws:

WTException

WTPropertyVetoException

See Also:

Cabinet

updateSubFolder

public SubFolder updateSubFolder(SubFolder folder,
                                 String name,
                                 AdminDomainRef domain_ref,
                                 boolean inherits)
                          throws WTException,
                                 WTPropertyVetoException

Update a SubFolder, changing the identity to the specified name, and changing the administrative domain to the domain specified by domain_ref. Also set the domain inheritance as specified by the inherits parameter.

Supported API: false

Parameters:

folder -

name -

domain_ref -

inherits -

Returns:

SubFolder

Throws:

WTException

WTPropertyVetoException

See Also:

SubFolder

findSubFolders

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

Deprecated. Replaced by getParentToSubFoldersMap(WTCollection)

finds all the SubFolders of the specified folder that the current user has the specified permission to access

Supported API: true

Parameters:

folder - a Folder object

permission - one of the permission constants defined in wt.access.AccessPermission

Returns:

QueryResult

Throws:

WTException - if a low level error occurs

See Also:

SubFolder, AccessPermission

findSubFolders

public QueryResult findSubFolders(String folder,
                                  AccessPermission permission)
                           throws WTException,
                                  FolderNotFoundException

Deprecated. replaced by getParentToSubFoldersMap(WTCollection)

finds all the SubFolders of the folder, specified as a path, that the current user has the specified permission to access

Supported API: true

Parameters:

folder - a Folder path, e.g. "/Design/Gagets"

permission - one of the permission constants defined in wt.access.AccessPermission

Returns:

QueryResult

Throws:

FolderNotFoundException - if the specified folder doesn't exist

WTException - if a low level error occurs

See Also:

SubFolder, AccessPermission

findSubFolders

public QueryResult findSubFolders(String folder,
                                  AccessPermission permission,
                                  WTContainerRef container)
                           throws WTException

Deprecated. Replaced by getParentToSubFoldersMap(WTCollection)

Supported API: false

Parameters:

folder -

permission -

container -

Returns:

QueryResult

Throws:

WTException

findCabinets

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

Deprecated. Replaced by #getContainerToCabinetsMap(WTCollection)

Find all Cabinets that the current user has the specified permission to access. Optionally can return only shared Cabinets, excluding personal Cabinets.

Supported API: true

Parameters:

permission - one of the permission constants defined in wt.access.AccessPermission

shared_cabinets_only - if true only shared cabinets are returned, else if false all cabinets are returned

Returns:

QueryResult

Throws:

WTException - if a low level error occurs

See Also:

Cabinet, AccessPermission

findCabinets

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

Deprecated. Replaced by #getContainerToCabinetsMap(WTCollection)

Supported API: false

Parameters:

permission -

shared_cabinets_only -

container -

Returns:

QueryResult

Throws:

WTException

saveFolderPath

public Folder saveFolderPath(String path,
                             WTContainerRef container_ref)
                      throws WTException

Ensures that every folder specified by the path argument exists in the given container.

Supported API: false

Parameters:

path -

container_ref -

Returns:

Folder

Throws:

WTException

getFolderPaths

public Object[] getFolderPaths(CabinetBased[] objects)
                        throws WTException

Deprecated. Replaced by getCabinetBasedToPathMap(WTCollection)

This function returns the folder paths corresponding to an array of CabinetBased objects. The paths are returned as String's. In cases where the path cannot be determined (typically because the caller has no read permission for the folder or because it hasn't been set), an object of class Exception will be returned in the corresponding position of the array.

Supported API: true

Parameters:

objects -

Returns:

Object[]

Throws:

WTException

getLocations

public Object[] getLocations(CabinetBased[] objects)
                      throws WTException

Deprecated. Replaced by getCabinetBasedToLocationMap(WTCollection)

This function returns the folder locations corresponding to an array of CabinetBased objects. The locations are returned as String's. In cases where the location cannot be determined (typically because the caller has no read permission for the folder or because it hasn't been set), an object of class Exception will be returned in the corresponding position of the array. Implementation details: A local function, getMemberships(), is first called to retrieve all the object's FolderMembership's (if any). The associated Folders (if any) are attached to the FolderMembership's by this function, retrieving them from the Folder Cache wherever possible.

Supported API: true

Parameters:

objects -

Returns:

Object[]

Throws:

WTException

getFolderPathsFromFolderOids

public ArrayList getFolderPathsFromFolderOids(ArrayList folderOids)
                                       throws WTException

Deprecated. Replaced by getCabinetBasedToPathMap(WTCollection)

Returns an array of String's representing the folder paths of the objects. The parameter folderOids is a List of ObjectIdentifier's, which are assumed to represent Folder's. The folders are retrieved from the folder cache (where possible), and their folder paths are returned in the corresponding position of the returned ArayList. If the corresponding folder cannot be retrieved, or its path cannot be determined, the resulting exception is placed in the result array.

Supported API: false

Parameters:

folderOids -

Returns:

ArrayList

Throws:

WTException

getFoldersByPath

public HashMap getFoldersByPath(List folderPaths)
                         throws WTException

Deprecated. Replaced by getFoldersByPath(WTList, List)

Returns the Folders specified by a List of folder path String's; the Folders are returned in a java.util.HashMap, keyed by the path String's. The returned HashMap will contain all the Folder's which were successfully retrieved. For elements whose Folder could not be retrieved, the HashMap will contain the wt.util.WTException which resulted.

Supported API: true

Parameters:

folderPaths -

Returns:

HashMap

Throws:

WTException

getFolders

public HashMap getFolders(List cabinetBasedObjects)
                   throws WTException

Deprecated. Replaced by getCabinetBasedToFolderMap(WTCollection)

Returns the Folders for a set of CabinetBased objects. The objects are supplied by the caller in a java.util.List; their corresponding Folders are returned in a java.util.HashMap, keyed by the wt.fc.ObjectIdentifier's of the CabinetBased objects. The returned HashMap will contain all the Folder's which were successfully retrieved. For elements whose Folder could not be retrieved, the HashMap will contain the wt.util.WTException which resulted.

Supported API: true

Parameters:

cabinetBasedObjects -

Returns:

HashMap

Throws:

WTException

getMemberships

public ArrayList getMemberships(List members)
                         throws WTException

Deprecated. Replaced by getEntryToMembershipMap(wt.fc.collections.WTCollection)

Retrieves the FolderMembership's for a collection of FolderEntry's. The List may include a mixed collection of CabinetBased elements. the result ArrayList will contain the FolderMembership's corresponding to the CabinetBased elements, except for cases where some problem (i.e. Exception) occurred in attempting to retrieve the FolderMembership. In these cases, the Exception will be returned in the corresponding location of the result ArrayList.

Supported API: false

Parameters:

members - A List of CabinetBased objects

Returns:

ArrayList

Throws:

WTException

getFolderedToFolderMap

public WTValuedMap getFolderedToFolderMap(WTCollection folderedColl)
                                   throws WTException

Deprecated. Replaced by getCabinetBasedToFolderMap(WTCollection)

Given a WTCollection of Foldered objects, a WTValuedMap from these objects to their corresponding Folders is returned. If any non-Foldered objects are included in the input collection these do not cause an error and are simply not included in the output map (as they have no Folder). Any exception resulting from attempting to retrieve the Folder of a Foldered element of the input collection will cause an overall exception to be thrown.

This is a multi-object equivalent of getFolder().

Supported API: false

Parameters:

folderedColl - collection of Foldered objects

Returns:

WTValuedMap

Throws:

WTException

getObjsInPersonalCabinets

public WTSet getObjsInPersonalCabinets(WTCollection objsToCheck)
                                throws WTException

Given an input WTCollection of CabinetBased objects, this routine returns the subset which reside in personal cabinets. Note that if non-CabinetBased objects are included in the input collection they are simply automatically excluded from the output collection as they have no associated Cabinet.

This is a multi-object form of FolderHelper.inPersonalCabinet().

Supported API: true

Parameters:

objsToCheck - objects to determine which reside in a personal cabinet

Returns:

WTSet

Throws:

WTException

assignLocation

public WTCollection assignLocation(WTCollection wtColl,
                                   Folder folder)
                            throws WTException

Deprecated. replaced by FolderHelper.assignLocation(WTCollection,Folder)

Supported API: false

Parameters:

wtColl - collection of Foldered objects

folder - Folder to assign objects to

Returns:

WTCollection

Throws:

WTException

assignLocations

public WTValuedMap assignLocations(WTValuedMap folderedItemToFolderMap)
                            throws WTException

Deprecated. Replaced by FolderHelper.assignLocations(WTValuedMap)

Supported API: false

Parameters:

folderedItemToFolderMap - map from Foldered objects to Folders to which they are to be assigned

Returns:

WTValuedMap

Throws:

WTException

changeFolder

public WTSet changeFolder(WTValuedMap targets_to_destinations)
                   throws WTException

Move a set of FolderEntry objects to new folders as designated by their mappings in the WTValuedMap parameter. The user must have modify permission to the source and destination folders for each object. In addition, if any of the FolderEntrys have inheritedDomain=true, then the user must have create permission in the domain of the destination folder.

Supported API: true

Parameters:

targets_to_destinations -

Returns:

The set of FolderEntrys that were moved to new folders.

Throws:

WTException

getContainerToCabinetsMap

public WTKeyedMap getContainerToCabinetsMap(WTCollection containers,
                                            boolean shared_only)
                                     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

Returns:

A map of containers to WTSets of their cabinets

Throws:

WTException

getContainerToCabinetNamesMap

public WTKeyedMap getContainerToCabinetNamesMap(WTCollection containers,
                                                boolean shared_only)
                                         throws WTException

Get a mapping of the given containers to thei names of their accessible cabinets

Supported API: false

Parameters:

containers - The containers to search in

shared_only - Whether or not only shared cabinet names should be included

Returns:

A map of containers to Sets of their cabinet names

Throws:

WTException

getParentToSubFoldersMap

public WTKeyedMap getParentToSubFoldersMap(WTCollection parents)
                                    throws WTException

Get a mapping of parent folders to WTSets of their subfolders

Supported API: false

Parameters:

parents - The parent folders to search in

Returns:

A map of the parent folders to WTSets of their subfolders

Throws:

WTException

getCabinetBasedToCabinetMap

public WTValuedMap getCabinetBasedToCabinetMap(WTCollection objects)
                                        throws WTException

Get the cabinets for the given set of CabinetBased objects. If any of the objects are Cabinets themselves, then they are mapped to a reference to themselves.

Supported API: false

Parameters:

objects - The CabinetBased objects to find Cabinets for

Returns:

A mapping of the CabinetBased objects to their cabinets

Throws:

WTException - If the user doesn't have access to any of the objects' cabinets

WTException

getCabinetBasedToFolderMap

public WTValuedMap getCabinetBasedToFolderMap(WTCollection objects)
                                       throws WTException

Get the parent folders for the given collection of CabinetBased objects. If any of the objects are Cabinets, then they are mapped to null.

Supported API: false

Parameters:

objects - The CabinetBased objects to find folders for

Returns:

A mapping of the objects to their parent folders

Throws:

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

WTException

getEntryToMembershipMap

public WTValuedMap getEntryToMembershipMap(WTCollection entries)
                                    throws WTException

Get the FolderMemberships for the given FolderEntry objects. The folder roles on the resulting membership links are inflated. If the user doesn't have read access to the folder, then the membership is not returned.

Supported API: false

Parameters:

entries -

Returns:

A mapping of entries to their FolderMemberships

Throws:

WTException

getCabinetBasedToLocationMap

public WTKeyedMap getCabinetBasedToLocationMap(WTCollection objects)
                                        throws WTException

Get the locations for the given CabinetBased objects. The current user must have read access to all of their ancestor folders.

Supported API: false

Parameters:

objects - The CabinetBased objects to find locations for

Returns:

A mapping of CabinetBased objects to locations

Throws:

FolderNotFoundException - If the current user doesn't have read access to any of the objects'' ancestor folders

WTException

getCabinetBasedToPathMap

public WTKeyedMap getCabinetBasedToPathMap(WTCollection objects)
                                    throws WTException

Get the paths for the given CabinetBased objects. The path includes the folder location of the object along with its own name

Supported API: false

Parameters:

objects - The CabinetBased objects to find paths for

Returns:

A mapping of CabinetBased objects to paths

Throws:

FolderNotFoundException - If the current user doesn't have read access to any of the objects' ancestor folders

WTException

getCabinetsByName

public WTList getCabinetsByName(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

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, or if the current user doesn't have read access to any of the cabinets

WTException

getFoldersByPath

public WTList getFoldersByPath(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

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, or if the current user doesn't have read access to any of the requested folders -or- to any of their parent folders

WTException

getFolderToContentsMap

public WTKeyedMap getFolderToContentsMap(WTSet folders,
                                         Class entry_class,
                                         boolean include_shared)
                                  throws WTException

Get the contents of the given set of folders.

Supported API: false

Parameters:

folders - The folders to search in

entry_class - The class of FolderEntry to look for within the given folders

include_shared - Whether or not objects that are shared into the folders are included in the result

Returns:

A WTKeyedMap of parent folders to WTSets of their contents

Throws:

WTException

getUserToCabinetMap

public WTValuedMap getUserToCabinetMap(WTCollection users)
                                throws WTException

Get the personal cabinets for the given users.

Supported API: false

Parameters:

users -

Returns:

A map of the given users to their personal cabinets

Throws:

WTException

inPersonalCabinet

public boolean inPersonalCabinet(CabinetBased cabinetBased)
                          throws WTException

Returns true if the entry resides in a personal cabinet, returns false if in an shared cabinet. If the entry is a shortcut, the test is done on the cabinet of shortcut's parent folder.

Supported API: false

Parameters:

cabinetBased -

Returns:

boolean

Throws:

WTException