oracle.epm.fm.domainobject.document

Class DocumentOM

java.lang.Object

oracle.epm.fm.domainobject.document.DocumentOM

All Implemented Interfaces:

Serializable

public class DocumentOM
extends Object
implements Serializable

DocumentOM - contains APIs related to document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentOM.IGenericDocument IGenericDocument Interface for document content.

Constructor Summary

Constructors

Constructor and Description
DocumentOM() Constructor of DocumentOM.
DocumentOM(SessionInfo sessionInfo) Constructor for DocumentOM.

Method Summary

Modifier and Type	Method and Description
void	createFolder(String path, String folderName, String description, String securityClass, boolean isPrivate, DOCUMENTTYPES contentType, boolean overwrite) Creates folder in the given path.
void	deleteDocuments(List<String> docNames, List<String> docPaths, List<DOCUMENTTYPES> docTypes, List<DOCUMENTFILETYPES> fileTypes) Deletes documents in the given path.
boolean	doesDocumentExist(String fileName, DOCUMENTTYPES docType, DOCUMENTFILETYPES docFileType) Method Check whether document is exist or not.
boolean	doesFolderExist(String folderName) check whether Folder exist or not.
String	downloadCustomDocumentContent(String sPath, String sFileName) Method helps to download Custom Document Content.
List<FMDocumentFileTypeDetail>	enumDocumentFileTypes(DOCUMENTTYPES docType) Gets the List of applicable document file types for the given enum document type.
List<FMDocumentFileTypeDetail>	enumDocumentFileTypes(DOCUMENTTYPES docType, DOCUMENTSUBTYPE docSubType) Gets the List of applicable document file types for the given enum document type.
List<FMDocument>	enumDocuments(String path, DOCUMENTTYPES docType, DOCUMENTFILETYPES fileType, ENUMSHOWPRIVATEDOCS showPrivateDocs) Gets the documents from the given path.
List<FMDocumentTypeDetail>	enumDocumentTypes(DOCUMENTSUBTYPE docSubType) Gets the List of applicable document types for the given enum document sub type.
List<FMDocumentTypeDetail>	enumDocumentTypesFromCache(DOCUMENTSUBTYPE docSubType) Get DocumentType from Cache.
byte[]	getDocumentContent(String sPath, String docName, DOCUMENTTYPES docType, DOCUMENTFILETYPES fileType) Gets the document content.
FMDocument	getDocumentInfo(String sPath, String docName, DOCUMENTTYPES docType, DOCUMENTFILETYPES fileType) Gets the document defination.
protected void	initialize() Service get initialized.
List<FMDocument>	parseTaskItems(String appName, byte[] taskItemsString) Get the tasks from the task list.
void	saveDocumentContent(FMDocument documentDetails, DocumentOM.IGenericDocument documentContent, boolean bOverwrite) Saves the documents.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentOM

public DocumentOM()

Constructor of DocumentOM.

DocumentOM

public DocumentOM(SessionInfo sessionInfo)
           throws HFMException

Constructor for DocumentOM.

Parameters:

sessionInfo - session information

Throws:

HFMException

Method Detail

initialize

protected void initialize()
                   throws HFMException

Service get initialized. enumDocumentTypes and enumDocumentFileTypes get initialized here.

Throws:

HFMException

enumDocuments

public List<FMDocument> enumDocuments(String path,
                                      DOCUMENTTYPES docType,
                                      DOCUMENTFILETYPES fileType,
                                      ENUMSHOWPRIVATEDOCS showPrivateDocs)
                               throws HFMException

Gets the documents from the given path.

Parameters:

path - - path to which documents to be retrieved

docType - - document type

fileType - - document file type

showPrivateDocs - - flag to retrieve private documents or not

Returns:

- documents form the given path

Throws:

HFMException - - Error retrieving documents

createFolder

public void createFolder(String path,
                         String folderName,
                         String description,
                         String securityClass,
                         boolean isPrivate,
                         DOCUMENTTYPES contentType,
                         boolean overwrite)
                  throws HFMException

Creates folder in the given path.

Parameters:

path - path

folderName - Folder name

description - Folder description

securityClass - Security class

isPrivate - Is a private folder

contentType - Content type of the folder (i.e. Webform, Grid, ...)

overwrite - Overwrite if exist

Throws:

HFMException - Error while creating folder

getDocumentContent

