Public Class VoltMxResultObject

Properties Detail

• httpStatusCode (Get)

  Public Property Get httpStatusCode As Integer
  HTTP status code that will be returned from the integration service.
  Code Sample
  ' The following tells the user they are not allowed to perform this code VoltMxResult.httpStatusCode = 403 VoltMxResult.opstatus = 1 Call VoltMxResult.result.insertMessage("error", "You are not authorized to perform this operation")

• opstatus (Get)

  Public Property Get opstatus As Integer
  Opstatus that will be returned from the integration service.
  Code Sample
  ' The following code sets the opstatus to 1. opstatus 0 is typically used by Iris processing to denote success. VoltMxResult.httpStatusCode = 403 VoltMxResult.opstatus = 1 Call VoltMxResult.result.insertMessage("error", "You are not authorized to perform this operation")

• result (Get)

  Public Property Get result As JsonObject
  JsonObject that will be outputted from the integration service
  Code Sample
  ' The following code adds a boolean "success" parameter to the JSON output of the integration service VoltMxResult.result.insertValue("success", true)

• httpStatusCode (Set)

  Public Property Set httpStatusCode As Integer
  HTTP status code that will be returned from the integration service.
  Code Sample
  ' The following tells the user they are not allowed to perform this code VoltMxResult.httpStatusCode = 403 VoltMxResult.opstatus = 1 Call VoltMxResult.result.insertMessage("error", "You are not authorized to perform this operation")

• opstatus (Set)

  Public Property Set opstatus As Integer
  Opstatus that will be returned from the integration service.
  Code Sample
  ' The following code sets the opstatus to 1. opstatus 0 is typically used by Iris processing to denote success. VoltMxResult.httpStatusCode = 403 VoltMxResult.opstatus = 1 Call VoltMxResult.result.insertMessage("error", "You are not authorized to perform this operation")

Methods Detail

• toJson

  Public Function toJson() As JsonObject
  Converts the VoltMxResultObject into JSON for passing back to Foundry'
  Code Sample
  ' This code is from the Foundry boilerplate Try Catch Call VoltMxResult.setErrorMessage(getErrorMsg("VOLTSCRIPT_CONNECTOR: ")) Finally Print VoltMxResult.toJson().toString(false) End Try

• addDebugMessage

  Public Sub addDebugMessage(message As String)
  Adds a message to be debugged from Foundry's Java logger.
  idx	Argument	Data Type	Attributes	Comments
  1	message	String		Message to debug
  Code Sample
  ' This adds a debug message that will be put into the relevant Foundry log, if set to log debug messages. Call VoltMxResult.addDebugMessage("Ran on line 12")

• addDeviceHeaderParam

  Public Sub addDeviceHeaderParam(key As String, value As String)
  Adds a device header parameter for the Foundry response.
  idx	Argument	Data Type	Attributes	Comments
  1	key	String		Key of the device header parameter
  2	value	String		String value for the device header parameter
  Code Sample
  ' The following adds a device header Call VoltMxResult.addDeviceHeader("X-VOLTSCRIPT", "Ran")
  Throws Exceptions
  Message	Error Code	Comments
  Adding response device header parameters is not relevant for PreProcessors	1001

• addHeaderParam

  Public Sub addHeaderParam(key As String, value As Variant)
  Adds a header param to the Foundry response.
  idx	Argument	Data Type	Attributes	Comments
  1	key	String		Key for the Foundry response parameter
  2	value	Variant		Value for the Foundry response parameter
  Code Sample
  ' This code adds a header parameter to VoltMxRequest object Call VoltMxResult.addHeaderParam("X-VOLTSCRIPT", "Ran")
  Throws Exceptions
  Message	Error Code	Comments
  Adding header parameters is not relevant for PreProcessors	1001

• addInputParam

  Public Sub addInputParam(key As String, value As Variant)
  Adds an input parameter for the Foundry integration service. This is only relevant for preprocessors.
  idx	Argument	Data Type	Attributes	Comments
  1	key	String		Key for the input parameter
  2	value	Variant		Value for the input parameter
  Code Sample
  'The following code would add a username from a session parameter to the subsequent request, if available. This could be used to lazy-load the value. Dim username as String username = VoltMxSession.getAttribute("username") If (username != "") Then Call VoltMxResult.addInputParam("username", username) Else ' E.g. extract from base64-decoded JWT token) End If
  Throws Exceptions
  Message	Error Code	Comments
  Adding input parameters is only relevant for PreProcessors	1001

• addRequestParam

  Public Sub addRequestParam(key As String, value As Variant)
  Adds a request parameter to the Foundry request. Only relevant for preprocessors.
  idx	Argument	Data Type	Attributes	Comments
  1	key	String		Key for the request parameter
  2	value	Variant		Value for the request parameter
  Code Sample
  ' This code adds a request parameter to the subsequent request Call VoltMxResult.addRequestParam("VOLT-MX-VOLTSCRIPT", "Code ran")
  Throws Exceptions
  Message	Error Code	Comments
  Adding request parameters is only relevant for PreProcessors	1001

• addSessionAttribute

  Public Sub addSessionAttribute(key As String, value As Variant)
  Adds a session attribute for the Foundry session object.
  idx	Argument	Data Type	Attributes	Comments
  1	key	String		Key for the session attribute
  2	value	Variant		Value for the session attribute
  Code Sample
  ' The following code adds a JWT token from a variable to the session, for use in subsequent calls. This might be used if you are authenticating via a functional account. Call VoltMxResult.addSessionAttribute("authToken", jwtToken)

• echoHttpServerContext

  Public Sub echoHttpServerContext()
  Copies the incoming unit test context for VoltScript HTTP server into the result, the unitTestContext element outputed by setting "vsTestingContext":true in integration services.
  Code Sample
  ' This code just echoes the http server context Call VoltMxResult.echoUnitTestContext()

• echoUnitTestContext

  Public Sub echoUnitTestContext()
  Copies the incoming unit test context for VoltScript HTTP server into the result, the unitTestContext element outputed by setting "vsTestingContext":true in integration services.
  Code Sample
  ' This code just echoes the context Call VoltMxResult.echoUnitTestContext()

• loadFromJson

  Public Sub loadFromJson(jsonObj As JsonObject)
  idx	Argument	Data Type	Attributes	Comments
  1	jsonObj	JsonObject		JSON object containing the incoming result
  Code Sample
  ' The following code is from extractObjects function Call jsonParser.loadFromJson(data) Set jsonObj = jsonParser.getRootObject() If (jsonObj.isChild(RESULT_PARAM)) Then Set passedObj = jsonObj.getChild(RESULT_PARAM) Else Set passedObj = New JsonObject() End If Call VoltMxResult.loadFromjson(passedObj)

• New

  Public Sub New(isPreProcessor As Boolean)
  Constructor. This is automatically called during extractObjects() and should not be run manually.
  idx	Argument	Data Type	Attributes	Comments
  1	isPreProcessor	Boolean		Whether the VoltScript is being called from a preprocessor

• setErrorMessage

  Public Sub setErrorMessage(message As String)
  Sets an error message to pass back to Foundry. Only a single string error message can be passed back.
  idx	Argument	Data Type	Attributes	Comments
  1	message	String		Error message to send back to the browser
  Code Sample
  ' This code is from the Foundry boilerplate Try Catch Call VoltMxResult.setErrorMessage(getErrorMsg("VOLTSCRIPT_CONNECTOR: ")) Finally Print VoltMxResult.toJson().toString(false) End Try