Oracle Application Server Wireless Java API Reference
B10400-01

oracle.panama.portal
Class AlertController

java.lang.Object
  |
  +--oracle.panama.portal.ServiceController
        |
        +--oracle.panama.portal.AlertController
All Implemented Interfaces:
java.io.Serializable

Deprecated.

 As of 2.0, replaced by AlertSubscriptionController

public class AlertController
extends ServiceController
implements java.io.Serializable

AlertController handles alert/alertAddress related operations, such as retrieving/updating parameters of a alert/alertAddress, creating/deleting a alert/alertAddres.

See Also:
Serialized Form

Field Summary
static java.lang.String ALERTADDRESS
          Deprecated. Key for retrieving alert address value from the alert parameter Hashtable passing to/from the portal pages.
static java.lang.String ALERTADDRESSADDRESS
          Deprecated. Key for retrieving address value from the alert address parameter Hashtable passing to/from the portal pages.
static java.lang.String ALERTADDRESSDEFAULT
          Deprecated. Key for retrieving is-default value from the alert address parameter Hashtable passing to/from the portal pages.
static java.lang.String ALERTADDRESSDEVICE
          Deprecated. Key for retrieving address device value from the alert address parameter Hashtable passing to/from the portal pages.
static java.lang.String ALERTADDRESSNAME
          Deprecated. Key for retrieving name value from the alert address parameter Hashtable passing to/from the portal pages.
static java.lang.String ALERTFREQDAY
          Deprecated. Key for retrieving frequency-day value from the alert parameter Hashtable passing to/from the portal pages.
static java.lang.String ALERTFREQTYPE
          Deprecated. Key for retrieving frequency type value from the alert parameter Hashtable passing to/from the portal pages.
static java.lang.String ALERTFREQTYPEDAY
          Deprecated. frequency-day option constant used in request URLs.
static java.lang.String ALERTFREQTYPEUNIT
          Deprecated. frequency-unit option constant used in request URLs.
static java.lang.String ALERTFREQUNIT
          Deprecated. Key for retrieving frequency-unit value from the alert parameter Hashtable passing to/from the portal pages.
static java.lang.String ALERTFREQVALUE
          Deprecated. Key for retrieving frequency-value value from the alert parameter Hashtable passing to/from the portal pages.
static java.lang.String ALERTNAME
          Deprecated. Key for retrieving name value from the alert parameter Hashtable passing to/from the portal pages.
static java.lang.String DATE
          Deprecated. Key for retrieving date value from the alert time parameter Hashtable passing to/from the portal pages.
static java.lang.String EVERYDAY
          Deprecated. everyday option constant used in request URLs.
static java.lang.String FRIDAY
          Deprecated. Friday option constant used in request URLs.
static java.lang.String HOUR
          Deprecated. Key for retrieving hour value from the alert time parameter Hashtable passing to/from the portal pages.
static java.lang.String MINUTE
          Deprecated. Key for retrieving minute value from the alert time parameter Hashtable passing to/from the portal pages.
static java.lang.String MONDAY
          Deprecated. Monday option constant used in request URLs.
static java.lang.String MONTH
          Deprecated. Key for retrieving month value from the alert time parameter Hashtable passing to/from the portal pages.
static java.lang.String ONCEWEEK
          Deprecated. onceweek option constant used in request URLs.
static java.lang.String SATURDAY
          Deprecated. Saturday option constant used in request URLs.
static java.lang.String SECOND
          Deprecated. Key for retrieving second value from the alert time parameter Hashtable passing to/from the portal pages.
static java.lang.String SUNDAY
          Deprecated. Sunday option constant used in request URLs.
static java.lang.String THURSDAY
          Deprecated. Thursday option constant used in request URLs.
static java.lang.String TUESDAY
          Deprecated. Tuesday option constant used in request URLs.
static java.lang.String WEDNESDAY
          Deprecated. Wednesday option constant used in request URLs.
static java.lang.String WEEKDAY
          Deprecated. weekday option constant used in request URLs.
static java.lang.String WEEKEND
          Deprecated. weekend option constant used in request URLs.
static java.lang.String YEAR
          Deprecated. Key for retrieving year value from the alert time parameter Hashtable passing to/from the portal pages.

 

