oracle.ifs.fdk
Interface FileManager

public interface FileManager

The file management interface.

Method Summary

boolean	checkNameValidity(long parentId, java.lang.String name) Checks to see if the proposed name is a valid object name in the target folder.
Item[]	copy(long[] items, NamedValue[] workflowParams, NamedValueSet[] attrs) Copies items.
Item	createDocument(NamedValue[] docDef, NamedValue[] workflowParams, AttributeRequest[] attributes) Creates a new Document.
Item	createDocumentDefinition(NamedValue[] def, AttributeRequest[] attributes) Creates a new DocumentDefinition, which can be used later to create an actual Document.
Item[]	createDocumentDefinitions(NamedValueSet[] def, AttributeRequest[] attributes) Creates set of new DocumentDefinitions, which can be used later to create actual Documents.
Item[]	createDocuments(NamedValueSet[] docDefs, NamedValue[] workflowParams, AttributeRequest[] attributes) Creates a set of new Documents.
Item	createFolder(long destFolderId, NamedValue[] attributes, AttributeRequest[] attrrequest) Creates a new folder.
Item[]	createFolders(long[] destFolders, NamedValueSet[] attributes, AttributeRequest[] attrrequest) Creates a set of folders.
Item[]	createLinks(long folderId, NamedValueSet[] linkDefs, AttributeRequest[] attributes) Creates a set of new Links.
void	delete(long[] items, NamedValue[] workflowParams, NamedValueSet[] attrs) Deletes items.
boolean	exists(java.lang.String absolutePath) Checks to see if an object exists at the given absolute path.
boolean	existsRelative(long folderId, java.lang.String relativePath) Checks to see if an object exists at the given relative path, relative to the given Folder.
boolean	folderLinksExist(java.lang.String path) Returns true if the given absolute path contains any LINK items.
Item[]	getMostRecentDocuments(NamedValue[] options, AttributeRequest[] attributes) Returns the most recent documents for the current user
NamedValueSet[]	getNameConflictResolutionOptions(long[] sourceItems, long[] conflictItems, NamedValueSet[] defs) Returns an array of valid and applicable name conflict resolution options for each {sourceItem, conflictItem, def} tuple passed to this method.
NamedValue[]	getSupportedCharsetNames() Returns a list of supported character sets.
java.lang.String[]	getSupportedCharsets() Returns the list of supported character sets
NamedValue[]	getSupportedLanguageNames() Returns a list of supported languages.
java.lang.String[]	getSupportedLanguages() Returns the list of supported languages
Item[]	listFolder(long folderId, NamedValue[] options, AttributeRequest[] attributes) Returns the items of a folder and returns the requested attributes that apply to each item.
Item[]	move(long[] items, NamedValue[] workflowParams, NamedValueSet[] attrs) Moves items.
Item	resolvePath(java.lang.String path, AttributeRequest[] attributes) Resolves a path, returning an Item that represents a PublicObject.
Item	resolveRelativePath(long folderId, java.lang.String path, AttributeRequest[] attributes) Resolves a relative path from a Folder, returning an Item that represents a PublicObject.
Item[]	uncompress(long[] items, AttributeRequest[] attributes) Uncompresses the items refered to by items.
Item	updateDocument(long docId, NamedValue[] docDef, AttributeRequest[] attributes) Updates a Document.
Item	updateFolder(long folderId, NamedValue[] attrs, AttributeRequest[] attributes) Updates a Folder.
Item	updateLink(long linkId, NamedValue[] attrs, AttributeRequest[] attributes) Updates a Link.

Method Detail

checkNameValidity

public boolean checkNameValidity(long parentId,
                                 java.lang.String name)
                          throws FdkException

Checks to see if the proposed name is a valid object name in the target folder.

This checks only for any invalid characters present in the proposed name.

Parameters:

name - The proposed name of the new object

parentId - The parent folder's ID.

Returns:

true if the name is valid

Throws:

FdkException - if the operation fails.

copy

public Item[] copy(long[] items,
                   NamedValue[] workflowParams,
                   NamedValueSet[] attrs)
            throws FdkException

Copies items. If workflow is enabled AND 'Copy' is workflow enabled, then one or more CopyRequests are created. Use RequestManager.listRequests to find any created requests.

Parameters:

items - The IDs of the items to be copied.

workflowParams - The parameters(name/value) used to start workflow

attrs - The attributes specified for each item.

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Options.DESTFOLDER, Long}
• {Options.OVERWRITE, Boolean}
• {Options.UNIQUENAME, Boolean}
• {Options.NEWVERSION, Boolean}
• {Options.RESPECT_NULL_RESOURCE_LOCKS, Boolean}
• {Options.REMOVE_NON_ALLOWED_CATEGORIES, NamedValue[]}
• {Options.CATEGORY_DEFINITION, NamedValue[]}
• {Options.RECORD_DEFINITION, NamedValue[]}

Returns:

If the operation is workflow enabled, null; otherwise the copied items.

Throws:

FdkException - if the operation fails.

createDocument

public Item createDocument(NamedValue[] docDef,
                           NamedValue[] workflowParams,
                           AttributeRequest[] attributes)
                    throws FdkException

Creates a new Document. If workflow is enabled AND 'CreateDocument' is workflow enabled, then one or more CreateDocumentRequests are created. Use RequestManager.listRequests to find any created requests.

Parameters:

workflowParams - The parameters(name/value) used to start workflow

attributes - requested attributes for each item, or null.

Returns:

If the operation is workflow enabled, null; otherwise the new document.

Throws:

FdkException - if the operation fails.

createDocumentDefinition

public Item createDocumentDefinition(NamedValue[] def,
                                     AttributeRequest[] attributes)
                              throws FdkException

Creates a new DocumentDefinition, which can be used later to create an actual Document.

Parameters:

def - the attributes to set.

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.DOCUMENT_CHARACTER_SET, String}
• {Attributes.DOCUMENT_LANGUAGE, String}
• {Options.CONTENTSTREAM, InputStream}

attributes - requested attributes for each item, or null.

Returns:

the new document definition.

Throws:

FdkException - if the operation fails.

createDocumentDefinitions

public Item[] createDocumentDefinitions(NamedValueSet[] def,
                                        AttributeRequest[] attributes)
                                 throws FdkException

Creates set of new DocumentDefinitions, which can be used later to create actual Documents. The bulk version of createDocumentDefinition.

Parameters:

attributes - requested attributes for each item, or null.

Returns:

the new document definitions.

Throws:

FdkException - if the operation fails.

createDocuments

public Item[] createDocuments(NamedValueSet[] docDefs,
                              NamedValue[] workflowParams,
                              AttributeRequest[] attributes)
                       throws FdkException

Creates a set of new Documents. If workflow is enabled AND 'CreateDocument' is workflow enabled, then one or more CreateDocumentRequests are created. Use RequestManager.listRequests to find any created requests.

Parameters:

docDefs - the attributes to set.

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.DOCUMENT_CHARACTER_SET, String}
• {Attributes.DOCUMENT_LANGUAGE, String}
• {Options.DESTFOLDER, Long}
• {Options.REMOVE_NON_ALLOWED_CATEGORIES, NamedValue[]}
• {Options.CATEGORY_DEFINITION, NamedValue[]}
• {Options.RECORD_DEFINITION, NamedValue[]}
• {Options.CONTENTSTREAM, InputStream}
• {Options.OVERWRITE, Boolean}
• {Options.UNIQUENAME, Boolean}
• {Options.NEWVERSION, Boolean}
• {Options.USE_SAVED_DEFINITION, Long}
• {Options.RESPECT_NULL_RESOURCE_LOCKS, Boolean}

workflowParams - The parameters(name/value) used to start workflow

attributes - requested attributes for each item, or null.

Returns:

If the operation is workflow enabled, null; otherwise the new documents.

Throws:

FdkException - if the operation fails.

createFolder

public Item createFolder(long destFolderId,
                         NamedValue[] attributes,
                         AttributeRequest[] attrrequest)
                  throws FdkException

Creates a new folder.

Parameters:

destFolderId - the destination folder ID.

attributes - the attributes to set on the new folder. must include one or more of the following Attributes:

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Options.RESPECT_NULL_RESOURCE_LOCKS, Boolean}

attrrequest - requested attributes for each item, or null.

Returns:

The folder that was created.

Throws:

FdkException - if the operation fails.

createFolders

public Item[] createFolders(long[] destFolders,
                            NamedValueSet[] attributes,
                            AttributeRequest[] attrrequest)
                     throws FdkException

Creates a set of folders. The destinationFolders parameter may have a size of 1 in which case all the folders will be created in that folder; otherwise its size must match the size of the folderNames parameter.

Parameters:

destFolders - the destination folder IDs.

attributes - the attributes to set for each new folder. must include one or more of the following Attributes:

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Options.RESPECT_NULL_RESOURCE_LOCKS, Boolean}

attrrequest - requested attributes for each item, or null.

Returns:

The list of the folders that were created.

Throws:

FdkException - if the operation fails.

createLinks

public Item[] createLinks(long folderId,
                          NamedValueSet[] linkDefs,
                          AttributeRequest[] attributes)
                   throws FdkException

Creates a set of new Links.

Parameters:

folderId - the id of the destination folder for the new links.

linkDefs - the attributes to set.

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.LINK_DESTINATION, Long}
• {Options.LINK_TO_LATEST, Boolean}
• {Options.USE_DEFAULT_NAME, Boolean}

attributes - requested attributes for each item, or null.

Returns:

the new document.

Throws:

FdkException - if the operation fails.

delete

public void delete(long[] items,
                   NamedValue[] workflowParams,
                   NamedValueSet[] attrs)
            throws FdkException

Deletes items.

Deleting a folder will trigger the deletion of all its items. If workflow is enabled AND 'Delete' is workflow enabled, then one or more DeleteRequests are created.

Otherwise, the function executes the delete operation and returns null. UI implementers should check the type of the Item returned and act accordingly (If it's a request, inform user the request needs to be approved before the delete can take place.).

Parameters:

items - the item IDs to be deleted.

workflowParams - The parameters(name/value) used to start workflow

attrs - The attributes specified for each item.

Throws:

FdkException - if the operation fails.

exists

public boolean exists(java.lang.String absolutePath)
               throws FdkException

Checks to see if an object exists at the given absolute path.

Parameters:

absolutePath - the absolute path to check.

Returns:

true if an object exists at the given path.

Throws:

FdkException - if the operation fails.

existsRelative

public boolean existsRelative(long folderId,
                              java.lang.String relativePath)
                       throws FdkException

Checks to see if an object exists at the given relative path, relative to the given Folder.

Parameters:

folderId - the Folder that the path is relative to.

relativePath - the relative path to check.

Returns:

true if an object exists at the given path, relative to the given Folder.

Throws:

FdkException - if the operation fails.

folderLinksExist

public boolean folderLinksExist(java.lang.String path)
                         throws FdkException

Returns true if the given absolute path contains any LINK items.

Parameters:

path - the absolute path to test.

Returns:

true if path contains any LINK items.

Throws:

FdkException - if the operation fails.

(Published)

getMostRecentDocuments

public Item[] getMostRecentDocuments(NamedValue[] options,
                                     AttributeRequest[] attributes)
                              throws FdkException

Returns the most recent documents for the current user

Parameters:

options - Options on the retrieved list. Valid options are:

• notation: {Attribute name, Attribute type}
• {Options.PRIMARY_SORT_ATTRIBUTE, String}
• {Options.PRIMARY_SORT_DIRECTION, Boolean}
• {Options.SECONDARY_SORT_ATTRIBUTE, String}
• {Options.SECONDARY_SORT_DIRECTION, Boolean}

If an attribute name is specified with no direction, ascending is the default. Attribute names must be valid attributes in Attributes.java and must return values that implement Comparable.

attributes - requested attributes for each item, or null.

Returns:

references to the most recently accessed documents.

Throws:

FdkException - if the operation fails.

getNameConflictResolutionOptions

public NamedValueSet[] getNameConflictResolutionOptions(long[] sourceItems,
                                                        long[] conflictItems,
                                                        NamedValueSet[] defs)
                                                 throws FdkException

Returns an array of valid and applicable name conflict resolution options for each {sourceItem, conflictItem, def} tuple passed to this method.

If an operation for the set of given objs would fail because of a name conflict, this method determines which options could be passed to a subsequent call to the operation that would allow it to succeed.

Parameters:

sourceItems - the items that are being operated on.

conflictItems - the name-conflicting items for each source item.

defs - the spec for the operation on the source items. (note that the DESTFOLDER option is required.)

Returns:

a NamedValueSet array of valid and applicable conflict resolution options (one array for each {sourceItem, conflictItem, def} tuple).

Throws:

FdkException - if the operation fails

getSupportedCharsetNames

public NamedValue[] getSupportedCharsetNames()
                                      throws FdkException

Returns a list of supported character sets. Each Namedvalue contains the {charset name, charset display name} tuple.

Returns:

all supported charsets.

Throws:

FdkException - if the operation fails.

getSupportedCharsets

public java.lang.String[] getSupportedCharsets()
                                        throws FdkException

Returns the list of supported character sets

Returns:

all supported character sets

Throws:

FdkException - if the operation fails.

getSupportedLanguageNames

public NamedValue[] getSupportedLanguageNames()
                                       throws FdkException

Returns a list of supported languages. Each Namedvalue contains the {language name, language display name} tuple.

Returns:

all supported languages.

Throws:

FdkException - if the operation fails.

getSupportedLanguages

public java.lang.String[] getSupportedLanguages()
                                         throws FdkException

Returns the list of supported languages

Returns:

all supported languages

Throws:

FdkException - if the operation fails.

listFolder

public Item[] listFolder(long folderId,
                         NamedValue[] options,
                         AttributeRequest[] attributes)
                  throws FdkException

Returns the items of a folder and returns the requested attributes that apply to each item.

Each Item in the returned Item array will be of one of the following types: Document, Link, Folder.

Parameters:

folderId - the ID of the folder to list.

options - Options on the retrieved list. Valid options are:

• notation: {Attribute name, Attribute type}
• {Options.PRIMARY_SORT_ATTRIBUTE, String}
• {Options.PRIMARY_SORT_DIRECTION, Boolean}
• {Options.SECONDARY_SORT_ATTRIBUTE, String}
• {Options.SECONDARY_SORT_DIRECTION, Boolean}

If an attribute name is specified with no direction, ascending is the default. Attribute names must be valid attributes in Attributes.java and must return values that implement Comparable.

attributes - requested attributes for each item, or null.

Returns:

an Item array representing the items in the folder and their attributes.

Throws:

FdkException - if the operation fails.

move

public Item[] move(long[] items,
                   NamedValue[] workflowParams,
                   NamedValueSet[] attrs)
            throws FdkException

Moves items. If the operation is workflow-enabled, then a request representing this move opereation is created. The return is an array of length one, as in: Item[] items = { <newly created request> }

Parameters:

items - The IDs of the items to be moved.

workflowParams - The parameters(name/value) used to start workflow

attrs - The attributes specified for each item.

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Options.DESTFOLDER, Long}
• {Options.OVERWRITE, Boolean}
• {Options.UNIQUENAME, Boolean}
• {Options.NEWVERSION, Boolean}
• {Options.REMOVE_NON_ALLOWED_CATEGORIES, NamedValue[]}
• {Options.CATEGORY_DEFINITION, NamedValue[]}
• {Options.RECORD_DEFINITION, NamedValue[]}
• {Options.RESPECT_NULL_RESOURCE_LOCKS, Boolean}

