Package com.lexmark.saperion.client.implementation.folder

Class FolderDocumentSearchServiceClientImpl

java.lang.Object

com.lexmark.saperion.client.implementation.SearchClientImpl<com.lexmark.saperion.document.DocumentRevisionListItemType>

com.lexmark.saperion.client.implementation.folder.FolderDocumentSearchServiceClientImpl

All Implemented Interfaces:

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

public class FolderDocumentSearchServiceClientImpl
extends SearchClientImpl<com.lexmark.saperion.document.DocumentRevisionListItemType>
implements FolderDocumentSearchServiceClient

This is the default implementation of FolderDocumentSearchServiceClient.

Author:

jschwarz

Constructor Summary

Constructors

Constructor	Description
FolderDocumentSearchServiceClientImpl(com.lexmark.saperion.folder.FolderService folderService, com.lexmark.saperion.search.SearchExecutionService<com.lexmark.saperion.document.DocumentRevisionListItemType> searchService, com.lexmark.saperion.folder.FolderReferenceType reference)

Method Summary

Modifier and Type	Method	Description
void	addDocument(com.lexmark.saperion.document.DocumentReferenceType document)	This method files the document referenced into the current folder.
void	addDocuments(java.util.List<com.lexmark.saperion.document.DocumentReferenceType> documents)	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 document)	This method deletes the referenced document from the given folder.

Methods inherited from class com.lexmark.saperion.client.implementation.SearchClientImpl

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

FolderDocumentSearchServiceClientImpl

public FolderDocumentSearchServiceClientImpl(com.lexmark.saperion.folder.FolderService folderService,
                                             com.lexmark.saperion.search.SearchExecutionService<com.lexmark.saperion.document.DocumentRevisionListItemType> searchService,
                                             com.lexmark.saperion.folder.FolderReferenceType reference)

Method Detail

addDocuments

public void addDocuments(java.util.List<com.lexmark.saperion.document.DocumentReferenceType> documents)
                  throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: FolderDocumentSearchServiceClient

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.

Specified by:

addDocuments in interface FolderDocumentSearchServiceClient

Parameters:

documents - the document references

Throws:

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

removeDocument

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

Description copied from interface: FolderDocumentSearchServiceClient

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.

Specified by:

removeDocument in interface FolderDocumentSearchServiceClient

Parameters:

document - the document reference

Throws:

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

addDocument

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

Description copied from interface: FolderDocumentSearchServiceClient

This method files the document referenced into the current folder.

Specified by:

addDocument in interface FolderDocumentSearchServiceClient

Parameters:

document - 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

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

Description copied from interface: FolderDocumentSearchServiceClient

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.

Specified by:

moveDocument in interface FolderDocumentSearchServiceClient

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