com.lexmark.saperion.client.folder

Interface FolderDocumentSearchServiceClient

All Superinterfaces:

SearchClient<com.lexmark.saperion.document.DocumentRevisionListItemType>, com.lexmark.saperion.search.SearchExecutionService<com.lexmark.saperion.document.DocumentRevisionListItemType>

All Known Implementing Classes:

FolderDocumentSearchServiceClientImpl

public interface FolderDocumentSearchServiceClient
extends SearchClient<com.lexmark.saperion.document.DocumentRevisionListItemType>

This search client searches documents in a given folder. Additionally it is able to add and remove documents from it.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
void	addDocument(com.lexmark.saperion.document.DocumentReferenceType reference) This method files the document referenced into the current folder.
void	addDocuments(List<com.lexmark.saperion.document.DocumentReferenceType> references) This method adds the given documents to the current folder.
void	moveDocument(com.lexmark.saperion.document.DocumentReferenceType document, com.lexmark.saperion.folder.FolderReferenceType destination) This method moves the document from the source folder to the target folder.
void	removeDocument(com.lexmark.saperion.document.DocumentReferenceType reference) This method deletes the referenced document from the given folder.

Methods inherited from interface com.lexmark.saperion.client.SearchClient

exists, list, list, list, list, list, list, list, page, page, uniqueResult

Methods inherited from interface com.lexmark.saperion.search.SearchExecutionService

search

Method Detail

addDocuments

void addDocuments(List<com.lexmark.saperion.document.DocumentReferenceType> references)
           throws com.lexmark.saperion.exceptions.EcmException

This method adds the given documents to the current folder. The documents will still be located in their archive, but listing the documents of the given folder will return the given documents. A document may be added to several folders.

Parameters:

references - the document references

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates any system error during the operation

removeDocument

void removeDocument(com.lexmark.saperion.document.DocumentReferenceType reference)
             throws com.lexmark.saperion.exceptions.EcmException

This method deletes the referenced document from the given folder. The document itself will not be deleted. It will still be accessible by searching the archive it is located in.

Parameters:

reference - the document reference

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates any system error during the operation

addDocument

void addDocument(com.lexmark.saperion.document.DocumentReferenceType reference)
          throws com.lexmark.saperion.exceptions.EcmException

This method files the document referenced into the current folder.

Parameters:

reference - a reference to the document to add to the folder

Throws:

com.lexmark.saperion.exceptions.system.SystemException - any system error that occurred during the filing process

com.lexmark.saperion.exceptions.EcmException

moveDocument

void moveDocument(com.lexmark.saperion.document.DocumentReferenceType document,
                  com.lexmark.saperion.folder.FolderReferenceType destination)
           throws com.lexmark.saperion.exceptions.EcmException

This method moves the document from the source folder to the target folder. Both source and destination folder have to exist in the same folder ddc.

Parameters:

document - a reference to the document to move from the source folder

destination - a reference to the target folder in which the document will be moved

Throws:

com.lexmark.saperion.exceptions.EcmException