com.lexmark.saperion.client.implementation.archive

Class ArchiveServiceClientImpl

java.lang.Object

com.lexmark.saperion.client.implementation.archive.ArchiveServiceClientImpl

All Implemented Interfaces:

ArchiveServiceClient

public class ArchiveServiceClientImpl
extends Object
implements ArchiveServiceClient

This is the default implementation of ArchiveServiceClient.

Author:

jschwarz

Constructor Summary

Constructors

Constructor and Description
ArchiveServiceClientImpl(com.lexmark.saperion.archive.ArchiveService archiveService, com.lexmark.saperion.document.DocumentService documentService, com.lexmark.saperion.folder.FolderService folderService, com.lexmark.saperion.lookup.LookupEntryService lookupEntryService)

Method Summary

Modifier and Type	Method and Description
SearchClient<com.lexmark.saperion.archive.ArchiveListItemType>	newArchiveSearch() This method returns a search client for the archives available in the system.
SearchClient<com.lexmark.saperion.document.DocumentRevisionListItemType>	newDocumentSearch(com.lexmark.saperion.archive.ArchiveReferenceType reference) This method returns a search client for documents in the archive.
SearchClient<com.lexmark.saperion.document.DocumentRevisionListItemType>	newDocumentSearch(com.lexmark.saperion.archive.ArchiveReferenceType reference, boolean recycleBinAware, boolean revisionAware) This method returns a search client for documents in the archive.
SearchClient<com.lexmark.saperion.folder.FolderListItemType>	newFolderSearch(com.lexmark.saperion.archive.ArchiveReferenceType reference) This method returns a search client for folders in the archive.
SearchClient<com.lexmark.saperion.lookup.LookupEntryListItemType>	newLookupEntrySearch(com.lexmark.saperion.archive.ArchiveReferenceType reference) This method returns a search client for lookup entries in the archive.
ArchiveClient	resolve(com.lexmark.saperion.archive.ArchiveReferenceType reference) This method returns a client for the archive referenced.
ArchiveClient	resolveName(String archiveName) This method returns a client for the archive with the given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveServiceClientImpl

public ArchiveServiceClientImpl(com.lexmark.saperion.archive.ArchiveService archiveService,
                                com.lexmark.saperion.document.DocumentService documentService,
                                com.lexmark.saperion.folder.FolderService folderService,
                                com.lexmark.saperion.lookup.LookupEntryService lookupEntryService)

Method Detail

newArchiveSearch

public SearchClient<com.lexmark.saperion.archive.ArchiveListItemType> newArchiveSearch()
                                                                                throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: ArchiveServiceClient

This method returns a search client for the archives available in the system. Note that only archives will be returned that can be accessed in the current tenant.

Specified by:

newArchiveSearch in interface ArchiveServiceClient

Returns:

a search client for the archives available in the system

Throws:

com.lexmark.saperion.exceptions.EcmException

resolve

public ArchiveClient resolve(com.lexmark.saperion.archive.ArchiveReferenceType reference)
                      throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: ArchiveServiceClient

This method returns a client for the archive referenced.

Specified by:

resolve in interface ArchiveServiceClient

Parameters:

reference - a reference to the archive to obtain a client for

Returns:

a client for the archive referenced

Throws:

com.lexmark.saperion.exceptions.EcmException

resolveName

public ArchiveClient resolveName(String archiveName)
                          throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: ArchiveServiceClient

This method returns a client for the archive with the given name.

Specified by:

resolveName in interface ArchiveServiceClient

Parameters:

archiveName - the name of the archive to obtain a client for

Returns:

a client for the archive with the given name

Throws:

com.lexmark.saperion.exceptions.EcmException

newDocumentSearch

public SearchClient<com.lexmark.saperion.document.DocumentRevisionListItemType> newDocumentSearch(com.lexmark.saperion.archive.ArchiveReferenceType reference)
                                                                                           throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: ArchiveServiceClient

This method returns a search client for documents in the archive. Note that it will fail when the archive is not a document archive.

Specified by:

newDocumentSearch in interface ArchiveServiceClient

Parameters:

reference - a reference to the archive to search in.

Returns:

a search client for documents in the archive

Throws:

com.lexmark.saperion.exceptions.EcmException

newDocumentSearch

public SearchClient<com.lexmark.saperion.document.DocumentRevisionListItemType> newDocumentSearch(com.lexmark.saperion.archive.ArchiveReferenceType reference,
                                                                                                  boolean recycleBinAware,
                                                                                                  boolean revisionAware)
                                                                                           throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: ArchiveServiceClient

This method returns a search client for documents in the archive. Note that it will fail when the archive is not a document archive.

Specified by:

newDocumentSearch in interface ArchiveServiceClient

Parameters:

reference - a reference to the archive to search in.

recycleBinAware - if set to true, will ignore the deleted documents (SYSINDEXSTATE=65002)

revisionAware - if set to true, will ignore the documents with SYSINDEXSTATE=55001

Returns:

a search client for documents in the archive

Throws:

com.lexmark.saperion.exceptions.EcmException

newFolderSearch

public SearchClient<com.lexmark.saperion.folder.FolderListItemType> newFolderSearch(com.lexmark.saperion.archive.ArchiveReferenceType reference)
                                                                             throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: ArchiveServiceClient

This method returns a search client for folders in the archive. Note that it will fail when the archive is not a folder archive.

Specified by:

newFolderSearch in interface ArchiveServiceClient

Parameters:

reference - a reference to the archive to search in.

Returns:

a search client for folders in the archive

Throws:

com.lexmark.saperion.exceptions.EcmException

newLookupEntrySearch

public SearchClient<com.lexmark.saperion.lookup.LookupEntryListItemType> newLookupEntrySearch(com.lexmark.saperion.archive.ArchiveReferenceType reference)
                                                                                       throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: ArchiveServiceClient

This method returns a search client for lookup entries in the archive. Note that it will fail when the archive is not a lookup entry archive.

Specified by:

newLookupEntrySearch in interface ArchiveServiceClient

Parameters:

reference - a reference to the archive to search in.

Returns:

a search client for lookup entries in the archive

Throws:

com.lexmark.saperion.exceptions.EcmException