Fields inherited from class oracle.panama.portal.ServiceController
BOOKMARKURL, CHILDRENORDER, CONTAIN, EQUAL, GREATER, LESS, SERVICEFOLDER, SERVICENAME, SORTRULE, VIEWPROFILE, VISIBLE

 

Method Summary
 Alert createNewAlert(java.lang.String name, long serviceId, java.lang.String addressIdString, Request apiRequest)
          Deprecated.  
 AlertAddress createNewAlertAddress(java.lang.String name, java.lang.String address, java.lang.String deviceIdString, Request apiRequest)
          Deprecated.  
 void deleteAlertAddress(long alertAddressId)
          Deprecated.  
 AlertAddress[] getAlertAddresses(long alertId)
          Deprecated.  
 java.lang.String getAlertFreqDay(long alertId)
          Deprecated.  
 java.lang.String getAlertFreqDay(long alertId, Request apiRequest)
          Deprecated.  
 java.lang.String getAlertFreqType(long alertId)
          Deprecated.  
 java.lang.String getAlertFreqUnit(long alertId)
          Deprecated.  
 java.lang.String getAlertFreqValue(long alertId)
          Deprecated.  
static AlertController getAlertInstance()
          Deprecated.  
 java.util.Hashtable getAlertStartTime(long alertId)
          Deprecated.  
 java.util.Hashtable getAlertStartTime(long alertId, Request apiRequest)
          Deprecated.  
 Device[] getAllDevices()
          Deprecated.  
 java.util.Hashtable getCurrentTimeHash()
          Deprecated.  
 java.util.Hashtable getCurrentTimeHash(Request apiRequest)
          Deprecated.  
 boolean isAlert(long objectId)
          Deprecated.  
 void setAddressParameters(long alertAddressId, java.util.Hashtable paramHash)
          Deprecated.  
 void setParameters(long alertId, java.util.Hashtable paramHash)
          Deprecated.  
 void setTimeParameters(long alertId, java.util.Hashtable paramHash)
          Deprecated.  
 void setTimeParameters(long alertId, java.util.Hashtable paramHash, Request apiRequest)
          Deprecated.  

 

Methods inherited from class oracle.panama.portal.ServiceController
copyService, copyService, createNewBookmark, createNewBookmark, createNewFolder, createNewFolder, deleteService, deployServiceToGroup, deployServiceToUser, getAccessCount, getAllSortRules, getChildren, getCurrentService, getExternalURL, getInputArguments, getInputArgumentsArray, getLastAccessDate, getOutputArguments, getOutputArgumentsArray, getRootServices, getSequenceNo, getServiceInstance, getServicePathNodes, getSortedChildren, getSortRule, getSortRuleHeader  

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

WEEKDAY

public static final java.lang.String WEEKDAY
Deprecated. 
weekday option constant used in request URLs.
See Also:
Constant Field Values

WEEKEND

public static final java.lang.String WEEKEND
Deprecated. 
weekend option constant used in request URLs.
See Also:
Constant Field Values

EVERYDAY

public static final java.lang.String EVERYDAY
Deprecated. 
everyday option constant used in request URLs.
See Also:
Constant Field Values

ONCEWEEK

public static final java.lang.String ONCEWEEK
Deprecated. 
onceweek option constant used in request URLs.
See Also:
Constant Field Values

DATE

public static final java.lang.String DATE
Deprecated. 
Key for retrieving date value from the alert time parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

MONTH

public static final java.lang.String MONTH
Deprecated. 
Key for retrieving month value from the alert time parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

YEAR

public static final java.lang.String YEAR
Deprecated. 
Key for retrieving year value from the alert time parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

HOUR

public static final java.lang.String HOUR
Deprecated. 
Key for retrieving hour value from the alert time parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

MINUTE

public static final java.lang.String MINUTE
Deprecated. 
Key for retrieving minute value from the alert time parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

SECOND

public static final java.lang.String SECOND
Deprecated. 
Key for retrieving second value from the alert time parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

MONDAY

public static final java.lang.String MONDAY
Deprecated. 
Monday option constant used in request URLs.

TUESDAY

public static final java.lang.String TUESDAY
Deprecated. 
Tuesday option constant used in request URLs.

WEDNESDAY

