org.cmis.interopserver.services.nwem
Interface NWEM

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

NWEMSoapBindingImpl, NWEMSoapBindingSkeleton

public interface NWEM
extends java.rmi.Remote

The NWEM interface for posting and retrieving alerts. Please note that the smallest unit used for time calculation is a second.

Author:

interop team

Method Summary

org.cmis.interopserver.beans.cap1_1.Alert	getAlert(java.lang.String in0) Gets the Alert that corresponds to the unique identifier.
org.cmis.interopserver.beans.cap1_1.Alert[]	getAlertsByPostedDate(java.util.Calendar in0) Gets all alerts (NWEM messages and non-NWEM messages) posted after the user sepecified time.
org.cmis.interopserver.beans.cap1_1.Alert[]	getAlertsBySentDate(java.util.Calendar in0) Gets all alerts (NWEM messages and non-NWEM messages) those sent fields are later than the last update time.
java.lang.String	getHCSMode() Returns the current operation mode for HazCollect Server.
org.cmis.interopserver.beans.SimpleCOG	getMyCog() Gets the SimpleCOG of the caller
gov.noaa.nws.hazcollect.support.view.CogGeoFipsCodeImpl[]	getNWEMAuxData(java.lang.String in0) Returns all the county FIP codes, county names, FIP county or Zone indicators, state codes, zone codes, ane zone names authorized for user's COG.
java.util.Calendar	getServerTime()
boolean	isCogAuthorized(java.lang.String in0)
java.lang.String	ping() This method takes no parameters and returns only "pong" indicating success.
void	postNWEM(org.cmis.interopserver.beans.cap1_1.Alert in0, java.lang.String in1, org.cmis.interopserver.beans.SimpleCOG[] in2) This method first sends the NWEM message to the HazCollect Server to be broadcast.

Method Detail

getAlert

org.cmis.interopserver.beans.cap1_1.Alert getAlert(java.lang.String in0)
                                                   throws java.rmi.RemoteException

Gets the Alert that corresponds to the unique identifier. The unique identifier consists of the sender field of the CAP 1.1 object, a colon, and the identifier field of the CAP 1.1 object. A null value will be returned if unique identifier cannot be found.

Parameters:

in0 - String -> unique identifier

Returns:

Alert

Throws:

RemoteException

getAlertsBySentDate

org.cmis.interopserver.beans.cap1_1.Alert[] getAlertsBySentDate(java.util.Calendar in0)
                                                                throws java.rmi.RemoteException

Gets all alerts (NWEM messages and non-NWEM messages) those sent fields are later than the last update time. Please note the smallest unit of time used for calculation is a second.

Parameters:

in0 - Calendar -> last update time

Returns:

Alert[] -> all alerts those sent fields are later than the last update time

Throws:

RemoteException

getServerTime

java.util.Calendar getServerTime()
                                 throws java.rmi.RemoteException

Returns:

Calendar -> current time of the server

Throws:

RemoteException

postNWEM

void postNWEM(org.cmis.interopserver.beans.cap1_1.Alert in0,
              java.lang.String in1,
              org.cmis.interopserver.beans.SimpleCOG[] in2)
              throws java.rmi.RemoteException

This method first sends the NWEM message to the HazCollect Server to be broadcast. After HazCollect Server broadcasts the messaage, the message will be posted to the DMIS COGs. Only valid NWEM messages can be posted to the HazCollect Server. For details on NWEM messages please refer to the HazCollect System Dataflow Analysis document.

Parameters:

in0 - Alert -> NWEM message to be posted to HazCollect Server

in1 - String -> time zone of the sender

in2 - SimpleCOG[] -> a list of DMIS COGs to post to

Throws:

RemoteException

getMyCog

org.cmis.interopserver.beans.SimpleCOG getMyCog()
                                                throws java.rmi.RemoteException

Gets the SimpleCOG of the caller

Returns:

SimpleCOG

Throws:

RemoteException

ping

java.lang.String ping()
                      throws java.rmi.RemoteException

This method takes no parameters and returns only "pong" indicating success. It is used simply to verify that the service is up and running and user is authenticated.

Returns:

String

Throws:

RemoteException

getAlertsByPostedDate

org.cmis.interopserver.beans.cap1_1.Alert[] getAlertsByPostedDate(java.util.Calendar in0)
                                                                  throws java.rmi.RemoteException

Gets all alerts (NWEM messages and non-NWEM messages) posted after the user sepecified time.

Parameters:

in0 - Calendar -> user specified time

Returns:

Alert[] -> all alerts posted after the user sepecified time

Throws:

RemoteException

getHCSMode

java.lang.String getHCSMode()
                            throws java.rmi.RemoteException

Returns the current operation mode for HazCollect Server. Please refer to the HazCollect System Dataflow Analysis document for details on HazCollect operation modes and message dissemination.

Returns:

String -> current operation mode of HazCollect Server

Throws:

RemoteException

isCogAuthorized

boolean isCogAuthorized(java.lang.String in0)
                        throws java.rmi.RemoteException

Parameters:

in0 - String -> COG id

Throws:

RemoteException

getNWEMAuxData

gov.noaa.nws.hazcollect.support.view.CogGeoFipsCodeImpl[] getNWEMAuxData(java.lang.String in0)
                                                                         throws java.rmi.RemoteException

Returns all the county FIP codes, county names, FIP county or Zone indicators, state codes, zone codes, ane zone names authorized for user's COG. Please see section 6 (Auxiliary Data), of the HazCollect System Dataflow Analysis document.

Parameters:

in0 - String -> COG id

Returns:

CogGeoFipsCodeImpl[]

Throws:

RemoteException