com.saperion.connector.definition

Class RmiClientDefinitionService

java.lang.Object

com.saperion.connector.definition.RmiClientDefinitionService

All Implemented Interfaces:

DefinitionService

public class RmiClientDefinitionService
extends Object
implements DefinitionService

Client-side implementation of DefinitionService.

Author:

cmerkel

Constructor Summary

Constructors

Constructor and Description
RmiClientDefinitionService(Connection connection)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RmiClientDefinitionService

public RmiClientDefinitionService(Connection connection)

Method Detail

getDefinitions

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

Description copied from interface: DefinitionService

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.

Specified by:

getDefinitions in interface DefinitionService

Returns:

a list of all archive definitions

Throws:

SaAuthenticationException - authentication exception

SaSystemException - system exception

getDefinition

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

Description copied from interface: DefinitionService

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

Specified by:

getDefinition in interface DefinitionService

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

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

Description copied from interface: DefinitionService

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

Specified by:

getFields in interface DefinitionService

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

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

Description copied from interface: DefinitionService

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

Specified by:

getField in interface DefinitionService

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