|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.bmc.mainview.nvbapi.ViewDefinition
public class ViewDefinition
An in-line view definition used with View and Conversation View definitions can be customized using MAINVIEW Explorer and exported as .vdf files using the "export view data" button.
Conversation.viewSet(ViewDefinition, boolean)
,
View
Field Summary | |
---|---|
java.lang.String |
applidData
The application ID |
java.lang.String |
descData
The view description |
boolean |
isCustom
Has the view been customized |
java.lang.String |
nameData
The base view name |
java.lang.String[] |
parameters
Any parameters to be passed to the view |
java.lang.String |
productData
The product field |
java.lang.String |
qwhere
A qwhere string to be used with DataGet |
static int |
SORTASCENDING
|
static int |
SORTDESCENDING
|
java.lang.String |
sortField
The Field to sort on |
static int |
SORTNONE
The sort type |
int |
sortType
|
java.io.File |
source
Where it was loaded from |
java.lang.String |
where
A where string to be used with DataGet |
Constructor Summary | |
---|---|
ViewDefinition()
|
|
ViewDefinition(java.io.File text)
|
|
ViewDefinition(java.lang.String name)
Create a view definition which refers to a view on the host. |
Method Summary | |
---|---|
java.lang.String |
getDefinition()
|
int |
getForm()
|
java.lang.String |
getName()
|
java.lang.String[] |
getParameters()
|
java.lang.String |
getProduct()
Lookup the product that this view came from using the products.properties file. |
java.lang.String |
getQwhere()
|
java.lang.String |
getSortField()
|
int |
getSortType()
|
java.lang.String |
getWhere()
|
void |
setDefinition(java.lang.String definition)
|
void |
setForm(int form)
Indicate that this view is a form of the current view using the same data sample. |
void |
setName(java.lang.String name)
|
void |
setParameter(java.lang.String parameter)
|
void |
setParameters(java.lang.String[] parameters)
|
void |
setProduct(java.lang.String prod)
Set which product supports this view |
void |
setQwhere(java.lang.String qwhere)
|
void |
setSort(java.lang.String sortField)
|
void |
setSort(java.lang.String sortField,
int sortType)
|
void |
setWhere(java.lang.String where)
|
void |
write(java.io.BufferedWriter wtr)
Create a file that can be used to reload the view. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public java.lang.String descData
public java.lang.String nameData
public java.lang.String productData
public java.lang.String applidData
public java.lang.String[] parameters
public java.lang.String where
public java.lang.String qwhere
public boolean isCustom
public java.io.File source
public java.lang.String sortField
public static final int SORTNONE
public static final int SORTASCENDING
public static final int SORTDESCENDING
public int sortType
Constructor Detail |
---|
public ViewDefinition()
public ViewDefinition(java.io.File text) throws java.io.IOException
java.io.IOException
public ViewDefinition(java.lang.String name)
name
- Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String name)
public java.lang.String getDefinition()
public void setDefinition(java.lang.String definition)
public void write(java.io.BufferedWriter wtr) throws java.io.IOException
wtr
-
java.io.IOException
- on errorspublic java.lang.String getProduct()
java.lang.IllegalArgumentException
- if the product is not in the filesetDefinition(String)
public void setProduct(java.lang.String prod)
prod
- public java.lang.String[] getParameters()
public void setParameter(java.lang.String parameter)
parameter
- Provide a single parameterpublic void setParameters(java.lang.String[] parameters)
parameters
- the parameters to setpublic java.lang.String getSortField()
public void setSort(java.lang.String sortField)
sortField
- the field to usepublic void setSort(java.lang.String sortField, int sortType)
sortField
- the field to usesortType
- One of SORTASCENDING or SORTDESCENDINGpublic int getSortType()
public int getForm()
setForm(int)
public void setForm(int form)
form
- the form number to set. 0 = base, or 1 - 20NOTE: Requires BPY8796 maintenance level on the host server.
public java.lang.String getWhere()
public void setWhere(java.lang.String where)
where
- the expression to setpublic java.lang.String getQwhere()
public void setQwhere(java.lang.String qwhere)
qwhere
- the expression to set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |