com.axemble.vdoc.sdk.interfaces

Interface IMappingStructure

All Known Subinterfaces:

IParameterizedMappingStructure

All Known Implementing Classes:

MappingStructure, ParameterizedMappingStructure

public interface IMappingStructure

This class allows to map an external object to a vdoc object (MappingStructure)

Author:

ploureiro

Method Summary

Modifier and Type	Method and Description
List<IMappingStructure>	getChildValues() Retrieves childs mappingStructure for a composite mappingStructure.
String	getDataType() Retrieves the data type of the mappingStructure.
String	getDescription() Retrieves the description of the mappingStructure.
String	getLabel() Retrieves the label of the mappingStructure.
List<IOptionList.IOption>	getListOptions() Retrieves options displayed on the selection "value of list" in the mapping component.
int	getMappingType() Retrieves the mapping type of the mappingStructure.
String	getName() Retrives the name of mappingStructure.
List<IMappingStructure>	getValues() Retrieves childs mappingStructure for a composite mappingStructure.
boolean	isMandatory() Get if the value of mappingStructure is mandatory.
boolean	isVisible() Get if mappingStructure is default visible in the mapping component
void	setChildValues(List<IMappingStructure> childValues) Sets childs mappingStructure for a composite mappingStructure.
void	setDataType(String dataType) Sets the data type of the mappingStructure.
void	setDescription(String description) Sets a description to a mappingStructure.
void	setLabel(String label) Sets a label to a mappingStructure.
void	setListOptions(List<IOptionList.IOption> options) Sets options displayed on the selection "value of list" in the mapping component.
void	setMandatory(boolean isMandatory) Set if the value of mappingStructure is mandatory
void	setMappingType(int mappingType) Sets the mapping type of the mappingStructure.
void	setName(String name) Sets a name to the mappingStructure.
void	setVisible(boolean isVisible) Set if mappingStructure is visible

Method Detail

getName

String getName()

Retrives the name of mappingStructure.

Returns:

A java.lang.String value with mappingStructure name.

setName

void setName(String name)

Sets a name to the mappingStructure.

Parameters:

name - The name of the mappingStructure.

getLabel

String getLabel()

Retrieves the label of the mappingStructure.

Returns:

A java.lang.String value with object label.

setLabel

void setLabel(String label)

Sets a label to a mappingStructure.

Parameters:

label - The label of the mappingStructure.

getDescription

String getDescription()

Retrieves the description of the mappingStructure.

Returns:

A java.lang.String value with object description.

setDescription

void setDescription(String description)

Sets a description to a mappingStructure.

Parameters:

description - The description of the mappingStructure.

getDataType

String getDataType()

Retrieves the data type of the mappingStructure.

Returns:

A IMappingProvider.DataType value with data type of the mappingStructure.

setDataType

void setDataType(String dataType)

Sets the data type of the mappingStructure.

Parameters:

dataType - A value of the IMappingProvider.DataType.

getChildValues

List<IMappingStructure> getChildValues()

Retrieves childs mappingStructure for a composite mappingStructure.

Returns:

A java.util.List of IMappingStructure object

setChildValues

void setChildValues(List<IMappingStructure> childValues)

Sets childs mappingStructure for a composite mappingStructure.

Parameters:

childValues - A java.util.List of IMappingStructure object

isMandatory

boolean isMandatory()

Get if the value of mappingStructure is mandatory.

Returns:

isMandatory

setMandatory

void setMandatory(boolean isMandatory)

Set if the value of mappingStructure is mandatory

Parameters:

isMandatory -

isVisible

boolean isVisible()

Get if mappingStructure is default visible in the mapping component

Returns:

isVisible

setVisible

void setVisible(boolean isVisible)

Set if mappingStructure is visible

Parameters:

isVisible -

getMappingType

int getMappingType()

Retrieves the mapping type of the mappingStructure.

Returns:

A IMappingProvider.IMappingType value with data type of the mappingStructure.

setMappingType

void setMappingType(int mappingType)

Sets the mapping type of the mappingStructure.

Parameters:

mappingType - A value of the IMappingProvider.IMappingType.

getValues

List<IMappingStructure> getValues()

Retrieves childs mappingStructure for a composite mappingStructure.

Returns:

A java.util.List of IMappingStructure object

getListOptions

List<IOptionList.IOption> getListOptions()

Retrieves options displayed on the selection "value of list" in the mapping component.

Returns:

A java.util.List of IOptionList.IOption object

setListOptions

void setListOptions(List<IOptionList.IOption> options)

Sets options displayed on the selection "value of list" in the mapping component.

Parameters:

options - A java.util.List of IOptionList.IOption object