public class VirtualListViewResponseControl extends AbstractControl implements ResponseControl
VirtualListViewResponse ::= SEQUENCE {
targetPosition INTEGER (0 .. maxInt),
contentCount INTEGER (0 .. maxInt),
virtualListViewResult ENUMERATED {
success (0),
operationsError (1),
protocolError (2),
unwillingToPerform (53),
insufficientAccessRights (50),
timeLimitExceeded (3),
adminLimitExceeded (11),
innapropriateMatching (18),
sortControlMissing (60),
offsetRangeError (61),
other(80),
... },
contextID OCTET STRING OPTIONAL }
| Modifier and Type | Class and Description |
|---|---|
private static class |
VirtualListViewResponseControl.ContentCountHandler
Parse handler implementation for the content count.
|
private static class |
VirtualListViewResponseControl.ContextIDHandler
Parse handler implementation for the context ID.
|
private static class |
VirtualListViewResponseControl.TargetPositionHandler
Parse handler implementation for the target position.
|
private static class |
VirtualListViewResponseControl.ViewResultHandler
Parse handler implementation for the view result.
|
| Modifier and Type | Field and Description |
|---|---|
private int |
contentCount
server's estimate of the current number of entries in the ordered search result set.
|
private byte[] |
contextID
value that clients should send back to the server to indicate that the server is willing to return contiguous data
from a subsequent search request which uses the same search criteria.
|
private static int |
HASH_CODE_SEED
hash code seed.
|
static java.lang.String |
OID
OID of this control.
|
private int |
targetPosition
list offset for the target entry.
|
private ResultCode |
viewResult
Result of the vlv operation.
|
logger| Constructor and Description |
|---|
VirtualListViewResponseControl()
Default constructor.
|
VirtualListViewResponseControl(boolean critical)
Creates a new virtual list view response control.
|
VirtualListViewResponseControl(int position,
int count,
ResultCode code,
byte[] context)
Creates a new virtual list view response control.
|
VirtualListViewResponseControl(int position,
int count,
ResultCode code,
byte[] context,
boolean critical)
Creates a new virtual list view response control.
|
| Modifier and Type | Method and Description |
|---|---|
void |
decode(byte[] berValue)
Initializes this response control with the supplied BER encoded data.
|
int |
getContentCount()
Returns the content count.
|
byte[] |
getContextID()
Returns the context id.
|
int |
getTargetPosition()
Returns the target position.
|
ResultCode |
getViewResult()
Returns the result code of the virtual list view.
|
int |
hashCode()
Returns the hash code for this object.
|
void |
setContentCount(int count)
Sets the content count.
|
void |
setContextID(byte[] id)
Sets the context id.
|
void |
setTargetPosition(int position)
Sets the target position.
|
void |
setViewResult(ResultCode code)
Sets the result code of the virtual list view.
|
java.lang.String |
toString() |
equals, getCriticality, getOIDclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetCriticality, getOIDpublic static final java.lang.String OID
private static final int HASH_CODE_SEED
private int targetPosition
private int contentCount
private ResultCode viewResult
private byte[] contextID
public VirtualListViewResponseControl()
public VirtualListViewResponseControl(boolean critical)
critical - whether this control is criticalpublic VirtualListViewResponseControl(int position,
int count,
ResultCode code,
byte[] context)
position - offset for the target entrycount - server estimate of the number of entriescode - operation result codecontext - server context idpublic VirtualListViewResponseControl(int position,
int count,
ResultCode code,
byte[] context,
boolean critical)
position - offset for the target entrycount - server estimate of the number of entriescode - operation result codecontext - server context idcritical - whether this control is criticalpublic int getTargetPosition()
public void setTargetPosition(int position)
position - target positionpublic int getContentCount()
contentCount gives the server's estimate of the current number of entries in the list. Together these give sufficient information for the client to update a list box slider position to match the newly retrieved entries and identify the target entry. The contentCount value returned SHOULD be used in a subsequent VirtualListViewRequest control.
public void setContentCount(int count)
count - content countpublic ResultCode getViewResult()
public void setViewResult(ResultCode code)
code - result codepublic byte[] getContextID()
The contextID is a server-defined octet string. If present, the contents of the contextID field SHOULD be returned to the server by a client in a subsequent virtual list request. The presence of a contextID here indicates that the server is willing to return contiguous data from a subsequent search request which uses the same search criteria, accompanied by a VirtualListViewRequest which indicates that the client wishes to receive an adjoining page of data.
public void setContextID(byte[] id)
id - context idpublic int hashCode()
AbstractControlhashCode in class AbstractControlpublic java.lang.String toString()
toString in class java.lang.Objectpublic void decode(byte[] berValue)
ResponseControldecode in interface ResponseControlberValue - BER encoded response control