com.lexmark.saperion.client.archive

Interface ArchiveServiceClient

All Known Implementing Classes:

ArchiveServiceClientImpl

public interface ArchiveServiceClient

This client provides functionality concerning archives (DDCs).

Author:

jschwarz

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.

Method Detail

newArchiveSearch

SearchClient<ArchiveListItemType> newArchiveSearch()
                                            throws EcmException

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.

Returns:

a search client for the archives available in the system

Throws:

EcmException

resolve

ArchiveClient resolve(ArchiveReferenceType reference)
               throws EcmException

This method returns a client for the archive referenced.

Parameters:

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

Returns:

a client for the archive referenced

Throws:

EcmException

resolveName

ArchiveClient resolveName(String archiveName)
                   throws EcmException

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

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

SearchClient<DocumentRevisionListItemType> newDocumentSearch(ArchiveReferenceType reference)
                                                      throws EcmException

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

Parameters:

reference - a reference to the archive to search in.

Returns:

a search client for documents in the archive

Throws:

EcmException

newFolderSearch

SearchClient<FolderListItemType> newFolderSearch(ArchiveReferenceType reference)
                                          throws EcmException

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

Parameters:

reference - a reference to the archive to search in.

Returns:

a search client for folders in the archive

Throws:

EcmException

newLookupEntrySearch

SearchClient<LookupEntryListItemType> newLookupEntrySearch(ArchiveReferenceType reference)
                                                    throws EcmException

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.

Parameters:

reference - a reference to the archive to search in.

Returns:

a search client for lookup entries in the archive

Throws:

EcmException