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(ArchiveService archiveService, DocumentService documentService, FolderService folderService, LookupEntryService lookupEntryService)

Method Summary

Modifier and Type	Method and Description
SearchClient<ArchiveListItemType>	newArchiveSearch() This method returns a search client for the archives available in the system.
SearchClient<DocumentRevisionListItemType>	newDocumentSearch(ArchiveReferenceType reference) This method returns a search client for documents in the archive.
SearchClient<FolderListItemType>	newFolderSearch(ArchiveReferenceType reference) This method returns a search client for folders in the archive.
SearchClient<LookupEntryListItemType>	newLookupEntrySearch(ArchiveReferenceType reference) This method returns a search client for lookup entries in the archive.
ArchiveClient	resolve(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(ArchiveService archiveService,
                                DocumentService documentService,
                                FolderService folderService,
                                LookupEntryService lookupEntryService)

Method Detail

newArchiveSearch

public SearchClient<ArchiveListItemType> newArchiveSearch()
                                                   throws 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:

EcmException

resolve

public ArchiveClient resolve(ArchiveReferenceType reference)
                      throws 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:

EcmException

resolveName

public ArchiveClient resolveName(String archiveName)
                          throws 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:

EcmException

newDocumentSearch

public SearchClient<DocumentRevisionListItemType> newDocumentSearch(ArchiveReferenceType reference)
                                                             throws 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:

EcmException

newFolderSearch

public SearchClient<FolderListItemType> newFolderSearch(ArchiveReferenceType reference)
                                                 throws 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:

EcmException

newLookupEntrySearch

public SearchClient<LookupEntryListItemType> newLookupEntrySearch(ArchiveReferenceType reference)
                                                           throws 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:

EcmException