Returns:

The moved items.

Throws:

FdkException - if the operation fails.

resolvePath

public Item resolvePath(java.lang.String path,
                        AttributeRequest[] attributes)
                 throws FdkException

Resolves a path, returning an Item that represents a PublicObject.

The returned Item will be one of the following types: Document, Link, Folder.

Parameters:

path - the fully-qualified absolute path to resolve.

attributes - requested attributes for the resolved object, or null.

Returns:

an Item with the requested attributes, or null if no item matching the path is found.

Throws:

FdkException - if the operation fails

resolveRelativePath

public Item resolveRelativePath(long folderId,
                                java.lang.String path,
                                AttributeRequest[] attributes)
                         throws FdkException

Resolves a relative path from a Folder, returning an Item that represents a PublicObject.

The returned Item will be one of the following types: Document, Link, Folder.

Parameters:

folderId - the ID of the folder from which to resolve the path.

path - the relative path; it must not start with "/".

attributes - requested attributes for the resolved object, or null.

Returns:

an Item with the requested attributes.

Throws:

FdkException - if the operation fails.

uncompress

public Item[] uncompress(long[] items,
                         AttributeRequest[] attributes)
                  throws FdkException

Uncompresses the items refered to by items.

Parameters:

items - the item IDs to be uncompressed.

attributes - the attributes to be populated for items returned.

Returns:

An array of items which have been umcompressed.

Throws:

FdkException - if the operation fails.

updateDocument

public Item updateDocument(long docId,
                           NamedValue[] docDef,
                           AttributeRequest[] attributes)
                    throws FdkException

Updates a Document.

Parameters:

docId - the id of the document to update.

docDef - the attributes to update.

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.DOCUMENT_CHARACTER_SET, String}
• {Attributes.DOCUMENT_LANGUAGE, String}
• {Attributes.LAST_MODIFIED_DATE, Date}
• {Options.CONTENTSTREAM, InputStream}
• {Options.REMOVE_NON_ALLOWED_CATEGORIES, NamedValue[]}
• {Options.CATEGORY_DEFINITION, NamedValue[]}

attributes - requested attributes for each item, or null.

Returns:

the updated document.

Throws:

FdkException - if the operation fails.

updateFolder

public Item updateFolder(long folderId,
                         NamedValue[] attrs,
                         AttributeRequest[] attributes)
                  throws FdkException

Updates a Folder.

Parameters:

folderId - the id of the document to update.

attrs - the attributes to update.

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}

  attributes - requested attributes for each item, or null.

  Returns:

  the updated folder.

  Throws:

  FdkException - if the operation fails.

updateLink

public Item updateLink(long linkId,
                       NamedValue[] attrs,
                       AttributeRequest[] attributes)
                throws FdkException

Updates a Link.

Parameters:

linkId - the id of the Link to update.

attrs - the attributes to update.

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Options.LINK_TO_LATEST, Boolean}

attributes - requested attributes for each item, or null.

Returns:

the updated link.

Throws:

FdkException - if the operation fails.