|
Esri Geoportal Server 1.0
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.gpt.control.rest.search.SearchStatus
public class SearchStatus
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 |
---|
public static String STATUSTYPE_COMPLETED
public static String STATUSTYPE_FAILED
public static String STATUSTYPE_STOPPED
public static String STATUSTYPE_WORKING
public static String STATUSTYPE_SEARCH_TIMEOUT
Constructor Detail |
---|
public SearchStatus()
Method Detail |
---|
public Timestamp getEndTimestamp()
public void setEndTimestamp(Timestamp endTimestamp)
endTimestamp
- the ending time stamppublic boolean getForceStop()
true
if the process should stoppedpublic void setForceStop(boolean forceStop)
forceStop
- true
if the process should stoppedpublic boolean getHadMatch()
true
if there was a matchpublic void setHadMatch(boolean hadMatch)
hadMatch
- true
if there was a matchpublic long getHitCount()
-1 indicates that a hit count is unavailable.
- Returns:
- the number of hits
public void setHitCount(long hitCount)
-1 indicates that a hit count is unavailable.
- Parameters:
hitCount
- the number of hits
public String getMessage()
public void setMessage(String message)
message
- the new messagepublic String getRid()
public void setRid(String rid)
rid
- the new ridpublic Timestamp getStartTimestamp()
public void setStartTimestamp(Timestamp startTimestamp)
startTimestamp
- the starting time stamppublic String getStatusType()
public void setStatusType(String statusType)
statusType
- the status typepublic boolean isWorking()
true
if the search is working
|
Esri Geoportal Server 1.0
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |