com.technia.tif.enovia.integration.create

Interface Context

@API
public interface Context

Since:

2016.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Context.ReturnType Defines the return type
static class	Context.Select Encapsulates the select expression and the definition of what return type is expected from the expression.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrentDetails()
IntegrationContext	getIntegrationContext()
java.lang.String	getMode()
java.lang.String	getValue(Context.Select select) Returns the value for a specific select expression.
default java.lang.String	getValue(java.lang.String expression) Deprecated. Use getValue(Select) instead
java.util.List<java.lang.String>	getValues(Context.Select select) Returns the values for a specific select expression
default java.util.List<java.lang.String>	getValues(java.lang.String expression) Deprecated. Use getValues(Select) instead
boolean	isValidFor(com.technia.tif.enovia.integration.create.def.CreateConfig cs)
java.util.Iterator<Context>	iterate(java.lang.String select, java.lang.String mode)

Method Detail

getMode

java.lang.String getMode()

Returns:

The mode this Context works in

getIntegrationContext

IntegrationContext getIntegrationContext()

Returns:

The IntegrationContext containing information about this particular integration use case.

Since:

2016.2.0

isValidFor

boolean isValidFor(com.technia.tif.enovia.integration.create.def.CreateConfig cs)

Parameters:

cs -

Returns:

Is valid for

Since:

2016.2.0

getValue

@Deprecated
default java.lang.String getValue(java.lang.String expression)

Deprecated. Use getValue(Select) instead

Returns the value for a specific select expression. The expression is expected to match a single result

Parameters:

expression - The expression

Returns:

The selected value

Since:

2016.2.0

getValues

@Deprecated
default java.util.List<java.lang.String> getValues(java.lang.String expression)

Deprecated. Use getValues(Select) instead

Returns the values for a specific select expression

Parameters:

expression - The expression

Returns:

list of values

Since:

2017-03-16

getValue

java.lang.String getValue(Context.Select select)

Returns the value for a specific select expression. The expression is expected to match a single result

Parameters:

select - The select expression information

Returns:

The selected value

getValues

java.util.List<java.lang.String> getValues(Context.Select select)

Returns the values for a specific select expression

Parameters:

select - The select expression information

Returns:

list of values

iterate

java.util.Iterator<Context> iterate(java.lang.String select,
                                    java.lang.String mode)

Parameters:

select - The select expression

mode - The mode to match in

Returns:

An iterator of sub context's

getCurrentDetails

java.lang.String getCurrentDetails()

Returns:

A text string providing some information about the location of the current context. This string can mainly be used when constructing error messages or other log related messages in order to make it easier to understand where in the source data the current context operates on.