com.lexmark.saperion.archive

Interface ArchiveService

All Superinterfaces:

SearchExecutionService<ArchiveListItemType>

public interface ArchiveService
extends SearchExecutionService<ArchiveListItemType>

This service provides functionality concerning archive definitions.

Author:

cmerkel

Method Summary

Modifier and Type	Method and Description
ArchiveType	getArchiveByName(String name) This method returns the unique archive with the given name.
ArchiveType	getDefinition(ArchiveReferenceType reference) Returns detailed information about the archive definition identified by the specified reference.
FieldDefinition	getField(ArchiveReferenceType definitionReference, String fieldName) Returns the field identified by the specified definition-reference and field-name.
List<FieldDefinition>	getFields(ArchiveReferenceType reference) Returns the fields of the archive definition identified by the specified reference.
SearchResultPage<ArchiveListItemType>	search(Statement statement, PageDefinition pageDefinition) Returns a list of basic information about all archive definitions in the system.

Method Detail

getArchiveByName

ArchiveType getArchiveByName(String name)
                      throws EcmException

This method returns the unique archive with the given name.

Parameters:

name - the name of the archive to return

Returns:

the unique archive with the given name

Throws:

EcmException

search

SearchResultPage<ArchiveListItemType> search(Statement statement,
                                             PageDefinition pageDefinition)
                                      throws EcmException

Returns a list of basic information about all archive definitions in the system. In multi-tenant systems only the definitions that are available for the current tenant are returned. The search may be filtered and paged.

Specified by:

search in interface SearchExecutionService<ArchiveListItemType>

Parameters:

statement - search expression

pageDefinition - result page offset and size

Returns:

a list of all archive definitions

Throws:

SystemException - system exception

SearchException - indicates any error during the search operation

EcmException

getDefinition

ArchiveType getDefinition(ArchiveReferenceType reference)
                   throws EcmException

Returns detailed information about the archive definition identified by the specified reference.

Parameters:

reference - the reference identifying the definition

Returns:

the definition identified by the reference

Throws:

SystemException - system exception

EcmException

getFields

List<FieldDefinition> getFields(ArchiveReferenceType reference)
                         throws EcmException

Returns the fields of the archive definition identified by the specified reference.

Parameters:

reference - the reference that identifies the archive definition

Returns:

a list of all fields of the definition

Throws:

SystemException - system exception

EcmException

getField

FieldDefinition getField(ArchiveReferenceType definitionReference,
                         String fieldName)
                  throws EcmException

Returns the field identified by the specified definition-reference and field-name.

Parameters:

definitionReference - the reference to the definition that contains the field

fieldName - the name of the field

Returns:

the field identified by the specified reference

Throws:

SystemException - system exception

EcmException