com.sapportals.connector.metadata.structures

Interface IStructureValue

All Known Subinterfaces:

IExtendedStructure, IParameter

public interface IStructureValue

Holds metadata for values: default value, valid values and mandatory flag.

Method Summary

Modifier and Type	Method and Description
Object	getDefaultValue() Returns the default value of the structure if exists
Set	getValidValues() Returns a set of valid values for this structure.
boolean	hasDefaultValue() Returns whether the structure has a default value.
int	isOptional() Returns whether the structure is optional

Method Detail

getDefaultValue

Object getDefaultValue()
                throws ConnectorException

Returns the default value of the structure if exists

Returns:

The default value of the structure, null if has none

Throws:

ConnectorException - if connector is failed

getValidValues

Set getValidValues()
            throws ConnectorException

Returns a set of valid values for this structure.

Returns:

The set of valid values for this structure.

Throws:

ConnectorException - if connector is failed

hasDefaultValue

boolean hasDefaultValue()

Returns whether the structure has a default value.

Returns:

true if the structure has a default value, otherwise false

isOptional

int isOptional()

Returns whether the structure is optional

Returns:

int representing the mandatory value mandatory, optional or unknown