public static final java.lang.String WEDNESDAY
Deprecated. 
Wednesday option constant used in request URLs.

THURSDAY

public static final java.lang.String THURSDAY
Deprecated. 
Thursday option constant used in request URLs.

FRIDAY

public static final java.lang.String FRIDAY
Deprecated. 
Friday option constant used in request URLs.

SATURDAY

public static final java.lang.String SATURDAY
Deprecated. 
Saturday option constant used in request URLs.

SUNDAY

public static final java.lang.String SUNDAY
Deprecated. 
Sunday option constant used in request URLs.

ALERTNAME

public static final java.lang.String ALERTNAME
Deprecated. 
Key for retrieving name value from the alert parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

ALERTADDRESS

public static final java.lang.String ALERTADDRESS
Deprecated. 
Key for retrieving alert address value from the alert parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

ALERTFREQTYPE

public static final java.lang.String ALERTFREQTYPE
Deprecated. 
Key for retrieving frequency type value from the alert parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

ALERTFREQDAY

public static final java.lang.String ALERTFREQDAY
Deprecated. 
Key for retrieving frequency-day value from the alert parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

ALERTFREQVALUE

public static final java.lang.String ALERTFREQVALUE
Deprecated. 
Key for retrieving frequency-value value from the alert parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

ALERTFREQUNIT

public static final java.lang.String ALERTFREQUNIT
Deprecated. 
Key for retrieving frequency-unit value from the alert parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

ALERTFREQTYPEDAY

public static final java.lang.String ALERTFREQTYPEDAY
Deprecated. 
frequency-day option constant used in request URLs.
See Also:
Constant Field Values

ALERTFREQTYPEUNIT

public static final java.lang.String ALERTFREQTYPEUNIT
Deprecated. 
frequency-unit option constant used in request URLs.
See Also:
Constant Field Values

ALERTADDRESSNAME

public static final java.lang.String ALERTADDRESSNAME
Deprecated. 
Key for retrieving name value from the alert address parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

ALERTADDRESSADDRESS

public static final java.lang.String ALERTADDRESSADDRESS
Deprecated. 
Key for retrieving address value from the alert address parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

ALERTADDRESSDEVICE

public static final java.lang.String ALERTADDRESSDEVICE
Deprecated. 
Key for retrieving address device value from the alert address parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values

ALERTADDRESSDEFAULT

public static final java.lang.String ALERTADDRESSDEFAULT
Deprecated. 
Key for retrieving is-default value from the alert address parameter Hashtable passing to/from the portal pages.
See Also:
Constant Field Values
Method Detail

getAlertInstance

public static AlertController getAlertInstance()
Deprecated.  
The singleton thread-safe getter.
Returns:
the AlertController singleton interface.

isAlert

public boolean isAlert(long objectId)
Deprecated.  
check to see whether the object is an alert.
Parameters:
objectId - queried object ID.
Returns:
true if the service is an alert.

getAlertAddresses

public AlertAddress[] getAlertAddresses(long alertId)
                                 throws PortalException
Deprecated.  
get alert addresses of an alert.
Parameters:
alertId - queried Alert ID.
Returns:
AlertAddress array of the alert.
PortalException

getAlertFreqType

public java.lang.String getAlertFreqType(long alertId)
                                  throws PortalException
Deprecated.  
get freq type of an alert.
Parameters:
alertId - queried alert ID.
Returns:
String constant to identify whether frequency is based on day level or using any time unit such as year, month, day, munite. ALERTFREQTYPEDAY represents for selecting a day of the week, while ALERTFREQTYPEUNIT represents selecting an time unit.
PortalException

getAlertFreqDay

public java.lang.String getAlertFreqDay(long alertId)
                                 throws PortalException
Deprecated.  
get frequency-day value of an alert.
Parameters:
alertId - queried Alert ID.
Returns:
String constant representing frequency-day value, empty String if not ALERTFREQTYPEDAY.
PortalException

getAlertFreqDay

public java.lang.String getAlertFreqDay(long alertId,
Request apiRequest)
                                 throws PortalException
Deprecated.  
get frequency-day value of an alert.
Parameters:
alertId - queried Alert ID.
apiRequest - current validated Request.
Returns:
String constant representing frequency-day value, empty String if not ALERTFREQTYPEDAY.
PortalException

getAlertFreqValue

public java.lang.String getAlertFreqValue(long alertId)
                                   throws PortalException
Deprecated.  
get frequency-unit time value of an alert.
Parameters:
alertId - queried alert ID.
Returns:
String constants representing frequency-unit time value of the alert, empty string if not ALERTFREQTYPEUNIT.
PortalException

getAlertFreqUnit

public java.lang.String getAlertFreqUnit(long alertId)
                                  throws PortalException
Deprecated.  
get frequency-unit time unit of an alert.
Parameters:
alertId - queried alert ID.
Returns:
String constants representing frequency-unit time unit of the alert, empty string if not ALERTFREQTYPEUNIT.
PortalException

getAlertStartTime

public java.util.Hashtable getAlertStartTime(long alertId)
                                      throws PortalException
Deprecated.  
get next start time of an alert.
Parameters:
alertId - queried alert ID.
Returns:
alert next start time Hashtable with keys of year, month, date, hour, minute, second.
PortalException

getAlertStartTime

public java.util.Hashtable getAlertStartTime(long alertId,
Request apiRequest)
                                      throws PortalException
Deprecated.  
get next start time of an alert.
Parameters:
alertId - queried alert ID.
apiRequest - current validated Request.
Returns:
alert next start time Hashtable with keys of year, month, date, hour, minute, second.
PortalException

getCurrentTimeHash

public java.util.Hashtable getCurrentTimeHash()
                                       throws PortalException
Deprecated.  
get current system time.
Returns:
system time Hashtable with keys of year, month, date, hour, minute, second.
PortalException

getCurrentTimeHash

public java.util.Hashtable getCurrentTimeHash(Request apiRequest)
                                       throws PortalException
Deprecated.  
get current system time.
Parameters:
apiRequest - current validated Request.
Returns:
system time Hashtable with keys of year, month, date, hour, minute, second.
PortalException

setParameters

public void setParameters(long alertId,
                          java.util.Hashtable paramHash)
                   throws PortalException
Deprecated.  
set name and address parameters of an alert.
Parameters:
alertId - queried alert ID.
paramHash - name and address parameter Hashtable of an alert
PortalException

setTimeParameters

public void setTimeParameters(long alertId,
                              java.util.Hashtable paramHash)
                       throws PortalException
Deprecated.  
set next start time and internal parameters of an alert.
Parameters:
alertId - queried alert ID.
PortalException

setTimeParameters

public void setTimeParameters(long alertId,
                              java.util.Hashtable paramHash,
Request apiRequest)
                       throws PortalException
Deprecated.  
set next start time and internal parameters of an alert.
Parameters:
alertId - queried alert ID.
apiRequest - current validated Request.
PortalException

createNewAlert

public Alert createNewAlert(java.lang.String name,
                            long serviceId,
                            java.lang.String addressIdString,
Request apiRequest)
                     throws PortalException
Deprecated.  
create a new alert.
Parameters:
name - new alert name.
serviceId - service for which to create the alert.
addressIdString - alert address id string.
apiRequest - current validated Request.
Returns:
the new Alert.
PortalException

getAllDevices

public Device[] getAllDevices()
                       throws PortalException
Deprecated.  
get all the available devices.
Returns:
Device array
PortalException

deleteAlertAddress

public void deleteAlertAddress(long alertAddressId)
                        throws PortalException
Deprecated.  
delete an alert address
Parameters:
alertAddressId - deleted alert address ID.
PortalException

setAddressParameters

public void setAddressParameters(long alertAddressId,
                                 java.util.Hashtable paramHash)
                          throws PortalException
Deprecated.  
set parameter values of an alert address.
Parameters:
alertAddressId - queried alert address ID.
paramHash - parameter name-value Hashtable to update
PortalException

createNewAlertAddress

public AlertAddress createNewAlertAddress(java.lang.String name,
                                          java.lang.String address,
                                          java.lang.String deviceIdString,
Request apiRequest)
                                   throws PortalException
Deprecated.  
create a new alert address.
Parameters:
name - new alert address name.
address - address String for the new alert address.
apiRequest - current validated Request.
PortalException

Oracle Application Server Wireless Java API Reference
B10400-01

Copyright © 2003 Oracle Corporation. All Rights Reserved.