public byte[] getDocumentContent(String sPath,
                                 String docName,
                                 DOCUMENTTYPES docType,
                                 DOCUMENTFILETYPES fileType)
                          throws HFMException

Gets the document content.

Parameters:

sPath - - path to the document

docName - - document name

docType - - document type

fileType - - document file type

Returns:

- content for the given document

Throws:

HFMException - - Error reading document content

parseTaskItems

public List<FMDocument> parseTaskItems(String appName,
                                       byte[] taskItemsString)
                                throws HFMException

Get the tasks from the task list.

Parameters:

appName - application name

taskItemsString - document content for the tasklist

Returns:

list of FMDocument object for task list

Throws:

HFMException - Error reading document content

getDocumentInfo

public FMDocument getDocumentInfo(String sPath,
                                  String docName,
                                  DOCUMENTTYPES docType,
                                  DOCUMENTFILETYPES fileType)
                           throws HFMException

Gets the document defination.

Parameters:

sPath - - path to the document

docName - - document name

docType - - document type

fileType - - document file type

Returns:

- content for the given document

Throws:

HFMException - - Error reading document content

saveDocumentContent

public void saveDocumentContent(FMDocument documentDetails,
                                DocumentOM.IGenericDocument documentContent,
                                boolean bOverwrite)
                         throws HFMException

Saves the documents.

Parameters:

documentDetails - document details

documentContent - generic document content

bOverwrite - overwrite if exist

Throws:

HFMException - ERROR SAVING DOCUMENT

enumDocumentFileTypes

public List<FMDocumentFileTypeDetail> enumDocumentFileTypes(DOCUMENTTYPES docType)
                                                     throws HFMException

Gets the List of applicable document file types for the given enum document type.

Parameters:

docType - enum document type

Returns:

List document file type detail

Throws:

HFMException - ERROR_RETRIVING_DOCUMENTFILETYPES

deleteDocuments

public void deleteDocuments(List<String> docNames,
                            List<String> docPaths,
                            List<DOCUMENTTYPES> docTypes,
                            List<DOCUMENTFILETYPES> fileTypes)
                     throws HFMException

Deletes documents in the given path.

Parameters:

docNames - List of document names

docPaths - List of paths of the documents

docTypes - List of document types of the documents

fileTypes - List of document file types of the documents

Throws:

HFMException - Error while deleting folder

doesDocumentExist

public boolean doesDocumentExist(String fileName,
                                 DOCUMENTTYPES docType,
                                 DOCUMENTFILETYPES docFileType)
                          throws HFMException

Method Check whether document is exist or not.

Parameters:

fileName - file name

docType - Document Type

docFileType - Document File Type

Returns:

boolean value true if document is exist

Throws:

HFMException

doesFolderExist

public boolean doesFolderExist(String folderName)
                        throws HFMException

check whether Folder exist or not.

Parameters:

folderName - folder name

Returns:

boolean value true if document exist

Throws:

HFMException

enumDocumentTypesFromCache

public List<FMDocumentTypeDetail> enumDocumentTypesFromCache(DOCUMENTSUBTYPE docSubType)
                                                      throws HFMException

Get DocumentType from Cache.

Parameters:

docSubType - document sub type

Returns:

list of documentType detail

Throws:

HFMException

downloadCustomDocumentContent

public String downloadCustomDocumentContent(String sPath,
                                            String sFileName)
                                     throws HFMException

Method helps to download Custom Document Content.

Parameters:

sPath - documnet path

sFileName - document name

Returns:

File path

Throws:

HFMException

enumDocumentFileTypes

public List<FMDocumentFileTypeDetail> enumDocumentFileTypes(DOCUMENTTYPES docType,
                                                            DOCUMENTSUBTYPE docSubType)
                                                     throws HFMException

Gets the List of applicable document file types for the given enum document type.

Parameters:

docType - enum document type

docSubType - enum document file type

Returns:

List of document file type detail

Throws:

HFMException - ERROR_RETRIVING_DOCUMENTFILETYPES

enumDocumentTypes

public List<FMDocumentTypeDetail> enumDocumentTypes(DOCUMENTSUBTYPE docSubType)
                                             throws HFMException

Gets the List of applicable document types for the given enum document sub type.

Parameters:

docSubType - document sub type

Returns:

list of applicable document types for the given enum document sub type

Throws:

HFMException