com.ibm.commerce.component.servicemapper

Interface ServiceMapper

All Known Implementing Classes:

ServiceMapperImpl

public interface ServiceMapper

A ServiceMapper converts a given set of properties into a service request. A converted service request is stored in MappingResult.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Method Summary

Modifier and Type	Method and Description
MappingResult	convert(java.lang.String name, java.util.Map properties) Converts the given properties to a service request.
ServiceMappingConfiguration	getMappingConfiguration()
void	setServiceMappingConfiguration(ServiceMappingConfiguration config) Sets the configuration used for mapping

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

setServiceMappingConfiguration

void setServiceMappingConfiguration(ServiceMappingConfiguration config)

Sets the configuration used for mapping

Parameters:

config - the configuration to be used.

getMappingConfiguration

ServiceMappingConfiguration getMappingConfiguration()

Returns:

the configuration used for mapping

convert

MappingResult convert(java.lang.String name,
                      java.util.Map properties)
               throws ServiceMappingException

Converts the given properties to a service request. Overwrite this method if you want to provide customized logic of convert a set of name-value pairs into a MappingResult object.

Parameters:

name - The name that can be used to identify the rules used for mapping

properties - the set of properties to be converted

Returns:

A MappingResult that stores the converted service request.

Throws:

ServiceMappingException - thrown when any fatal problems happened during conversion