|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.bmc.mainview.nvbapi.Conversation
com.bmc.mainview.nvbapi.LiveConv
public class LiveConv
A conversation with a host server.
One is created to send a series of requests and receive the responses.
LiveServer
Field Summary |
---|
Fields inherited from class com.bmc.mainview.nvbapi.Conversation |
---|
HYPERLINKLEVEL, MAPPED, status, TAGGED |
Constructor Summary | |
---|---|
LiveConv(LiveServer hst)
|
|
LiveConv(LiveServer hst,
java.lang.String monitorID)
|
Method Summary | |
---|---|
XML |
access(java.lang.String context,
java.lang.String system,
java.lang.String server,
java.lang.String product)
Sets the target that this conversation will send requests to. |
void |
actionExecute(int row,
java.lang.String command)
Requests that a product action be performed. |
void |
actionExecute(int row,
java.lang.String command,
java.lang.String parm)
Requests that a product action be performed. |
void |
actionExecute(int row,
java.lang.String command,
java.lang.String[] parms)
Requests that a product action be performed. |
void |
actionExecute(java.lang.String command)
Requests that a product action be performed. |
void |
actionExecute(java.lang.String command,
java.lang.String parm)
Requests that a product action be performed. |
void |
actionExecute(java.lang.String command,
java.lang.String[] parms)
Requests that a product action be performed. |
void |
close()
Terminates the conversation |
XML |
dataGet(int type,
java.lang.String startrow,
java.lang.String numRows,
java.lang.String qwhere,
java.lang.String where)
Retrieve the data from the current view |
void |
dictionarySet(java.lang.String symbol,
java.lang.String value)
Sets a dictionary symbol in the host. |
java.lang.String[] |
extractMessages()
Retrieve any messages set by a preceding request. |
java.lang.String |
extractSymbol(java.lang.String symbol)
One of the side effects of an action is to set a symbol. |
HostServer |
getHost()
|
XML |
mapGet(boolean hyperlinks)
Returns the list of fields and their location in MAPPED data for the current view |
XML |
send(XML req)
|
void |
setTimeout(int timeout)
Set the amount of time to wait for a response from the host. |
void |
streamSend(java.lang.String name,
java.lang.String stream)
Send a data stream to the back end. |
void |
timeSet()
Gives access to the historical data stored on the mainframe. |
void |
timeSet(long time)
Gives access to the historical data stored on the mainframe |
void |
timeSet(java.lang.String time)
Gives access to the historical data stored on the mainframe. |
void |
timeSet(java.lang.String time,
java.lang.String date)
Gives access to the historical data stored on the mainframe. |
void |
timeSet(java.lang.String time,
java.lang.String date,
java.lang.String duration)
A single interval is assumed. |
void |
timeSet(java.lang.String time,
java.lang.String date,
java.lang.String duration,
java.lang.String units)
Gives access to the historical data stored on the mainframe |
java.lang.String |
toString()
|
Methods inherited from class com.bmc.mainview.nvbapi.Conversation |
---|
access, addListener, dataGet, dataGet, dataGet, getCurrentView, getTimeout, mapGet, removeListener, setCurrentView, setRefreshOff, setRefreshOn, viewSet, viewSet, viewSet, viewSet, viewSet, viewSet |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LiveConv(LiveServer hst, java.lang.String monitorID) throws java.io.IOException
java.io.IOException
public LiveConv(LiveServer hst) throws java.io.IOException
java.io.IOException
Method Detail |
---|
public void setTimeout(int timeout) throws java.net.SocketException
Conversation
setTimeout
in class Conversation
timeout
- the timeout delay in milliseconds.
java.net.SocketException
public XML access(java.lang.String context, java.lang.String system, java.lang.String server, java.lang.String product) throws java.io.IOException
Conversation
access
in class Conversation
context
- the MVI defined context to be usedsystem
- The zOS system nameserver
- The job name of the PAS (Product Address Space)product
- The MVI product whose views are to be used
java.io.IOException
ServicePoint
public void timeSet(long time) throws java.io.IOException
Conversation
timeSet
in class Conversation
time
- The data and time from which the data is to be retrieved
java.io.IOException
public void timeSet() throws java.io.IOException
java.io.IOException
public void timeSet(java.lang.String time) throws java.io.IOException
time
- = ”current | * | = | hh:mm:ss”
java.io.IOException
public void timeSet(java.lang.String time, java.lang.String date) throws java.io.IOException
time
- = ”current | * | = | hh:mm:ss”
date
- = "current | * | = | ddmmyyyy”"
java.io.IOException
public void timeSet(java.lang.String time, java.lang.String date, java.lang.String duration) throws java.io.IOException
time
- = ”current | * | = | hh:mm:ss”
date
- = "current | * | = | ddmmyyyy”"
duration
- = ”1 | nnn | prev | next | * | =”
java.io.IOException
public void timeSet(java.lang.String time, java.lang.String date, java.lang.String duration, java.lang.String units) throws java.io.IOException
time
- the desired time; this is a request for the ending interval containing this time
date
- the desired date; this is a request for the ending interval containing this date
duration
- the number of “units” of time to be included; the unit is specified with the units attribute
units
- defines what a unit is for the duration attribute
java.io.IOException
public void actionExecute(java.lang.String command) throws java.io.IOException
Conversation
actionExecute
in class Conversation
java.io.IOException
public void actionExecute(java.lang.String command, java.lang.String parm) throws java.io.IOException
Conversation
actionExecute
in class Conversation
java.io.IOException
public void actionExecute(java.lang.String command, java.lang.String[] parms) throws java.io.IOException
Conversation
actionExecute
in class Conversation
java.io.IOException
public void actionExecute(int row, java.lang.String command) throws java.io.IOException
Conversation
actionExecute
in class Conversation
java.io.IOException
public void actionExecute(int row, java.lang.String command, java.lang.String parm) throws java.io.IOException
Conversation
actionExecute
in class Conversation
java.io.IOException
public void actionExecute(int row, java.lang.String command, java.lang.String[] parms) throws java.io.IOException
Conversation
actionExecute
in class Conversation
java.io.IOException
public XML dataGet(int type, java.lang.String startrow, java.lang.String numRows, java.lang.String qwhere, java.lang.String where) throws java.io.IOException
Conversation
dataGet
in class Conversation
type
- Either TAGGED or MAPPEDstartrow
- First row to be retrievednumRows
- How many rows to retrieveqwhere
- A MAINVIEW QWHERE clause to filter the query (max length=1024)where
- A MAINVIEW WHERE clause to filter the rows (max length=1024)
java.io.IOException
- in case of error.Conversation.dataGet(int)
public java.lang.String[] extractMessages() throws java.io.IOException
extractMessages
in class Conversation
java.io.IOException
public java.lang.String extractSymbol(java.lang.String symbol) throws java.io.IOException
extractSymbol
in class Conversation
symbol
-
java.io.IOException
public XML mapGet(boolean hyperlinks) throws java.io.IOException, java.lang.IllegalArgumentException
mapGet
in class Conversation
hyperlinks
- true if hyperlink definitions are to be returned for each field.
java.io.IOException
java.lang.IllegalArgumentException
- if hyperlinks are requested, but the host is at
a maintenance level that does not support this function.Hyperlink
,
Conversation.dataGet(int)
,
Conversation.MAPPED
public void close()
Conversation
close
in class Conversation
public XML send(XML req)
public HostServer getHost()
getHost
in class Conversation
public void dictionarySet(java.lang.String symbol, java.lang.String value) throws java.io.IOException
dictionarySet
in class Conversation
java.io.IOException
public void streamSend(java.lang.String name, java.lang.String stream) throws java.io.IOException, java.lang.IllegalArgumentException
streamSend
in class Conversation
name
- Up to 14 character stream namestream
- Arbitrary data stream
java.lang.IllegalArgumentException
- if name is longer than 14 characters.
java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |