|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.bmc.mainview.nvbapi.Conversation
public abstract class Conversation
An active conversation with MVI-3. Requests are sent in over a conversation, and responses flow back. Conversations are created by a factory method in a HostServer object.
HostServer.conversationFactory()
Field Summary | |
---|---|
static VersionNumber |
HYPERLINKLEVEL
Documents the minimum server level at which hyperlinks could be requested |
static int |
MAPPED
Indicates that each row of data is to be returned as a String in the value of each row. |
XML |
status
The status returned from the previous request. |
static int |
TAGGED
Indicates that the fields of returned data are to be broken out into Ele objects in the EleList of each row. |
Method Summary | |
---|---|
void |
access(ServicePoint sp)
Sets the target that this conversation will send requests to. |
abstract 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. |
abstract void |
actionExecute(int row,
java.lang.String command)
Requests that a product action be performed. |
abstract void |
actionExecute(int row,
java.lang.String command,
java.lang.String parm)
Requests that a product action be performed. |
abstract void |
actionExecute(int row,
java.lang.String command,
java.lang.String[] parms)
Requests that a product action be performed. |
abstract void |
actionExecute(java.lang.String command)
Requests that a product action be performed. |
abstract void |
actionExecute(java.lang.String command,
java.lang.String parm)
Requests that a product action be performed. |
abstract void |
actionExecute(java.lang.String command,
java.lang.String[] parms)
Requests that a product action be performed. |
void |
addListener(ConversationListener listener)
Add a ConversationListener to monitor events on the conversation |
void |
close()
Terminates the conversation |
XML |
dataGet(int type)
Requests data from the current view |
XML |
dataGet(int type,
java.lang.String startrow,
java.lang.String numRows)
Requests data from the current view |
XML |
dataGet(int type,
java.lang.String startrow,
java.lang.String numRows,
java.lang.String qwhere)
Requests data from the current view |
abstract 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 |
abstract void |
dictionarySet(java.lang.String symbol,
java.lang.String value)
Sets a dictionary value for use by the back-end selector code. |
abstract java.lang.String[] |
extractMessages()
Get messages from a previous request |
abstract java.lang.String |
extractSymbol(java.lang.String symbol)
Get a MAINVIEW Symbol |
ViewDefinition |
getCurrentView()
Get the definition of the current view |
abstract HostServer |
getHost()
|
int |
getTimeout()
Get the amount of time to wait for a response from the host. |
XML |
mapGet()
Get the list of fields in a MAPPED view |
abstract XML |
mapGet(boolean hyperlinks)
Get the list of fields in a MAPPED view |
boolean |
removeListener(ConversationListener listener)
Remove a previously added ConversationListener |
void |
setCurrentView(ViewDefinition view)
Change the view that the conversation is working with. |
void |
setRefreshOff()
Allow data get operations to use the current sample |
void |
setRefreshOn()
Allow data get operations to get a new sample |
void |
setTimeout(int timeout)
Set the amount of time to wait for a response from the host. |
abstract void |
streamSend(java.lang.String name,
java.lang.String stream)
Send a data stream to the back end. |
abstract void |
timeSet(long time)
Gives access to the historical data stored on the mainframe |
void |
viewSet(java.lang.String view,
boolean returnAll)
Selects the view that will be addressed by subsequent mapGet, dataGet or actionExecute calls. |
void |
viewSet(java.lang.String view,
boolean returnAll,
java.lang.String viewParm)
Selects the view that will be addressed by subsequent mapGet, dataGet or actionExecute calls. |
void |
viewSet(java.lang.String view,
boolean returnAll,
java.lang.String[] viewParm)
Selects the view that will be addressed by subsequent mapGet, dataGet or actionExecute calls. |
void |
viewSet(ViewDefinition vdef,
boolean returnAll)
Selects the view that will be addressed by subsequent mapGet, dataGet or actionExecute calls. |
void |
viewSet(ViewDefinition vdef,
boolean returnAll,
java.lang.String viewParm)
Selects the view that will be addressed by subsequent mapGet, dataGet or actionExecute calls. |
void |
viewSet(ViewDefinition vdef,
boolean returnAll,
java.lang.String[] viewParm)
Selects the view that will be addressed by subsequent mapGet, dataGet or actionExecute calls. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int TAGGED
public static final int MAPPED
public static final VersionNumber HYPERLINKLEVEL
public XML status
state
The name of the product
ssi
Is this an SSI context? "y" or "n"
target
The target or context name
version
The NVBAPI protocol version. Currently "1.1"
product
The product ID
number-msg
The number of messages available
system
The system (only if ssi="n")
server
The PAS name (only if ssi="n")
view
The base view being accessed
last-cc
The last completion code
Method Detail |
---|
public void addListener(ConversationListener listener)
listener
- the listenerConversationListener
,
ConversationEvent
public boolean removeListener(ConversationListener listener)
listener
- the listener to be removed
addListener(com.bmc.mainview.nvbapi.ConversationListener)
public abstract XML access(java.lang.String context, java.lang.String system, java.lang.String server, java.lang.String product) throws java.io.IOException
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 access(ServicePoint sp) throws java.io.IOException
sp
- The MVI Service Point to be used.
java.io.IOException
public void viewSet(java.lang.String view, boolean returnAll) throws java.io.IOException
view
- The name of the viewreturnAll
- true
to include hidden fields in subsequent mapGet()
and
dataGet()
responses. false
to return only visible fields.
java.io.IOException
public void viewSet(ViewDefinition vdef, boolean returnAll) throws java.io.IOException
vdef
- The definition of the viewreturnAll
- true
to include hidden fields in subsequent mapGet()
and
dataGet()
responses. false
to return only visible fields.
java.io.IOException
public void viewSet(java.lang.String view, boolean returnAll, java.lang.String viewParm) throws java.io.IOException
view
- The name of the viewreturnAll
- true
to include hidden fields in subsequent mapGet()
and
dataGet()
responses. false
to return only visible fields.viewParm
- A parameter to modify the view.
java.io.IOException
public void viewSet(ViewDefinition vdef, boolean returnAll, java.lang.String viewParm) throws java.io.IOException
vdef
- The definition of the viewreturnAll
- true
to include hidden fields in subsequent mapGet()
and
dataGet()
responses. false
to return only visible fields.viewParm
- A parameter to modify the view.
java.io.IOException
public void viewSet(java.lang.String view, boolean returnAll, java.lang.String[] viewParm) throws java.io.IOException
view
- The name of the viewreturnAll
- true
to include hidden fields in subsequent mapGet()
and
dataGet()
responses. false
to return only visible fields.viewParm
- A set of parameters to modify the view.
java.io.IOException
public void viewSet(ViewDefinition vdef, boolean returnAll, java.lang.String[] viewParm) throws java.io.IOException
vdef
- The definition of the viewreturnAll
- true
to include hidden fields in subsequent mapGet()
and
dataGet()
responses. false
to return only visible fields.viewParm
- A set of parameters to modify the view.
java.io.IOException
public abstract void timeSet(long time) throws java.io.IOException
time
- The data and time from which the data is to be retrieved
java.io.IOException
public abstract void actionExecute(java.lang.String command) throws java.io.IOException
command
-
java.io.IOException
public abstract void actionExecute(java.lang.String command, java.lang.String parm) throws java.io.IOException
command
- parm
-
java.io.IOException
public abstract void actionExecute(java.lang.String command, java.lang.String[] parms) throws java.io.IOException
command
- parms
-
java.io.IOException
public abstract void actionExecute(int row, java.lang.String command) throws java.io.IOException
row
- command
-
java.io.IOException
public abstract void actionExecute(int row, java.lang.String command, java.lang.String parm) throws java.io.IOException
row
- command
- parm
-
java.io.IOException
public abstract void actionExecute(int row, java.lang.String command, java.lang.String[] parms) throws java.io.IOException
row
- command
- parms
-
java.io.IOException
public XML dataGet(int type) throws java.io.IOException
type
- The format of the result: Conversation.MAPPED or Conversation.TAGGED
java.io.IOException
dataGet(int, java.lang.String, java.lang.String)
public XML dataGet(int type, java.lang.String startrow, java.lang.String numRows) throws java.io.IOException
type
- The format of the result: Conversation.MAPPED or Conversation.TAGGEDnumRows
- The maximum number of rows of data to be retrieved.
An "ele" element has the following attributes and a CDATA section:
java.io.IOException
public XML dataGet(int type, java.lang.String startrow, java.lang.String numRows, java.lang.String qwhere) throws java.io.IOException
type
- The format of the result: Conversation.MAPPED or Conversation.TAGGEDnumRows
- The maximum number of rows of data to be retrieved.qwhere
- An expression to limit the data returned (max length=1024)
java.io.IOException
dataGet(int)
public abstract XML dataGet(int type, java.lang.String startrow, java.lang.String numRows, java.lang.String qwhere, java.lang.String where) throws java.io.IOException
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.dataGet(int)
public abstract java.lang.String extractSymbol(java.lang.String symbol) throws java.io.IOException
symbol
-
java.io.IOException
public abstract void dictionarySet(java.lang.String symbol, java.lang.String value) throws java.io.IOException
symbol
- value
-
java.io.IOException
public abstract void streamSend(java.lang.String name, java.lang.String stream) throws java.io.IOException, java.lang.IllegalArgumentException
name
- Up to 14 character stream namestream
- Arbitrary data stream
java.lang.IllegalArgumentException
- if name is longer than 14 characters.
java.io.IOException
public abstract java.lang.String[] extractMessages() throws java.io.IOException
java.io.IOException
public void setRefreshOn()
public void setRefreshOff()
public int getTimeout()
public void setTimeout(int timeout) throws java.net.SocketException
timeout
- the timeout delay in milliseconds.
java.net.SocketException
public ViewDefinition getCurrentView()
public void setCurrentView(ViewDefinition view)
view
- A view definition which has been previously set in this conversation.viewSet(ViewDefinition, boolean)
,
getCurrentView()
,
ViewDefinition.setForm(int)
public XML mapGet() throws java.io.IOException
java.io.IOException
mapGet(boolean)
public abstract XML mapGet(boolean hyperlinks) throws java.io.IOException, java.lang.IllegalArgumentException
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
,
dataGet(int)
,
MAPPED
public void close()
public abstract HostServer getHost()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |