com.esf.core.foundation.service
Interface IEsfFoundationService

All Known Subinterfaces:

IGPSService, INtpService

public interface IEsfFoundationService

The EsfFoundationService has a set of methods to allow for the basic control and operation of an ESF Foundation Bundle. All ESF foundation bundles should implement the EsfFoundationService to provide a consistent means of controlling their operation. Copyright © 2009 Eurotech Inc. All rights reserved.

Field Summary

static java.lang.String

SERVICE_NAME Reports the class name representing this interface.

Method Summary

boolean	isRunning() Check the operational status of any functional operation associated with the implementation.
void	restart() Perform both the action of the stop and the start methods.
void	setPersistent() Store the current configuration (through @IConfigurationManagerService or in the OS as appropriate).
void	start() The start method will start any functional operation associated with the specific implementation.
void	stop() The stop method will stop any functional operation started by the start method.

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Reports the class name representing this interface.

Method Detail

start

void start()
           throws java.lang.Exception

The start method will start any functional operation associated with the specific implementation.

Throws:

java.lang.Exception - start failed (could be missing a configuration).

stop

void stop()
          throws java.lang.Exception

The stop method will stop any functional operation started by the start method.

Throws:

java.lang.Exception - stop failed

restart

void restart()
             throws java.lang.Exception

Perform both the action of the stop and the start methods. If the result of running the isRunning method prior to the call would be false, then restart only performs the same action as the start method.

Throws:

java.lang.Exception - restart failed (could be missing a configuration)

setPersistent

void setPersistent()
                   throws java.lang.Exception

Store the current configuration (through @IConfigurationManagerService or in the OS as appropriate).

Throws:

java.lang.Exception - no current configuration to store

isRunning

boolean isRunning()

Check the operational status of any functional operation associated with the implementation. Following a successful start, this should return true and following a successful stop, this should return false.

Returns:

true if the functional part of the implementation is running false if the functional part of the implementation is not running