|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.panama.portal.AlertSubscriptionController
AlertSubscriptionController handles User AlertService subscription
Field Summary | |
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 | |
oracle.panama.alert.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 |
oracle.panama.alert.AlertService[] |
getAlertServices(long topicId, Request apiRequest) Get children AlertService array of a topic. |
oracle.panama.alert.UserAlertSubscription[] |
getAlertSubscriptions(long alertServiceId, Request apiRequest) Get all UserAlertSubscriptions of an Alert Service. |
oracle.panama.alert.AlertTimeFrequency[] |
getAlertTimeFrequencies() Get all AlertTimeFrequencies. |
java.lang.String[] |
getAlertTimeFrequencyNames() Get all AlertTimeFrequency names. |
static oracle.panama.alert.AlertService[] |
getAllRootAlertServices(Request apiRequest) Get all root Alert Services. |
static oracle.panama.alert.Topic[] |
getAllRootTopics(Request apiRequest) Get all root Topics |
oracle.panama.alert.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. |
oracle.panama.alert.AlertService |
lookupAlertService(long alertServiceId, Request apiRequest) Lookup AlertService by Object ID. |
oracle.panama.alert.AlertTimeFrequency |
lookupAlertTimeFrequency(java.lang.String freqCode) Lookup the AlertTimeFrequency by frequency code. |
oracle.panama.alert.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 |
public static final java.lang.String ALERTDEVICE
public static final java.lang.String ALERTSERVICENAME
public static final java.lang.String TOPICNAME
Method Detail |
public oracle.panama.alert.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
alertServiceId
- queried AlertService ID.dispNameStr
- display name.inputValues
- input values.condValues
- condition values.timeValues
- time condition values.expDateValue
- expiration date.apiRequest
- current validate Request.PortalException
public void deleteUserAlertSubscription(long alertServiceId, long alertSubsId, Request apiRequest) throws PortalException
alertServiceId
- queried AlertService ID.alertSubsId
- UserAlertSubscription IDapiRequest
- current validate Request.PortalException
public void enableAlertSubscription(long alertServiceId, long alertSubsId, boolean toEnable, Request apiRequest) throws PortalException
alertServiceId
- queried AlertService ID.alertSubsId
- UserAlertSubscription IDtoEnable
- true : enable, false : disableapiRequest
- current validate Request.PortalException
public oracle.panama.alert.AlertService[] getAlertServices(long topicId, Request apiRequest) throws PortalException
topicId
- queried topic ID.apiRequest
- current validate Request.PortalException
public oracle.panama.alert.UserAlertSubscription[] getAlertSubscriptions(long alertServiceId, Request apiRequest) throws PortalException
alertServiceId
- queried alertService ID.apiRequest
- current validate Request.PortalException
public oracle.panama.alert.AlertTimeFrequency[] getAlertTimeFrequencies()
public java.lang.String[] getAlertTimeFrequencyNames()
public static oracle.panama.alert.AlertService[] getAllRootAlertServices(Request apiRequest) throws PortalException
apiRequest
- current validate Request.PortalException
public static oracle.panama.alert.Topic[] getAllRootTopics(Request apiRequest) throws PortalException
PortalException
public oracle.panama.alert.Topic[] getAllSubTopics(long topicId, Request apiRequest) throws PortalException
topicId
- queried topic ID.apiRequest
- current validate Request.PortalException
public java.lang.String[] getInputParamNames(long alertServiceId, Request apiRequest) throws PortalException
alertServiceId
- queried AlertService ID.apiRequest
- current validate Request.PortalException
public static AlertSubscriptionController getInstance()
public java.lang.String[] getTriggerConditionNames(long alertServiceId, Request apiRequest) throws PortalException
alertServiceId
- queried AlertService ID.apiRequest
- current validate Request.PortalException
public DeviceAddress getUserAlertDevice(long alertServiceId, Request apiRequest) throws PortalException
alertServiceId
- queried AlertService ID.apiRequest
- current validate Request.PortalException
public boolean isTimeBased(long alertServiceId, Request apiRequest) throws PortalException
alertServiceId
- queried AlertService ID.apiRequest
- current validate Request.PortalException
public oracle.panama.alert.AlertService lookupAlertService(long alertServiceId, Request apiRequest) throws PortalException
alertServiceId
- queried AlertService ID.apiRequest
- current validate Request.PortalException
public oracle.panama.alert.AlertTimeFrequency lookupAlertTimeFrequency(java.lang.String freqCode) throws PortalException
freqCode
- queried frequency code.PortalException
public oracle.panama.alert.UserAlertSubscription lookupUserAlertSubscription(long alertServiceId, long alertSubsId, Request apiRequest) throws PortalException
alertServiceId
- queried AlertService object ID.alertSubsId
- queried AlertSubscription object ID.apiRequest
- current validate Request.PortalException
public void setAlertDevice(long alertServiceId, long deviceId, Request _rRequest) throws PanamaRuntimeException, PanamaException
alertServiceId
- queried AlertService object ID.deviceId
- queried DeviceAddress object ID.PanamaRuntimeException
PanamaException
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
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.PortalException
public void setAlertTimeFrequency(long alertServiceId, long alertSubsId, java.lang.String frequencyCode, Request apiRequest) throws PortalException
alertServiceId
- queried AlertService object ID.alertSubsId
- queried UserAlertSubscription object ID.frequencyCode
- time frequency code.apiRequest
- current validate Request.PortalException
|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |