com.lexmark.saperion.client

Interface SaperionClient

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SaperionClientImpl

public interface SaperionClient
extends AutoCloseable

The saperion client provides a client interface for the saperion functionality. It serves as an etry point to create clients for different functionalities.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
void	close() This method closes the client.
ArchiveServiceClient	getArchiveService() This method returns a client to search for specific archives.
DocumentServiceClient	getDocumentService() This method returns a client offering document operations.
FolderServiceClient	getFolderService() This method returns a client offering folder operations.
LookupEntryServiceClient	getLookupEntryService() This method returns a client offering lookup entry functionality.
UserAdministrationClient	getUserAdministrationService() This method returns a client offering tenant, user and group management functionality.
WorkflowServiceClient	getWorkflowService() This method returns a client offering workflow functionality.

Method Detail

getWorkflowService

WorkflowServiceClient getWorkflowService()

This method returns a client offering workflow functionality.

Returns:

a workflow service client instance

getDocumentService

DocumentServiceClient getDocumentService()

This method returns a client offering document operations.

Returns:

a document service client instance

getFolderService

FolderServiceClient getFolderService()

This method returns a client offering folder operations.

Returns:

a folder service client instance

getArchiveService

ArchiveServiceClient getArchiveService()

This method returns a client to search for specific archives.

Returns:

an archive search client instance

getUserAdministrationService

UserAdministrationClient getUserAdministrationService()

This method returns a client offering tenant, user and group management functionality.

Returns:

a user management service client instance

getLookupEntryService

LookupEntryServiceClient getLookupEntryService()

This method returns a client offering lookup entry functionality.

Returns:

a lookup entry service client instance

close

void close()
    throws EcmException

This method closes the client. It logs out the user and removes the underlying session. The result of calls to any other method after close has been called is undefined.

Specified by:

close in interface AutoCloseable

Throws:

EcmException