Class: FlexCargo

FlexCargo

Represents the returned user 'cargo' from a Voyager execution. A FlexCargo may have user-created properties as well as either a FlexJourney or a FlexResultSet.

Classes

FlexCargo

Members

journey

Properties:

Name	Type	Description
`journey`	FlexJourney

resultSet

Properties:

Name	Type	Description
`resultSet`	FlexResultSet

userProperties

Properties:

Name	Type	Description
`userProperties`	Object	Returns this FlexCargo's user properties

Methods

getUserProperty(keynon-null)

Parameters:

Name	Type	Description
`key`	string

Returns:

A user property named key if it exists

hasJourney() → {boolean}

Returns:

True if this FlexCargo contains a FlexJourney

Type: boolean

hasResultSet() → {boolean}

Returns:

True if this FlexCargo contains a FlexResultSet

Type: boolean