org.cmis.interopserver.services.cap1_1
Interface CAP1_1

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

CAP1_1SoapBindingImpl, CAP1_1SoapBindingSkeleton

public interface CAP1_1
extends java.rmi.Remote

The CAP 1.1 interface for posting and retrieving CAP 1.1 alerts.

Title: Interoperability CAP 1.1

Description: The CAP 1.1 interface for posting and retrieving CAP 1.1 alerts.

Copyright: Copyright (c) 2006

Company: Battelle

Version:

1.0

Author:

Liu C.

Method Summary

org.cmis.interopserver.beans.cap1_1.Alert[]	getAlertsSentByPostedDate(java.util.Calendar in0) Gets all Alerts sent by the caller since the given date-time, exclusive.
org.cmis.interopserver.beans.cap1_1.Alert[]	getAlertsSentBySentDate(java.util.Calendar in0) Gets all Alerts sent by the caller since the given date-time, exclusive.
org.cmis.interopserver.beans.cap1_1.Alert	getCAPAlert(java.lang.String in0) Gets the Alert that corresponds to this identifier.
org.cmis.interopserver.beans.cap1_1.Alert[]	getCAPAlerts(java.util.Calendar in0) Gets all Alerts since the given date-time, exclusive.
org.cmis.interopserver.beans.cap1_1.Alert[]	getCAPAlertsByPostedDate(java.util.Calendar in0) Gets all Alerts since the given date-time, exclusive.
org.cmis.interopserver.beans.cap1_1.Alert[]	getCAPAlertsGlobalByPostedDate(java.util.Calendar in0) Gets all Alerts globally posted across the system since the given date-time, exclusive..
org.cmis.interopserver.beans.cap1_1.Alert[]	getCAPAlertsGlobalBySentDate(java.util.Calendar in0) Gets all Alerts globally posted across the system since the given date-time, exclusive..
org.cmis.interopserver.beans.SimpleCOG[]	getCogs() Gets a list of valid SimpleCOGs that includes all possible COGs for a post operation such as postCAPAlert() or postIncident().
org.cmis.interopserver.beans.SimpleCOG	getMyCog() Gets the SimpleCOG of the caller
org.cmis.interopserver.beans.cap1_1.Alert[]	getMyCogsAlertsByPostedDate(java.util.Calendar in0) Gets all Alerts posted to the caller since the given date-time, exclusive.
org.cmis.interopserver.beans.cap1_1.Alert[]	getMyCogsAlertsBySentDate(java.util.Calendar in0) Gets all Alerts posted to the caller since the given date-time, exclusive.
java.util.Calendar	getServerTime() Retrieves the current time on the server; useful for time-synching to ensure that getCAPAlertsByPostedDate() is accurate.
java.lang.String	ping() This method takes no parameters and returns only "pong" indicating success.
void	postCAPAlert(org.cmis.interopserver.beans.cap1_1.Alert alert) Posts this Alert globally across the system.
void	postCAPAlert(org.cmis.interopserver.beans.cap1_1.Alert in0, org.cmis.interopserver.beans.SimpleCOG[] in1) Posts this Alert to the specified list of COGs.

Method Detail

getCAPAlert

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

Gets the Alert that corresponds to this identifier. Since the CAP identifier is unique only for a particular sender, to retrieve a particular CAP alert, concatenate the CAP sender, a colon, and the CAP identifier to use as the "messageId". If the "messageid" does not correspond to a CAP Alert in the DMIS system, an empty value (NULL), will be returned.

Parameters:

in0 - String -> messageId (cap sender):(cap identifier)

Returns:

Alert -> Alert that corresponds to this identifier

Throws:

java.rmi.RemoteException

getCAPAlerts

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

Gets all Alerts since the given date-time, exclusive. This includes Alerts that have been posted directly to the caller's COG, Alerts sent by the caller, as well as those that have been posted globally. The Alerts are returned in chronological order, from newest to oldest. If the date is invalid, an error is returned. If there are no alerts since that date-time, an empty list is returned.

Parameters:

in0 - Calendar -> a date-time cutoff for retrieving posted events, please note this value is being compared to the Sent field in the Alert

Returns:

Alert[] -> An array of Alerts since the given date-time.

Throws:

java.rmi.RemoteException

getServerTime

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

Retrieves the current time on the server; useful for time-synching to ensure that getCAPAlertsByPostedDate() is accurate. Note that current server time is also returned as a SOAP header with each request; this method is here only for convenience.

Returns:

Calendar -> current application server time

Throws:

java.rmi.RemoteException

postCAPAlert

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

Posts this Alert to the specified list of COGs. Once posted, the Alert will be accessible to users of any of the COGs on that list, as well as the sender's COG. This is semantically identical to using postCAPAlert(Alert) with a Private scope and COG ids specified in the address field as described above. This method will ignore the address and scope fields of the Alert and post it only to the COGs specified in the array of SimpleCOG objects supplied. If any of the COGs specified in the COG array are invalid, an error will be returned and no posting will take place. The same is true if there are duplicates in the COG array, or if the sender's COG is specified in the COG array. This method does not return anything; if no error is returned then the posting has succeeded.

Parameters:

in0 - Alert -> CAP Alert to be posted

in1 - SimpleCOG[] -> a list of COGs to post the CAP Alert

Throws:

java.rmi.RemoteException

postCAPAlert

void postCAPAlert(org.cmis.interopserver.beans.cap1_1.Alert alert)
                  throws java.rmi.RemoteException

Posts this Alert globally across the system. Once posted, the Alert will be accessible by users of all COGs (including the sender's) via the "getCAPAlert" methods, with the following exception: If the value of the Alert's Alert.scope field is "Private" and the org.cmis.interopserver.beans.cap.Alert#address field contains a space-delimited series COGs in the form "COGx" where x is a valid COG SimpleCOG.id (for example, COG1737 COG1000 COG2) then the Alert will be posted to only those specified COGs. If any of the COG ids are invalid, an error will be returned and no posting will take place. In any other case, the Alert will be posted globally across the DMIS system (to all COGs). This method does not return anything; if no error is returned then the posting has succeeded.

Parameters:

alert - Alert to be posted.

Throws:

java.rmi.RemoteException - A remote exception occurred

getCogs

org.cmis.interopserver.beans.SimpleCOG[] getCogs()
                                                 throws java.rmi.RemoteException

Gets a list of valid SimpleCOGs that includes all possible COGs for a post operation such as postCAPAlert() or postIncident(). All COGs EXCEPT the operator's COG will be returned.

Returns:

a list of valid SimpleCOGs

Throws:

java.rmi.RemoteException - An exception occurred remotely

getMyCog

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

Gets the SimpleCOG of the caller

Returns:

The SimpleCOG of the caller

Throws:

java.rmi.RemoteException - An exception occurred remotely

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 "pong"

Throws:

java.rmi.RemoteException - An exception occurred remotely

getCAPAlertsByPostedDate

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

Gets all Alerts since the given date-time, exclusive. This method is almost identical to getCAPAlerts(Calendar) except that the date-time value is being compared to the actual time that Alert is posted to the DMIS server instead of the sent field in the Alert.

Parameters:

in0 - Calendar --> a date-time cutoff for retrieving posted events, please note this value is being compared to the actual time that Alert is posted to the DMIS server.

Returns:

Alert[] --> An array of Alerts since the given date-time.

Throws:

java.rmi.RemoteException

getCAPAlertsGlobalBySentDate

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

Gets all Alerts globally posted across the system since the given date-time, exclusive.. If there are no alerts posted globally, an empty list is returned.

Parameters:

in0 - Calendar --> value being compared to the sent field

Returns:

Alert[] --> An array of Alerts posted globally.

Throws:

java.rmi.RemoteException

getCAPAlertsGlobalByPostedDate

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

Gets all Alerts globally posted across the system since the given date-time, exclusive.. If there are no alerts posted globally, an empty list is returned.

Parameters:

in0 - Calendar --> value being compared to the actual time Alert is being posted to DMIS.

Returns:

Alert[] --> An array of Alerts posted globally.

Throws:

java.rmi.RemoteException

getMyCogsAlertsByPostedDate

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

Gets all Alerts posted to the caller since the given date-time, exclusive. The Alerts are returned in chronological order, from newest to oldest. If the date is invalid, an error is returned. If there are no alerts since that date-time, an empty list is returned.

Parameters:

in0 - Calendar --> date-time value being compared to the time each Alert is being posted to the DMIS system.

Returns:

Alert[] --> An array of Alerts posted to the caller since the given date.

Throws:

java.rmi.RemoteException

getMyCogsAlertsBySentDate

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

Gets all Alerts posted to the caller since the given date-time, exclusive. The Alerts are returned in chronological order, from newest to oldest. If the date is invalid, an error is returned. If there are no alerts since that date-time, an empty list is returned.

Parameters:

in0 - Calendar --> date-time value being compared to the Alert's sent field Alert is being posted to the DMIS system.

Returns:

Alert[] --> An array of Alerts posted to the caller since the given date

Throws:

java.rmi.RemoteException

getAlertsSentBySentDate

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

Gets all Alerts sent by the caller since the given date-time, exclusive. The Alerts are returned in chronological order, from newest to oldest. If the date is invalid, an error is returned. If there are no alerts sent since that date-time, an empty list is returned.

Parameters:

in0 - Calendar --> date-time value being compared to each Alert's sent filed of each Alert

Returns:

Alert[] --> An array of Alerts sent by the caller.

Throws:

java.rmi.RemoteException

getAlertsSentByPostedDate

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

Gets all Alerts sent by the caller since the given date-time, exclusive. The Alerts are returned in chronological order, from newest to oldest. If the date is invalid, an error is returned. If there are no alerts sent since that date-time, an empty list is returned.

Parameters:

in0 - Calendar --> date-time value being compared to the time each Alert is being posted to the DMIS system.

Returns:

Alert[] --> An array of Alerts sent by the caller.

Throws:

java.rmi.RemoteException