oracle.panama.portal
Class AlertSubscriptionController

java.lang.Object
  |
  +--oracle.panama.portal.AlertSubscriptionController

All Implemented Interfaces:

java.io.Serializable

public class AlertSubscriptionController

extends java.lang.Object

implements java.io.Serializable

AlertSubscriptionController handles User AlertService subscription

See Also:

Serialized Form

Field Summary

Type	Field
static java.lang.String	ALERTDEVICE Key for retrieving alert device value from the parameter Hashtable passing to/from the portal pages.
static java.lang.String	ALERTSERVICENAME Key for retrieving alert service name value from the parameter Hashtable passing to/from the portal pages.
static java.lang.String	TOPICNAME Key for retrieving topic name from the parameter Hashtable passing to/from the portal pages.

Method Summary

Type	Method
UserAlertSubscription	createUserAlertSubscription(long alertServiceId, java.lang.String dispNameStr, java.lang.String[] inputValues, java.lang.String[] condValues, java.lang.String[] timeValues, java.lang.String expDateValue, Request apiRequest) Create a UserAlertSubscription
void	deleteUserAlertSubscription(long alertServiceId, long alertSubsId, Request apiRequest) Delete a UserAlertSubscription
void	enableAlertSubscription(long alertServiceId, long alertSubsId, boolean toEnable, Request apiRequest) Enable a UserAlertSubscription
AlertService[]	getAlertServices(long topicId, Request apiRequest) Get children AlertService array of a topic.
UserAlertSubscription[]	getAlertSubscriptions(long alertServiceId, Request apiRequest) Get all UserAlertSubscriptions of an Alert Service.
AlertTimeFrequency[]	getAlertTimeFrequencies() Get all AlertTimeFrequencies.
java.lang.String[]	getAlertTimeFrequencyNames() Get all AlertTimeFrequency names.
static AlertService[]	getAllRootAlertServices(Request apiRequest) Get all root Alert Services.
static Topic[]	getAllRootTopics(Request apiRequest) Get all root Topics
Topic[]	getAllSubTopics(long topicId, Request apiRequest) Get sub Topics of a topic.
java.lang.String[]	getInputParamNames(long alertServiceId, Request apiRequest) Get all input parameter names.
static AlertSubscriptionController	getInstance() The singleton thread-safe getter.
java.lang.String[]	getTriggerConditionNames(long alertServiceId, Request apiRequest) Get all trigger condition names.
DeviceAddress	getUserAlertDevice(long alertServiceId, Request apiRequest) Get DeviceAddress for a AlertService.
boolean	isTimeBased(long alertServiceId, Request apiRequest) Check if an AlertService has time-based trigger conditions defined.
AlertService	lookupAlertService(long alertServiceId, Request apiRequest) Lookup AlertService by Object ID.
AlertTimeFrequency	lookupAlertTimeFrequency(java.lang.String freqCode) Lookup the AlertTimeFrequency by frequency code.
UserAlertSubscription	lookupUserAlertSubscription(long alertServiceId, long alertSubsId, Request apiRequest) Lookup the UserAlertSubscription by Object ID.
void	setAlertDevice(long alertServiceId, long deviceId, Request _rRequest) Set DeviceAddress to an AlertService.
void	setAlertSubscriptionParams(long alertServiceId, long alertSubsId, java.lang.String dispNameStr, java.lang.String[] inputValues, java.lang.String[] condValues, java.lang.String[] timeValues, java.util.Date expDateValue, Request apiRequest) Set parameter values for an UserAlertSubscription.
void	setAlertTimeFrequency(long alertServiceId, long alertSubsId, java.lang.String frequencyCode, Request apiRequest) Set parameter values for an UserAlertSubscription.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TOPICNAME

public static final java.lang.String TOPICNAME

Key for retrieving topic name from the parameter Hashtable passing to/from the portal pages.

ALERTSERVICENAME

public static final java.lang.String ALERTSERVICENAME

Key for retrieving alert service name value from the parameter Hashtable passing to/from the portal pages.

ALERTDEVICE

public static final java.lang.String ALERTDEVICE

Key for retrieving alert device value from the parameter Hashtable passing to/from the portal pages.

Method Detail

getInstance

public static AlertSubscriptionController getInstance()

The singleton thread-safe getter.

Returns:

the AlertSubscriptionController singleton interface.

getAlertServices

public AlertService[] getAlertServices(long topicId,
                                       Request apiRequest)
                                throws PortalException

Get children AlertService array of a topic.

Parameters:

topicId - queried topic ID.

apiRequest - current validate Request.

Returns:

children AlertService array.

getAllSubTopics

public Topic[] getAllSubTopics(long topicId,
                               Request apiRequest)
                        throws PortalException

Get sub Topics of a topic.

Parameters:

topicId - queried topic ID.

apiRequest - current validate Request.

Returns:

sub Topic array.

getAllRootTopics

public static Topic[] getAllRootTopics(Request apiRequest)
                                throws PortalException

Get all root Topics

Returns:

a array of root Topics

getAllRootAlertServices

public static AlertService[] getAllRootAlertServices(Request apiRequest)
                                              throws PortalException

Get all root Alert Services.

Parameters:

apiRequest - current validate Request.

Returns:

AlertService array.

lookupUserAlertSubscription

public UserAlertSubscription lookupUserAlertSubscription(long alertServiceId,
                                                         long alertSubsId,
                                                         Request apiRequest)
                                                  throws PortalException

Lookup the UserAlertSubscription by Object ID.

Parameters:

alertServiceId - queried AlertService object ID.

alertSubsId - queried AlertSubscription object ID.

apiRequest - current validate Request.

Returns:

UserAlertSubscription object.

deleteUserAlertSubscription

public void deleteUserAlertSubscription(long alertServiceId,
                                        long alertSubsId,
                                        Request apiRequest)
                                 throws PortalException

Delete a UserAlertSubscription

Parameters:

alertServiceId - queried AlertService ID.

alertSubsId - UserAlertSubscription ID

apiRequest - current validate Request.

setAlertDevice

public void setAlertDevice(long alertServiceId,
                           long deviceId,
                           Request _rRequest)
                    throws PanamaRuntimeException,
                           PanamaException

Set DeviceAddress to an AlertService.

Parameters:

alertServiceId - queried AlertService object ID.

deviceId - queried DeviceAddress object ID.

apiRequest - current validate Request.

getUserAlertDevice

public DeviceAddress getUserAlertDevice(long alertServiceId,
                                        Request apiRequest)
                                 throws PortalException

Get DeviceAddress for a AlertService.

Parameters:

alertServiceId - queried AlertService ID.

apiRequest - current validate Request.

Returns:

name string array.

createUserAlertSubscription

public UserAlertSubscription createUserAlertSubscription(long alertServiceId,
                                                         java.lang.String dispNameStr,
                                                         java.lang.String[] inputValues,
                                                         java.lang.String[] condValues,
                                                         java.lang.String[] timeValues,
                                                         java.lang.String expDateValue,
                                                         Request apiRequest)
                                                  throws PortalException

Create a UserAlertSubscription

Parameters:

alertServiceId - queried AlertService ID.

dispNameStr - display name.

inputValues - input values.

condValues - condition values.

timeValues - time condition values.

expDateValue - expiration date.

apiRequest - current validate Request.

Returns:

UserAlertSubscription object.

lookupAlertService

public AlertService lookupAlertService(long alertServiceId,
                                       Request apiRequest)
                                throws PortalException

Lookup AlertService by Object ID.

Parameters:

alertServiceId - queried AlertService ID.

apiRequest - current validate Request.

Returns:

children AlertService array.

lookupAlertTimeFrequency

public AlertTimeFrequency lookupAlertTimeFrequency(java.lang.String freqCode)
                                            throws PortalException

Lookup the AlertTimeFrequency by frequency code.

Parameters:

freqCode - queried frequency code.

Returns:

AlertTimeFrequency object.

isTimeBased

public boolean isTimeBased(long alertServiceId,
                           Request apiRequest)
                    throws PortalException

Check if an AlertService has time-based trigger conditions defined.

Parameters:

alertServiceId - queried AlertService ID.

apiRequest - current validate Request.

Returns:

true : time-based alert, false : not time-based alert.

getAlertSubscriptions

public UserAlertSubscription[] getAlertSubscriptions(long alertServiceId,
                                                     Request apiRequest)
                                              throws PortalException

Get all UserAlertSubscriptions of an Alert Service.

Parameters:

alertServiceId - queried alertService ID.

apiRequest - current validate Request.

Returns:

UserAlertSubscription array.

getInputParamNames

public java.lang.String[] getInputParamNames(long alertServiceId,
                                             Request apiRequest)
                                      throws PortalException

Get all input parameter names.

Parameters:

alertServiceId - queried AlertService ID.

apiRequest - current validate Request.

Returns:

name string array.

getTriggerConditionNames

public java.lang.String[] getTriggerConditionNames(long alertServiceId,
                                                   Request apiRequest)
                                            throws PortalException

Get all trigger condition names.

Parameters:

alertServiceId - queried AlertService ID.

apiRequest - current validate Request.

Returns:

name string array.

getAlertTimeFrequencyNames

public java.lang.String[] getAlertTimeFrequencyNames()

Get all AlertTimeFrequency names.

Returns:

AlertTimeFrequency name array.

getAlertTimeFrequencies

public AlertTimeFrequency[] getAlertTimeFrequencies()

Get all AlertTimeFrequencies.

Returns:

AlertTimeFrequency array.

setAlertTimeFrequency

public void setAlertTimeFrequency(long alertServiceId,
                                  long alertSubsId,
                                  java.lang.String frequencyCode,
                                  Request apiRequest)
                           throws PortalException

Set parameter values for an UserAlertSubscription.

Parameters:

alertServiceId - queried AlertService object ID.

alertSubsId - queried UserAlertSubscription object ID.

frequencyCode - time frequency code.

apiRequest - current validate Request.

setAlertSubscriptionParams

public void setAlertSubscriptionParams(long alertServiceId,
                                       long alertSubsId,
                                       java.lang.String dispNameStr,
                                       java.lang.String[] inputValues,
                                       java.lang.String[] condValues,
                                       java.lang.String[] timeValues,
                                       java.util.Date expDateValue,
                                       Request apiRequest)
                                throws PortalException

Set parameter values for an UserAlertSubscription.

Parameters:

alertServiceId - queried AlertService object ID.

alertSubsId - queried UserAlertSubscription object ID.

dispNameStr - display name string.

inputValues - string values for input parameters.

condValues - string values for trigger conditions.

timeValues - string values for time conditions.

expDateValue - expiration date.

apiRequest - current validate Request.

enableAlertSubscription

public void enableAlertSubscription(long alertServiceId,
                                    long alertSubsId,
                                    boolean toEnable,
                                    Request apiRequest)
                             throws PortalException

Enable a UserAlertSubscription

Parameters:

alertServiceId - queried AlertService ID.

alertSubsId - UserAlertSubscription ID

toEnable - true : enable, false : disable

apiRequest - current validate Request.