public class

MWSFindInfo

extends Object
java.lang.Object
   ↳ com.microstrategy.webservices.MWSFindInfo

Class Overview

This class is used to return incremental find request results/status to the incremental find code located in the web service front-end.

Summary

Public Constructors
MWSFindInfo()
Public Methods
ArrayOfMWSObjectInfo getArrayObjectInfo()
Gets the array of found objects for this increment.
int getResultSize()
Returns the total number of found objects, of all increments, to be returned from the search.
String getSearchID()
Returns the ID used by the IServer to identify an asynchronous search.
boolean isCancelled()
Returns whether the current find (search) has been cancelled or not.
boolean isFindDone()
Returns whether the find (search) has been completed.
boolean isIncrementsDone()
Returns whether the current returned find (search) results increment is the last one or not.
void setArrayObjectInfo(ArrayOfMWSObjectInfo arrayObjectInfo)
Sets the arrayObjectInfo member.
void setCancelled(boolean cancelled)
Sets the cancelled member.
void setFindDone(boolean findDone)
Sets the findDone member.
void setIncrementsDone(boolean incrementsDone)
Sets the incrementsDone member.
void setResultSize(int searchResultSize)
Sets the resultSize member.
void setSearchID(String sSearchID)
Sets the searchID member.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MWSFindInfo ()

Public Methods

public ArrayOfMWSObjectInfo getArrayObjectInfo ()

Gets the array of found objects for this increment.

Returns
  • Array of found objects.

public int getResultSize ()

Returns the total number of found objects, of all increments, to be returned from the search.

Returns
  • The total number of found objects.

public String getSearchID ()

Returns the ID used by the IServer to identify an asynchronous search. This is retrieved and passed back by the web service front-end when retrieving subsequent incremental find results.

Returns
  • Search identifier.

public boolean isCancelled ()

Returns whether the current find (search) has been cancelled or not. The web service front-end uses this boolean to determine when to cancel find results processing and return a cancel status to the client.

Returns
  • True if find has been cancelled.

public boolean isFindDone ()

Returns whether the find (search) has been completed. The web service front-end uses this boolean to determine when to stop polling for the find results.

Returns
  • True if find results are ready.

public boolean isIncrementsDone ()

Returns whether the current returned find (search) results increment is the last one or not. The web service front-end uses this boolean to determine when to stop retrieving results, and then returns results to the client.

Returns
  • True if this is the last increment.

public void setArrayObjectInfo (ArrayOfMWSObjectInfo arrayObjectInfo)

Sets the arrayObjectInfo member. The Java web service incremental find code collects an increment of found objects and stores the array here.

Parameters
arrayObjectInfo Array of found objects.

public void setCancelled (boolean cancelled)

Sets the cancelled member. The Java web service incremental find code sets this value to true when the WebAPIErrorCodes value of MSI_INBOX_MSG_NOT_FOUND returns from the WebSearch.

Parameters
cancelled True if find has been cancelled.

public void setFindDone (boolean findDone)

Sets the findDone member. The Java web service incremental find code sets this value to true when results are ready.

Parameters
findDone True if find results are ready.

public void setIncrementsDone (boolean incrementsDone)

Sets the incrementsDone member. The Java web service incremental find code sets this value to true when it determines that all found objects have been retrieved.

Parameters
incrementsDone True if this is the last increment.

public void setResultSize (int searchResultSize)

Sets the resultSize member. The Java web service incremental find code sets this value for return to the web service front-end.

Parameters
searchResultSize The total number of found objects

public void setSearchID (String sSearchID)

Sets the searchID member. The Java web service incremental find code sets this value for return to the web service front-end.

Parameters
sSearchID Search identifier.