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

Method Detail

newArchiveSearch

SearchClient<com.lexmark.saperion.archive.ArchiveListItemType> newArchiveSearch()
                                                                         throws com.lexmark.saperion.exceptions.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:

com.lexmark.saperion.exceptions.EcmException

resolve

ArchiveClient resolve(com.lexmark.saperion.archive.ArchiveReferenceType reference)
               throws com.lexmark.saperion.exceptions.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:

com.lexmark.saperion.exceptions.EcmException

resolveName

ArchiveClient resolveName(String archiveName)
                   throws com.lexmark.saperion.exceptions.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:

com.lexmark.saperion.exceptions.EcmException

newDocumentSearch

SearchClient<com.lexmark.saperion.document.DocumentRevisionListItemType> newDocumentSearch(com.lexmark.saperion.archive.ArchiveReferenceType reference)
                                                                                    throws com.lexmark.saperion.exceptions.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:

com.lexmark.saperion.exceptions.EcmException

newDocumentSearch

SearchClient<com.lexmark.saperion.document.DocumentRevisionListItemType> newDocumentSearch(com.lexmark.saperion.archive.ArchiveReferenceType reference,
                                                                                           boolean recycleBinAware,
                                                                                           boolean revisionAware)
                                                                                    throws com.lexmark.saperion.exceptions.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.

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

SearchClient<com.lexmark.saperion.folder.FolderListItemType> newFolderSearch(com.lexmark.saperion.archive.ArchiveReferenceType reference)
                                                                      throws com.lexmark.saperion.exceptions.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:

com.lexmark.saperion.exceptions.EcmException

newLookupEntrySearch

SearchClient<com.lexmark.saperion.lookup.LookupEntryListItemType> newLookupEntrySearch(com.lexmark.saperion.archive.ArchiveReferenceType reference)
                                                                                throws com.lexmark.saperion.exceptions.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:

com.lexmark.saperion.exceptions.EcmException