com.adventnet.nms.fe.common
Class ViewData

java.lang.Object
  |
  +--com.adventnet.nms.fe.common.ViewData

All Implemented Interfaces:

java.io.Serializable

public class ViewData

extends java.lang.Object

implements java.io.Serializable

A class which holds the data to be viewed. This contains the data Vector to be sent to the client, and info. related to that data like viewlength, totallength, fromindex, primarykeys available etc.

Since:

Web NMS 2.3

See Also:

Serializable, Serialized Form

Constructor Summary

ViewData()

Method Summary

java.lang.Object	clone()
java.util.Properties	getAdditionalCriteria() Get the criteria that were applied while getData.
java.util.Properties	getCriteriaProperties() Get the criteria set to this custom view.
java.util.Vector	getData() Get the value of data (a Vector of Properties).
int	getEndIndex() Get the value of endIndex.
int	getEventUpdateThreshold()
int	getFromIndex() Get the value of fromIndex.
java.util.Vector	getKeys() Returns the list of primary keys for the Objects corresponding to the properties present in the data vector corresponding list of keys for the objects present in the data vector
java.lang.String	getOrderBy() Get the value of orderBy.
java.util.Properties[]	getScopeCriteria()
boolean	getSortFieldType() Deprecated. since the type can be of any primitive java data type.
int	getTotalLength() Get the value of totalLength.
long	getUniqueIdForUpdate() Get the value of uniqueIdForUpdate.
int	getViewLength() Get the value of viewLength.
boolean	isAppendCriteria() Returns whether the customview's criteria was also applied in addition to criteriaProperties.
boolean	isAscendingOrder() Returns whether the data should be sorted by ascending order based on orderByColumn.
boolean	isEnableNext() Get the value of enableNext.
boolean	isEnablePrevious() Get the value of enablePrevious.
boolean	isPerformOR() Returns whether the operation performed between different criteria specified in additionalCriteria is OR.
boolean	isTopEdge() Returns whether the data returned is at the top edge.
void	setAdditionalCriteria(java.util.Properties v) Set the value of additionalCriteria.
void	setAppendCriteria(boolean v) Sets whether the customview's criteria was also applied in addition to criteriaProperties.
void	setAscendingOrder(boolean ascending) Specifies whether the data should be sorted by ascending order based on orderByColumn.
void	setCriteriaProperties(java.util.Properties v) Set the value of custom view's criteria.
void	setData(java.util.Vector v) Set the value of data.
void	setEnableNext(boolean v) Set the value of enableNext.
void	setEnablePrevious(boolean v) Set the value of enablePrevious.
void	setEndIndex(int v) Set the value of endIndex.
void	setEventUpdateThreshold(int maxId)
void	setFromIndex(int v) Set the value of fromIndex.
void	setKeys(java.util.Vector v) Sets the list of keys for the objects present in the data vector
void	setOrderBy(java.lang.String v) Set the value of orderBy.
void	setPerformOR(boolean v) Set the value of performOR.
void	setScopeCriteria(java.util.Properties[] v) This method is for internal use to set the value of ScopeCriteria.
void	setSortFieldType(boolean type) Deprecated. since the type can be of any primitive java data type.
void	setTopEdge(boolean v) Set the value of topEdge.
void	setTotalLength(int v) Set the value of totalLength.
void	setUniqueIdForUpdate(long v) Set the value of uniqueIdForUpdate.
void	setViewLength(int v) Set the value of viewLength.
java.lang.String	toString() Just to print the datastructure

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ViewData

public ViewData()

Method Detail

getTotalLength

public int getTotalLength()

Get the value of totalLength.

Returns:

value of totalLength.

setTotalLength

public void setTotalLength(int v)

Set the value of totalLength.

Parameters:

v - Value to assign to totalLength.

getFromIndex

public int getFromIndex()

Get the value of fromIndex.

Returns:

value of fromIndex.

setFromIndex

public void setFromIndex(int v)

Set the value of fromIndex.

Parameters:

v - Value to assign to fromIndex.

getEndIndex

public int getEndIndex()

Get the value of endIndex.

Returns:

value of endIndex.

setEndIndex

public void setEndIndex(int v)

Set the value of endIndex.

Parameters:

v - Value to assign to endIndex.

getViewLength

public int getViewLength()

Get the value of viewLength.

Returns:

value of viewLength.

setViewLength

public void setViewLength(int v)

Set the value of viewLength.

Parameters:

v - Value to assign to viewLength.

isEnableNext

public boolean isEnableNext()

Get the value of enableNext.

Returns:

value of enableNext.

setEnableNext

public void setEnableNext(boolean v)

Set the value of enableNext.

Parameters:

v - Value to assign to enableNext.

isEnablePrevious

public boolean isEnablePrevious()

Get the value of enablePrevious.

