net.opengis.olsnav.v_1_3
Class ProcessCursorRequest

java.lang.Object
  net.opengis.ols.v_1_2.AbstractRequestParametersType
      net.opengis.olsnav.v_1_3.ProcessCursorRequest

All Implemented Interfaces:

Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo, org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.HashCode, org.jvnet.jaxb2_commons.lang.MergeFrom, org.jvnet.jaxb2_commons.lang.ToString

public class ProcessCursorRequest
extends AbstractRequestParametersType
implements Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo, org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.HashCode, org.jvnet.jaxb2_commons.lang.MergeFrom, org.jvnet.jaxb2_commons.lang.ToString

This request is for the server to process all of the records in the result set starting with the first record regardless of where the cursor's current position is currently positioned. Upon completion of this request, the cursor current position is positioned at the end of the complete result set. The action function's first parameter is a pointer to a structure of the type contained in the cursor's records. The second is an application-defined structure, or NULL. In processing each cursor element, the third element of ProcessCursorRequest is passed in as the second argument of ActionFunc. If ActionFunc yields a negative result value, processing will be aborted. ProcessCursorResponse returns the number of records processed.

Java class for ProcessCursorRequest complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ProcessCursorRequest">
   <complexContent>
     <extension base="{http://www.opengis.net/xls}AbstractRequestParametersType">
       <sequence>
         <element name="CursorID" type="{http://www.opengis.net/ols/nav}CursorIDType"/>
         <element name="ActionFunc" type="{http://www.w3.org/2001/XMLSchema}anyType"/>
         <element name="ActionFuncParam" type="{http://www.w3.org/2001/XMLSchema}anyType"/>
       </sequence>
       <attribute name="priority" use="required" type="{http://www.opengis.net/ols/nav}PriorityType" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

protected Object	actionFunc
protected Object	actionFuncParam
protected CursorIDType	cursorID
protected int	priority

Constructor Summary

ProcessCursorRequest()

Method Summary

StringBuilder	append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)
Object	clone()
Object	copyTo(Object target)
Object	copyTo(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, Object target, org.jvnet.jaxb2_commons.lang.CopyStrategy strategy)
Object	createNewInstance()
boolean	equals(Object object)
boolean	equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy)
Object	getActionFunc() Gets the value of the actionFunc property.
Object	getActionFuncParam() Gets the value of the actionFuncParam property.
CursorIDType	getCursorID() Gets the value of the cursorID property.
int	getPriority() Gets the value of the priority property.
int	hashCode()
int	hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy strategy)
boolean	isSetActionFunc()
boolean	isSetActionFuncParam()
boolean	isSetCursorID()
boolean	isSetPriority()
void	mergeFrom(org.jvnet.jaxb2_commons.locator.ObjectLocator leftLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb2_commons.lang.MergeStrategy strategy)
void	mergeFrom(Object left, Object right)
void	setActionFunc(Object value) Sets the value of the actionFunc property.
void	setActionFuncParam(Object value) Sets the value of the actionFuncParam property.
void	setCursorID(CursorIDType value) Sets the value of the cursorID property.
void	setPriority(int value) Sets the value of the priority property.
String	toString()
ProcessCursorRequest	withActionFunc(Object value)
ProcessCursorRequest	withActionFuncParam(Object value)
ProcessCursorRequest	withCursorID(CursorIDType value)
ProcessCursorRequest	withPriority(int value)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

cursorID

protected CursorIDType cursorID

actionFunc

protected Object actionFunc

actionFuncParam

protected Object actionFuncParam

priority

protected int priority

Constructor Detail

ProcessCursorRequest

public ProcessCursorRequest()

Method Detail

getCursorID

public CursorIDType getCursorID()

Gets the value of the cursorID property.

Returns:

possible object is CursorIDType

setCursorID

public void setCursorID(CursorIDType value)

Sets the value of the cursorID property.

Parameters:

value - allowed object is CursorIDType

isSetCursorID

public boolean isSetCursorID()

getActionFunc

public Object getActionFunc()

Gets the value of the actionFunc property.

Returns:

possible object is Object

setActionFunc

public void setActionFunc(Object value)

Sets the value of the actionFunc property.

Parameters:

value - allowed object is Object

isSetActionFunc

public boolean isSetActionFunc()

getActionFuncParam

public Object getActionFuncParam()

Gets the value of the actionFuncParam property.

Returns:

possible object is Object

setActionFuncParam

public void setActionFuncParam(Object value)

Sets the value of the actionFuncParam property.

Parameters:

value - allowed object is Object

isSetActionFuncParam

public boolean isSetActionFuncParam()

getPriority

public int getPriority()

Gets the value of the priority property.

setPriority

public void setPriority(int value)

Sets the value of the priority property.

isSetPriority

public boolean isSetPriority()

toString

public String toString()

Overrides:

toString in class AbstractRequestParametersType

append

public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                            StringBuilder buffer,
                            org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)

Specified by:

append in interface org.jvnet.jaxb2_commons.lang.ToString

Overrides:

append in class AbstractRequestParametersType

appendFields

public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                                  StringBuilder buffer,
                                  org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)

Specified by:

appendFields in interface org.jvnet.jaxb2_commons.lang.ToString

Overrides:

appendFields in class AbstractRequestParametersType

equals

public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
                      org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
                      Object object,
                      org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy)

Specified by:

equals in interface org.jvnet.jaxb2_commons.lang.Equals

Overrides:

equals in class AbstractRequestParametersType

equals

public boolean equals(Object object)

Overrides:

equals in class AbstractRequestParametersType

hashCode

public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                    org.jvnet.jaxb2_commons.lang.HashCodeStrategy strategy)

Specified by:

hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode

Overrides:

hashCode in class AbstractRequestParametersType

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRequestParametersType

clone

public Object clone()

Overrides:

clone in class AbstractRequestParametersType

copyTo

public Object copyTo(Object target)

Specified by:

copyTo in interface org.jvnet.jaxb2_commons.lang.CopyTo

Overrides:

copyTo in class AbstractRequestParametersType

copyTo

public Object copyTo(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                     Object target,
                     org.jvnet.jaxb2_commons.lang.CopyStrategy strategy)

Specified by:

copyTo in interface org.jvnet.jaxb2_commons.lang.CopyTo

Overrides:

copyTo in class AbstractRequestParametersType

createNewInstance

public Object createNewInstance()

Specified by:

createNewInstance in interface org.jvnet.jaxb2_commons.lang.CopyTo

Specified by:

createNewInstance in interface org.jvnet.jaxb2_commons.lang.MergeFrom

mergeFrom

public void mergeFrom(Object left,
                      Object right)

Specified by:

mergeFrom in interface org.jvnet.jaxb2_commons.lang.MergeFrom

Overrides:

mergeFrom in class AbstractRequestParametersType

mergeFrom

public void mergeFrom(org.jvnet.jaxb2_commons.locator.ObjectLocator leftLocator,
                      org.jvnet.jaxb2_commons.locator.ObjectLocator rightLocator,
                      Object left,
                      Object right,
                      org.jvnet.jaxb2_commons.lang.MergeStrategy strategy)

Specified by:

mergeFrom in interface org.jvnet.jaxb2_commons.lang.MergeFrom

Overrides:

mergeFrom in class AbstractRequestParametersType

withCursorID

public ProcessCursorRequest withCursorID(CursorIDType value)

withActionFunc

public ProcessCursorRequest withActionFunc(Object value)

withActionFuncParam

public ProcessCursorRequest withActionFuncParam(Object value)

withPriority

public ProcessCursorRequest withPriority(int value)