com.saperion.definition

Interface DefinitionService

All Known Implementing Classes:

RmiClientDefinitionService

public interface DefinitionService

This component is injectable to operations and provides functionality concerning archive definitions.

Author:

cmerkel

Method Summary

Methods

Modifier and Type	Method and Description
com.lexmark.saperion.archive.ArchiveType	getDefinition(com.lexmark.saperion.archive.ArchiveReferenceType reference) Returns detailed information about the archive definition identified by the specified reference.
List<com.lexmark.saperion.archive.ArchiveListItemType>	getDefinitions() Returns a list of basic information about all archive definitions in the system.
com.lexmark.saperion.archive.field.FieldDefinition	getField(com.lexmark.saperion.archive.ArchiveReferenceType definitionReference, String fieldName) Returns the field identified by the specified definition-reference and field-name.
List<com.lexmark.saperion.archive.field.FieldDefinition>	getFields(com.lexmark.saperion.archive.ArchiveReferenceType reference) Returns the fields of the archive definition identified by the specified reference.

Method Detail

getDefinitions

List<com.lexmark.saperion.archive.ArchiveListItemType> getDefinitions()
                                                                      throws SaAuthenticationException,
                                                                             SaSystemException

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.

Returns:

a list of all archive definitions

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception

getDefinition

com.lexmark.saperion.archive.ArchiveType getDefinition(com.lexmark.saperion.archive.ArchiveReferenceType reference)
                                                       throws SaAuthenticationException,
                                                              SaSystemException,
                                                              UnknownReferenceException

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:

SaAuthenticationException - authentication exception

SaSystemException - system exception

UnknownReferenceException - no definition was found for the specified reference

getFields

List<com.lexmark.saperion.archive.field.FieldDefinition> getFields(com.lexmark.saperion.archive.ArchiveReferenceType reference)
                                                                   throws SaAuthenticationException,
                                                                          SaSystemException,
                                                                          UnknownReferenceException

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:

SaAuthenticationException - authentication exception

SaSystemException - system exception

UnknownReferenceException - no definition was found for the specified reference

getField

com.lexmark.saperion.archive.field.FieldDefinition getField(com.lexmark.saperion.archive.ArchiveReferenceType definitionReference,
                                                          String fieldName)
                                                            throws SaAuthenticationException,
                                                                   SaSystemException,
                                                                   UnknownReferenceException

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:

SaAuthenticationException - authentication exception

SaSystemException - system exception

UnknownReferenceException - no field was found for the specified reference