ca.infoway.messagebuilder.xml.service
Interface MessageDefinitionService

All Known Implementing Classes:

BaseMessageDefinitionService, CompositeMessageDefinitionService

public interface MessageDefinitionService

A service for looking up defintions of components of a message.

Author:

Intelliware Development

Method Summary

List<Interaction>	getAllInteractions(boolean includeDuplicateInteractionsWithChangedBusinessNames) Get all interactions across all versions.
List<Interaction>	getAllInteractions(VersionNumber version) Get all interactions for a particular version of the specification.
Map<String,MessagePart>	getAllMessageParts(Interaction interaction, VersionNumber version) Get all the message parts for a particular interaction and version.
Map<String,MessagePart>	getAllRelatedMessageParts(MessagePart messagePart, VersionNumber version) Get all the message parts that a particular root message part references.
List<MessagePart>	getAllRootMessageParts() Get all the root message parts for all message sets.
List<MessagePart>	getAllRootMessageParts(VersionNumber version) Get all the root message parts for a specific message set.
Interaction	getInteraction(VersionNumber version, String type) Get an interaction by name and version.
MessagePart	getMessagePart(VersionNumber version, String type) Get a message part by name and version.
Set<String>	getSupportedVersions() Get all the versions known by this service.
Set<String>	getSupportedVersionsForInteraction(String type) Get all the versions for a particular interaction.

Method Detail

getMessagePart

MessagePart getMessagePart(VersionNumber version,
                           String type)

Get a message part by name and version.

Parameters:

version - - the version

type - - the type name

Returns:

the message part

getInteraction

Interaction getInteraction(VersionNumber version,
                           String type)

Get an interaction by name and version.

Parameters:

version - - the version

type - - the type name

Returns:

the interaction

getAllInteractions

List<Interaction> getAllInteractions(boolean includeDuplicateInteractionsWithChangedBusinessNames)

Get all interactions across all versions.

Parameters:

includeDuplicateInteractionsWithChangedBusinessNames - - a flag indicating whether or not to include duplicates

Returns:

the interactions

getAllInteractions

List<Interaction> getAllInteractions(VersionNumber version)

Get all interactions for a particular version of the specification.

Parameters:

version - - the version

Returns:

the interactions

getSupportedVersions

Set<String> getSupportedVersions()

Get all the versions known by this service.

Returns:

the versions

getSupportedVersionsForInteraction

Set<String> getSupportedVersionsForInteraction(String type)

Get all the versions for a particular interaction.

Parameters:

type - - the type name of the interaction

Returns:

the versions

getAllMessageParts

Map<String,MessagePart> getAllMessageParts(Interaction interaction,
                                           VersionNumber version)

Get all the message parts for a particular interaction and version.

Parameters:

interaction - - the interaction

version - - the version

Returns:

- the message parts

getAllRelatedMessageParts

Map<String,MessagePart> getAllRelatedMessageParts(MessagePart messagePart,
                                                  VersionNumber version)

Get all the message parts that a particular root message part references.

Parameters:

messagePart - - the messagePart

version - - the version

Returns:

- the message parts

getAllRootMessageParts

List<MessagePart> getAllRootMessageParts()

Get all the root message parts for all message sets.

Returns:

- the message parts

getAllRootMessageParts

List<MessagePart> getAllRootMessageParts(VersionNumber version)

Get all the root message parts for a specific message set.

Parameters:

version -

Returns:

- the message parts