Returns:

value of enablePrevious.

setEnablePrevious

public void setEnablePrevious(boolean v)

Set the value of enablePrevious.

Parameters:

v - Value to assign to enablePrevious.

getOrderBy

public java.lang.String getOrderBy()

Get the value of orderBy.

Returns:

value of orderBy.

setOrderBy

public void setOrderBy(java.lang.String v)

Set the value of orderBy.

Parameters:

v - Value to assign to orderBy.

getData

public java.util.Vector getData()

Get the value of data (a Vector of Properties).

Returns:

value of data.

setData

public void setData(java.util.Vector v)

Set the value of data.

Parameters:

v - Value to assign to data.

getKeys

public java.util.Vector getKeys()

Returns the list of primary keys for the Objects corresponding to the properties present in the data vector corresponding list of keys for the objects present in the data vector

Returns:

value of keys.

setKeys

public void setKeys(java.util.Vector v)

Sets the list of keys for the objects present in the data vector

Parameters:

v - Value to assign to keys.

getCriteriaProperties

public java.util.Properties getCriteriaProperties()

Get the criteria set to this custom view.

Returns:

criteria assigned to this custom view.

setCriteriaProperties

public void setCriteriaProperties(java.util.Properties v)

Set the value of custom view's criteria.

Parameters:

v - Value to assign to criteriaProperties.

getAdditionalCriteria

public java.util.Properties getAdditionalCriteria()

Get the criteria that were applied while getData.

Returns:

value of criteria that were applied while getData.

See Also:

isAppendCriteria()

setAdditionalCriteria

public void setAdditionalCriteria(java.util.Properties v)

Set the value of additionalCriteria.

Parameters:

v - Value to assign to additionalCriteria.

isAppendCriteria

public boolean isAppendCriteria()

Returns whether the customview's criteria was also applied in addition to criteriaProperties. If false, only criteriaProperties would've been used while getData. If true, then both customview's criteria and criteriaProperties would've been used.

Returns:

true if customview's criteria was also applied, false otherwise.

setAppendCriteria

public void setAppendCriteria(boolean v)

Sets whether the customview's criteria was also applied in addition to criteriaProperties. If false, only criteriaProperties would've been used while getData. If true, then both customview's criteria and criteriaProperties would've been used.

Parameters:

true - if customview's criteria was also applied, false otherwise.

isTopEdge

public boolean isTopEdge()

Returns whether the data returned is at the top edge.

Returns:

true if the returned data is at the top edge, false otherwise.

setTopEdge

public void setTopEdge(boolean v)

Set the value of topEdge.

Parameters:

v - Value to assign to topEdge.

isPerformOR

public boolean isPerformOR()

Returns whether the operation performed between different criteria specified in additionalCriteria is OR.

Returns:

value of performOR.

setPerformOR

public void setPerformOR(boolean v)

Set the value of performOR.

Parameters:

v - Value to assign to performOR.

isAscendingOrder

public boolean isAscendingOrder()

Returns whether the data should be sorted by ascending order based on orderByColumn.

Returns:

true if data should be sorted in ascending order based on orderByColumn, false otherwise.

setAscendingOrder

public void setAscendingOrder(boolean ascending)

Specifies whether the data should be sorted by ascending order based on orderByColumn.

Parameters:

ascending - true if data should be sorted in ascending order based on orderByColumn, false otherwise.

Returns:

true if data should be sorted in ascending order based on orderByColumn, false otherwise.

setSortFieldType

public void setSortFieldType(boolean type)

Deprecated. since the type can be of any primitive java data type.

To set the datatype of the sorting field. A true value indicates a Numeric data type and a false indicates a String datatype.

Parameters:

type - a boolean value

getSortFieldType

public boolean getSortFieldType()

Deprecated. since the type can be of any primitive java data type.

To get the data type of the sorting field. A true denotes Numeric data and a false denotes String data.

Returns:

a boolean value

getUniqueIdForUpdate

public long getUniqueIdForUpdate()

Get the value of uniqueIdForUpdate.

Returns:

value of uniqueIdForUpdate.

setUniqueIdForUpdate

public void setUniqueIdForUpdate(long v)

Set the value of uniqueIdForUpdate.

Parameters:

v - Value to assign to uniqueIdForUpdate.

getScopeCriteria

public java.util.Properties[] getScopeCriteria()

setScopeCriteria

public void setScopeCriteria(java.util.Properties[] v)

This method is for internal use to set the value of ScopeCriteria. Users are not entertained to use this method to set the scope criteria.

Parameters:

v - Value to assign to ScopeCriteria.

toString

public java.lang.String toString()

Just to print the datastructure

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

setEventUpdateThreshold

public void setEventUpdateThreshold(int maxId)

getEventUpdateThreshold

public int getEventUpdateThreshold()