Package com.ebasetech.xi.api
Interface MqResource
public interface MqResource extends Resource
The
MqResource
interface represents a message to be read and/or written to an MQ Series message queue.
- Since:
- V4.4
-
Method Summary
Modifier and Type Method Description int
read()
Reads a message from the MQSeries queue identified by the MQ resource and populates mapped form fields.void
write()
Constructs a message from mapped form field values and writes the message to the MQSeries queue identified by the MQ resource.int
write(boolean wait)
Constructs a message from mapped form field values and writes the message to the MQSeries queue identified by the MQ resource.Methods inherited from interface com.ebasetech.xi.api.Element
getElementName, getElementType
-
Method Details
-
read
int read() throws com.ebasetech.xi.exceptions.FormRuntimeExceptionReads a message from the MQSeries queue identified by the MQ resource and populates mapped form fields.- Throws:
com.ebasetech.xi.exceptions.FormRuntimeException
- if any error occurs during execution- Since:
- V4.4
-
write
void write() throws com.ebasetech.xi.exceptions.FormRuntimeExceptionConstructs a message from mapped form field values and writes the message to the MQSeries queue identified by the MQ resource.- Throws:
com.ebasetech.xi.exceptions.FormRuntimeException
- if any error occurs during execution- Since:
- V4.4
- See Also:
write(boolean)
-
write
int write(boolean wait) throws com.ebasetech.xi.exceptions.FormRuntimeExceptionConstructs a message from mapped form field values and writes the message to the MQSeries queue identified by the MQ resource.If parameter
wait
is true, waits for a reply to arrive on the reply queue message specified in the MQ resource and then issues a read command to this queue.- Parameters:
wait
-- Throws:
com.ebasetech.xi.exceptions.FormRuntimeException
- if any error occurs during execution- Since:
- V4.4
- See Also:
write()
-