Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.plumtree.remote.docfetch
Interface IDocFetch

public interface IDocFetch

An interface that allows the DocFetch servlet to retrieve the requested document and associated metadata.

Method Summary
`java.lang.String` | `getDocument()` Gets the file path to the document to be retrieved.
`DocumentMetaData` | `getMetaData(java.lang.String[] aFilter)` Gets the metadata information about the requested document.

Method Detail

### getMetaData

    public DocumentMetaData getMetaData(java.lang.String[] aFilter)
                                 throws ServiceException

  Gets the metadata information about the requested document.

  Parameters:
    `aFilter` - a list of metadata properties to return; if null, this method returns all available metadata properties
  Returns:
    a populated `DocumentMetaData` class
  Throws:
    `ServiceException`

### getDocument

    public java.lang.String getDocument()
                                 throws ServiceException

  Gets the file path to the document to be retrieved. The DocFetch servlet streams this file back to the requesting browser. If it is not desirable or possible to directly reference the requested file, create a temporary file on disk and return the path to that file.

  Returns:
    the path to the file to be returned
  Throws:
    `ServiceException`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

For additional information on the IDK, including tutorials, blogs, code samples and more,see the AquaLogic User Interaction Developer Center on BEA dev2dev.

Copyright ©2007 BEA Systems, Inc. All Rights Reserved.