jreceiver.common.rpc
Interface Scanner

All Superinterfaces:
RpcBase

public interface Scanner
extends RpcBase

Scanner-related control and queries for a (possibly-remote) JRec server

Version:
$Revision: 1.3 $ $Date: 2002/12/29 00:44:08 $
Author:
Reed Esau

Field Summary
static java.lang.String CLEAR
           
static java.lang.String GET_SCHEDULE
           
static java.lang.String GET_STATE
           
static java.lang.String HANDLER_NAME
           
static java.lang.String INTERRUPT
           
static java.lang.String INVOKE
           
static java.lang.String SCANNER_STATE_STARTED
           
static java.lang.String SCANNER_STATE_STOPPED
           
static java.lang.String SCANNER_STATE_UNKNOWN
           
static java.lang.String SCHEDULE
           
 
Fields inherited from interface jreceiver.common.rpc.RpcBase
DETECT
 
Method Summary
 java.lang.String clear()
          purge the database of all scanned data
 java.util.Date getSchedule()
          obtain the next time a scan will commence
 java.lang.String getState()
          obtain the current scanner state
 void interrupt()
          stop the scanner, if running
 void invoke()
          start the scanner, if not started
 void schedule()
          tell the scanner to update its schedule
 
Methods inherited from interface jreceiver.common.rpc.RpcBase
detect
 

Field Detail

SCANNER_STATE_STARTED

public static final java.lang.String SCANNER_STATE_STARTED

SCANNER_STATE_STOPPED

public static final java.lang.String SCANNER_STATE_STOPPED

SCANNER_STATE_UNKNOWN

public static final java.lang.String SCANNER_STATE_UNKNOWN

HANDLER_NAME

public static final java.lang.String HANDLER_NAME

INVOKE

public static final java.lang.String INVOKE

INTERRUPT

public static final java.lang.String INTERRUPT

GET_SCHEDULE

public static final java.lang.String GET_SCHEDULE

SCHEDULE

public static final java.lang.String SCHEDULE

CLEAR

public static final java.lang.String CLEAR

GET_STATE

public static final java.lang.String GET_STATE
Method Detail

invoke

public void invoke()
            throws RpcException
start the scanner, if not started
Throws:
RpcException -  

interrupt

public void interrupt()
               throws RpcException
stop the scanner, if running
Throws:
RpcException -  

getSchedule

public java.util.Date getSchedule()
                           throws RpcException
obtain the next time a scan will commence
Returns:
 
Throws:
RpcException -  

schedule

public void schedule()
              throws RpcException
tell the scanner to update its schedule
Throws:
RpcException -  

clear

public java.lang.String clear()
                       throws RpcException
purge the database of all scanned data
Returns:
 
Throws:
RpcException -  

getState

public java.lang.String getState()
                          throws RpcException
obtain the current scanner state
Returns:
 
Throws:
RpcException -  


Copyright © 2001-2002 Reed Esau, All Rights Reserved.