|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.bmc.mainview.nvbapi.View
public abstract class View
Defines the common code for accessing MAINCVIEW views.
Field Summary | |
---|---|
java.lang.String |
localDate
|
java.lang.String |
localTime
|
Constructor Summary | |
---|---|
View(java.lang.String vname,
Conversation conversation,
java.lang.String where,
ViewListener exit)
Creates an object containing the data from a MAINVIEW view |
|
View(ViewDefinition vdef,
Conversation conversation,
java.lang.String where,
ViewListener exit)
Creates an object containing the data from a MAINVIEW view |
|
View(ViewDefinition vdef,
Conversation conversation,
ViewListener exit)
Creates an object containing the data from a MAINVIEW view |
Method Summary | |
---|---|
long |
convertTime()
Get the host local time that this view was generated |
int |
fieldCount()
The number of fields in the view |
Conversation |
getConversation()
The conversation being used by this View |
Field |
getField(int num)
Gets a field definition from a view |
Field |
getField(java.lang.String name)
Gets a field definition from a view |
java.lang.String |
getQwhere()
Retrieve the MVI QWHERE clause currently being used for this view. |
abstract java.lang.String |
getRawValue(int row,
Field field)
Extract a field value from a row of a data record |
int |
getRowMax()
|
java.lang.String |
getValue(int row,
Field field)
Retrieves the value of a particular field and removes leading and trailing blanks. |
java.lang.String |
getValue(int row,
java.lang.String name)
Extract a field value from a row of a data record |
java.lang.String |
getWhere()
Retrieve the MVI WHERE clause currently being used for this view. |
abstract void |
refresh()
Discards the cached view contents and gets new data from the host. |
void |
setHyperlinks(boolean hyperlinks)
Requests that hyperlink definitions be attached to each field. |
void |
setQwhere(java.lang.String qwhere)
Set an MVI QWHERE clause to be used with this view. |
void |
setRowMax(int rowMax)
|
void |
setWhere(java.lang.String where)
Set an MVI WHERE clause to be used with this view. |
int |
size()
Tells how many rows of data are available in the view |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public java.lang.String localTime
public java.lang.String localDate
Constructor Detail |
---|
public View(java.lang.String vname, Conversation conversation, java.lang.String where, ViewListener exit)
vname
- The name of the desired view.conversation
- A conversation produced by HostServer.ConversationFactorywhere
- A MAINVIEW WHERE clause used to filter the records.exit
- A ViewListener object whose eventPerformed() method is to be invoked
during processing.public View(ViewDefinition vdef, Conversation conversation, java.lang.String where, ViewListener exit)
vdef
- The definition of the desired view. This may contain any
desired parameters or filters.conversation
- A conversation produced by HostServer.ConversationFactorywhere
- A MAINVIEW WHERE clause used to filter the records.exit
- A ViewListener object whose eventPerformed() method is to be invoked
during processing.public View(ViewDefinition vdef, Conversation conversation, ViewListener exit)
vdef
- The definition of the desired view. This may contain any
desired parameters or filters.conversation
- A conversation produced by HostServer.ConversationFactoryexit
- A ViewListener object whose eventPerformed() method is to be invoked
during processing.Method Detail |
---|
public int size()
public Conversation getConversation()
public java.lang.String getWhere()
public void setWhere(java.lang.String where)
where
- ViewListener
,
ViewDefinition.setWhere(String)
public java.lang.String getQwhere()
public void setQwhere(java.lang.String qwhere)
qwhere
- ViewListener
,
ViewDefinition.setQwhere(String)
public abstract java.lang.String getRawValue(int row, Field field) throws java.io.IOException, java.lang.IllegalArgumentException
row
- The row number: 1 to nfield
- The field
java.lang.IllegalArgumentException
- if row number out of range
java.io.IOException
public java.lang.String getValue(int row, Field field) throws java.io.IOException, java.lang.IllegalArgumentException
row
- The row number: 1 to nfield
- Which field within the row
java.io.IOException
- if a new row has to be fetched and there is a communication error.
java.lang.IllegalArgumentException
- if row is out of rangepublic java.lang.String getValue(int row, java.lang.String name) throws java.io.IOException, java.lang.IllegalArgumentException
row
- The row number{ 1 to nname
- The name of the field
java.lang.IllegalArgumentException
- if row number out of range
java.io.IOException
public Field getField(int num)
num
- the field number
Field
,
fieldCount()
public Field getField(java.lang.String name)
name
- the field name
Field
,
fieldCount()
public int fieldCount()
public void setHyperlinks(boolean hyperlinks)
hyperlinks
- true, to request hyperlink definitions.
java.lang.IllegalStateException
- if invoked other than from the VIEWSET exit.
java.lang.IllegalArgumentException
- if host server is at too low a maintenance level.ViewListener
public abstract void refresh() throws java.io.IOException
java.io.IOException
public int getRowMax()
public void setRowMax(int rowMax)
rowMax
- the maximum number of rows. If zero, unlimited.public long convertTime()
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 |