step.repository.alm.otaclient

Interface IAlertable2Dispatch

All Superinterfaces:

com4j.Com4jObject

public interface IAlertable2Dispatch
extends com4j.Com4jObject

Services for managing auto-alerts.

Method Summary

Modifier and Type	Method and Description
com4j.Com4jObject	addAlert(String changedEntityType, int changedEntityID, String alertSubject, String alertDescription) Adds a new alert to the specified entity.
void	cleanAllAlerts() Removes all current object alerts from the database.
void	deleteAlert(Object iDs) Removes an alert or alerts associated with the current object from the database.
com4j.Com4jObject	getAlert(int id) Gets the alert specified by the alert ID.
IList	getAlertList(boolean needRefresh) Gets a list of all alerts associated with the object.
boolean	hasAlerts() Checks if any alerts are associated with the object.
boolean	hasNewAlerts() New, unread alerts are associated with the object.

Methods inherited from interface com4j.Com4jObject

advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

Method Detail

deleteAlert

void deleteAlert(Object iDs)

Removes an alert or alerts associated with the current object from the database.

Parameters:

iDs - Mandatory java.lang.Object parameter.

cleanAllAlerts

void cleanAllAlerts()

Removes all current object alerts from the database.

getAlert

com4j.Com4jObject getAlert(int id)

Gets the alert specified by the alert ID.

Parameters:

id - Mandatory int parameter.

Returns:

Returns a value of type com4j.Com4jObject

getAlertList

IList getAlertList(@DefaultValue(value="0")
                   boolean needRefresh)

Gets a list of all alerts associated with the object.

Parameters:

needRefresh - Optional parameter. Default value is false

Returns:

Returns a value of type otaclient.IList

hasAlerts

boolean hasAlerts()

Checks if any alerts are associated with the object.

Returns:

Returns a value of type boolean

hasNewAlerts

boolean hasNewAlerts()

New, unread alerts are associated with the object.

Returns:

Returns a value of type boolean

addAlert

com4j.Com4jObject addAlert(String changedEntityType,
                           int changedEntityID,
                           String alertSubject,
                           String alertDescription)

Adds a new alert to the specified entity.

Parameters:

changedEntityType - Mandatory java.lang.String parameter.

changedEntityID - Mandatory int parameter.

alertSubject - Mandatory java.lang.String parameter.

alertDescription - Mandatory java.lang.String parameter.

Returns:

Returns a value of type com4j.Com4jObject