oracle.ifs.core.util

Class FolderUtilities

java.lang.Object

oracle.ifs.core.util.FolderUtilities

public class FolderUtilities
extends Object

A FolderUtilities is collection of utility methods used for working with folders.

Field Summary

Fields

Modifier and Type	Field and Description
static char[]	ILLEGAL_PATH_CHARACTERS The set of illegal path and foldered object name characters for iFS

Constructor Summary

Constructors

Constructor and Description
FolderUtilities()

Method Summary

Modifier and Type	Method and Description
static String	convertToLegalFolderedName(String name) Convert the specified name into a legal name for a foldered object.
static String	convertToLegalFolderedName(String name, char replChar) Convert the specified name into a legal name for a foldered object.
static PublicObject	findObjectByAbsolutePath(LibrarySession session, String path) Look up an object by the specified absolute path.
static boolean	folderLinksExist(LibrarySession session, String path) Returns true if the given absolute path contains any FolderLink objects.
static PropertyBundle	getFolderIndexPropertyBundle(LibrarySession sess) Gets the FolderIndex propertyBundle event target.
static boolean	isLegalFolderedObjectName(String name) Returns true if the given name is legal to use as the name for a foldered object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ILLEGAL_PATH_CHARACTERS

public static final char[] ILLEGAL_PATH_CHARACTERS

The set of illegal path and foldered object name characters for iFS

Constructor Detail

FolderUtilities

public FolderUtilities()

Method Detail

folderLinksExist

public static boolean folderLinksExist(LibrarySession session,
                                       String path)
                                throws IfsException

Returns true if the given absolute path contains any FolderLink objects.

Parameters:

session - the current session.

path - the absolute path to test.

Returns:

true if path contains any FolderLink objects.

Throws:

IfsException - if the operation fails.

isLegalFolderedObjectName

public static boolean isLegalFolderedObjectName(String name)

Returns true if the given name is legal to use as the name for a foldered object.

Parameters:

name - the object name to check.

Returns:

true if name is legal.

convertToLegalFolderedName

public static String convertToLegalFolderedName(String name)

Convert the specified name into a legal name for a foldered object.

Parameters:

name - the object name to check

Returns:

the modified name that is legal for a foldered object

convertToLegalFolderedName

public static String convertToLegalFolderedName(String name,
                                                char replChar)

Convert the specified name into a legal name for a foldered object.

Parameters:

name - the object name to check

replChar - the replacement character for bad chars

Returns:

the modified name that is legal for a foldered object

findObjectByAbsolutePath

public static PublicObject findObjectByAbsolutePath(LibrarySession session,
                                                    String path)
                                             throws IfsException

Look up an object by the specified absolute path.

Parameters:

session - LibrarySession context

path - the absolute object path; for example "/A/B/C/D.doc"

Returns:

the PublicObject, if found

Throws:

IfsException - if the operation fails.

getFolderIndexPropertyBundle

public static PropertyBundle getFolderIndexPropertyBundle(LibrarySession sess)
                                                   throws IfsException

Gets the FolderIndex propertyBundle event target.

Parameters:

sess - the session

Returns:

the FolderIndex propertyBundle

Throws:

IfsException - if operation fails