Esri Geoportal Server
1.0

com.esri.gpt.control.rest.search
Class SearchStatus

java.lang.Object
  extended by com.esri.gpt.control.rest.search.SearchStatus

public class SearchStatus
extends Object

Search status.


Field Summary
static String STATUSTYPE_COMPLETED
          The search completed successfully (= "completed")
static String STATUSTYPE_FAILED
          The search failed (= "failed")
static String STATUSTYPE_SEARCH_TIMEOUT
          Set when the search times out
static String STATUSTYPE_STOPPED
          The search was stopped (= "stopped")
static String STATUSTYPE_WORKING
          The search is in progress (= "working")
 
Constructor Summary
SearchStatus()
          Default constructor.
 
Method Summary
 Timestamp getEndTimestamp()
          Gets the ending time stamp.
 boolean getForceStop()
          Gets the flag indicating whether or not the process should be forceably stopped.
 boolean getHadMatch()
          Gets the flag indicating whether or not the searchable endpoint had a match.
 long getHitCount()
          Gets the number of hits.
 String getMessage()
          Gets the message.
 String getRid()
          Gets the rid.
 Timestamp getStartTimestamp()
          Gets the starting time stamp.
 String getStatusType()
          Gets the status type.
 boolean isWorking()
          Determines if the search is in a working state.
 void setEndTimestamp(Timestamp endTimestamp)
          Sets the ending time stamp.
 void setForceStop(boolean forceStop)
          Sets the flag indicating whether or not the process should be forceably stopped.
 void setHadMatch(boolean hadMatch)
          Sets the flag indicating whether or not the searchable endpoint had a match.
 void setHitCount(long hitCount)
          Sets the number of hits.
 void setMessage(String message)
          Sets the message.
 void setRid(String rid)
          Sets the rid.
 void setStartTimestamp(Timestamp startTimestamp)
          Sets the starting time stamp.
 void setStatusType(String statusType)
          Sets the status type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STATUSTYPE_COMPLETED

public static String STATUSTYPE_COMPLETED
The search completed successfully (= "completed")


STATUSTYPE_FAILED

public static String STATUSTYPE_FAILED
The search failed (= "failed")


STATUSTYPE_STOPPED

public static String STATUSTYPE_STOPPED
The search was stopped (= "stopped")


STATUSTYPE_WORKING

public static String STATUSTYPE_WORKING
The search is in progress (= "working")


STATUSTYPE_SEARCH_TIMEOUT

public static String STATUSTYPE_SEARCH_TIMEOUT
Set when the search times out

Constructor Detail

SearchStatus

public SearchStatus()
Default constructor.

Method Detail

getEndTimestamp

public Timestamp getEndTimestamp()
Gets the ending time stamp.

Returns:
the ending time stamp

setEndTimestamp

public void setEndTimestamp(Timestamp endTimestamp)
Sets the ending time stamp.

Parameters:
endTimestamp - the ending time stamp

getForceStop

public boolean getForceStop()
Gets the flag indicating whether or not the process should be forceably stopped.

Returns:
true if the process should stopped

setForceStop

public void setForceStop(boolean forceStop)
Sets the flag indicating whether or not the process should be forceably stopped.

Parameters:
forceStop - true if the process should stopped

getHadMatch

public boolean getHadMatch()
Gets the flag indicating whether or not the searchable endpoint had a match.

Returns:
true if there was a match

setHadMatch

public void setHadMatch(boolean hadMatch)
Sets the flag indicating whether or not the searchable endpoint had a match.

Parameters:
hadMatch - true if there was a match

getHitCount

public long getHitCount()
Gets the number of hits. A count of -1 indicates that a hit count is unavailable.

Returns:
the number of hits

setHitCount

public void setHitCount(long hitCount)
Sets the number of hits. A count of -1 indicates that a hit count is unavailable.

Parameters:
hitCount - the number of hits

getMessage

public String getMessage()
Gets the message.

Returns:
the message (trimmed, never null)

setMessage

public void setMessage(String message)
Sets the message.

Parameters:
message - the new message

getRid

public String getRid()
Gets the rid.

Returns:
the rid (trimmed, never null)

setRid

public void setRid(String rid)
Sets the rid.

Parameters:
rid - the new rid

getStartTimestamp

public Timestamp getStartTimestamp()
Gets the starting time stamp.

Returns:
the starting time stamp

setStartTimestamp

public void setStartTimestamp(Timestamp startTimestamp)
Sets the starting time stamp.

Parameters:
startTimestamp - the starting time stamp

getStatusType

public String getStatusType()
Gets the status type.

Returns:
the status type

setStatusType

public void setStatusType(String statusType)
Sets the status type.

Parameters:
statusType - the status type

isWorking

public boolean isWorking()
Determines if the search is in a working state.

Returns:
true if the search is working

Esri Geoportal Server
1.0

Copyright 2011 Environmental Systems Research Institute. All rights reserved. Use is subject to license terms.