de.ipcon.db.alarm

Class BenachrichtigungsScriptAPI

java.lang.Object

de.ipcon.db.alarm.BenachrichtigungsScriptAPI

Direct Known Subclasses:

BOMonitoringAlarmBenachrichtigungsScriptAPI, EinfacherTerminBenachrichtigungsScriptAPI

public abstract class BenachrichtigungsScriptAPI
extends java.lang.Object

This class contains "helper methods" that might be useful in Alarm.BenachrichtigungsScript. Each such script is provided with a variable named api which is a designated and pre-configured instance of this class for the current execution of the script.

Constructor Summary

Constructors

Constructor and Description
BenachrichtigungsScriptAPI(AlarmHandler _ah, AlarmAusloesung _aa, Alarm _alarm)

Method Summary

Modifier and Type	Method and Description
abstract MyTISMBenachrichtigungsAuftrag	createBenachrichtigungsAuftrag()
BO	getBO(java.lang.Long id) Gets a BO from the database using the internal Transaction of this api instance.
BO	getBO(java.lang.Long id, java.lang.Class<? extends BOI> classTip) Gets a BO from the database using the internal Transaction of this api instance.
org.apache.log4j.Logger	getLogger()
Transaction	getTransaction() Gets the Transaction provided by this api instance that can be used to persist changes in the database.
Transaction	getTransaction(java.lang.String desc) Gets the Transaction provided by this api instance that can be used to persist changes in the database.
boolean	hasUnsavedData() Tells if if the internal Transaction of this API instance has any changes that will be persisted in the database.
boolean	sendNotification(CoreBO recipient) Deprecated. please use createBenachrichtigungsAuftrag(), the fluent interface of MyTISMBenachrichtigungsAuftrag for configuring the notification order and sendNotification(de.ipcon.db.core.MyTISMBenachrichtigungsAuftrag) instead.
boolean	sendNotification(CoreBO[] recipients) Deprecated. please use createBenachrichtigungsAuftrag(), the fluent interface of MyTISMBenachrichtigungsAuftrag for configuring the notification order and sendNotification(de.ipcon.db.core.MyTISMBenachrichtigungsAuftrag) instead.
boolean	sendNotification(CoreBO[] recipients, L10nLocale locale)
boolean	sendNotification(CoreBO[] recipients, L10nLocale locale, CoreBO sender)
boolean	sendNotification(CoreBO[] recipients, L10nLocale locale, CoreBO sender, boolean asBCC)
boolean	sendNotification(CoreBO[] recipients, L10nLocale locale, CoreBO sender, boolean asBCC, java.util.Collection<CoreBO> replyTos)
boolean	sendNotification(CoreBO recipient, L10nLocale locale)
boolean	sendNotification(CoreBO recipient, L10nLocale locale, CoreBO sender)
boolean	sendNotification(MyTISMBenachrichtigungsAuftrag notificationOrder) Sends out a notification using the passed new MyTISMBenachrichtigungsAuftrag that was created using createBenachrichtigungsAuftrag() and configured via its fluent API.
boolean	sendNotificationByEmail(java.lang.String email) Deprecated. please use createBenachrichtigungsAuftrag(), the fluent interface of MyTISMBenachrichtigungsAuftrag for configuring the notification order and sendNotification(de.ipcon.db.core.MyTISMBenachrichtigungsAuftrag) instead.
boolean	sendNotificationByEmail(java.lang.String[] emails) Deprecated. please use createBenachrichtigungsAuftrag(), the fluent interface of MyTISMBenachrichtigungsAuftrag for configuring the notification order and sendNotification(de.ipcon.db.core.MyTISMBenachrichtigungsAuftrag) instead.
boolean	sendNotificationByEmail(java.lang.String[] emails, L10nLocale locale)
boolean	sendNotificationByEmail(java.lang.String[] emails, L10nLocale locale, CoreBO sender)
boolean	sendNotificationByEmail(java.lang.String[] emails, L10nLocale locale, CoreBO sender, boolean asBCC)
boolean	sendNotificationByEmail(java.lang.String[] emails, L10nLocale locale, CoreBO sender, boolean asBCC, java.util.Collection<CoreBO> replyTos)
boolean	sendNotificationByEmail(java.lang.String email, L10nLocale locale)
boolean	sendNotificationByEmail(java.lang.String email, L10nLocale locale, CoreBO sender)
boolean	sendNotificationByEmail(java.lang.String email, L10nLocale locale, CoreBO sender, boolean asBCC)
boolean	sendNotificationByEmail(java.lang.String email, L10nLocale locale, CoreBO sender, boolean asBCC, java.util.Collection<CoreBO> replyTos)

Methods inherited from class java.lang.Object

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

Constructor Detail

BenachrichtigungsScriptAPI

public BenachrichtigungsScriptAPI(AlarmHandler _ah,
                                  AlarmAusloesung _aa,
                                  Alarm _alarm)

Method Detail

getLogger

public org.apache.log4j.Logger getLogger()

Returns:

a Logger for outputting log and debug messages

getTransaction

public Transaction getTransaction()

Gets the Transaction provided by this api instance that can be used to persist changes in the database.

Returns:

a Transaction (the internal transaction of this instance) that can be used to persist changes in the database

getTransaction

public Transaction getTransaction(java.lang.String desc)

Gets the Transaction provided by this api instance that can be used to persist changes in the database.

Parameters:

desc - a description that should overwrite the (current) default description of the Transaction provided by this api instance; if null the description will remain as is

Returns:

a Transaction (the internal transaction of this instance) that can be used to persist changes in the database

hasUnsavedData

public boolean hasUnsavedData()

Tells if if the internal Transaction of this API instance has any changes that will be persisted in the database.

Returns:

true if the internal Transaction of this API instance has any changes that will be persisted in the database; false if not

getBO

public BO getBO(java.lang.Long id)

Gets a BO from the database using the internal Transaction of this api instance.

Parameters:

id - the Id of the BO to get

Returns:

the BO with the given Id

getBO

public BO getBO(java.lang.Long id,
                java.lang.Class<? extends BOI> classTip)

Gets a BO from the database using the internal Transaction of this api instance.

Parameters:

id - the Id of the BO to get

classTip - the class of the BO to get; if null is passed, defaults to BO.class

Returns:

the BO with the given Id and class

sendNotificationByEmail

@Deprecated
public boolean sendNotificationByEmail(java.lang.String email)

Deprecated. please use createBenachrichtigungsAuftrag(), the fluent interface of MyTISMBenachrichtigungsAuftrag for configuring the notification order and sendNotification(de.ipcon.db.core.MyTISMBenachrichtigungsAuftrag) instead.

Convenience frontend for just one recipient address for the multiple recipient addresses version of this method.

sendNotificationByEmail

public boolean sendNotificationByEmail(java.lang.String email,
                                       L10nLocale locale)

sendNotificationByEmail

public boolean sendNotificationByEmail(java.lang.String email,
                                       L10nLocale locale,
                                       CoreBO sender)

sendNotificationByEmail

public boolean sendNotificationByEmail(java.lang.String email,
                                       L10nLocale locale,
                                       CoreBO sender,
                                       boolean asBCC)

sendNotificationByEmail

public boolean sendNotificationByEmail(java.lang.String email,
                                       L10nLocale locale,
                                       CoreBO sender,
                                       boolean asBCC,
                                       java.util.Collection<CoreBO> replyTos)

sendNotificationByEmail

@Deprecated
public boolean sendNotificationByEmail(java.lang.String[] emails)

Deprecated. please use createBenachrichtigungsAuftrag(), the fluent interface of MyTISMBenachrichtigungsAuftrag for configuring the notification order and sendNotification(de.ipcon.db.core.MyTISMBenachrichtigungsAuftrag) instead.

Sends out notifications using the BenachrichtigungsVorlage of the Alarm of this instance to multiple addresses by e-mail. If the e-mail address string(s) given here come(s) from a CoreBO: Before using this method please consider letting the CoreBO implement NotificationReceiverI and use sendNotification() with the CoreBO as recipient instead. This method should only be used for e-mail addresses that really "come out of thin air" and are not associated with any CoreBO. And even for these you might rather consider creating a persistent MyTISMAdresseEmail in the DB and use that instead of using this method which will create a persistent MyTISMAdresseEmail itself (and do so every time this method is used, possibly leading to countless copies of what is basically the same object in the DB).

sendNotificationByEmail

public boolean sendNotificationByEmail(java.lang.String[] emails,
                                       L10nLocale locale)

sendNotificationByEmail

public boolean sendNotificationByEmail(java.lang.String[] emails,
                                       L10nLocale locale,
                                       CoreBO sender)

sendNotificationByEmail

public boolean sendNotificationByEmail(java.lang.String[] emails,
                                       L10nLocale locale,
                                       CoreBO sender,
                                       boolean asBCC)

sendNotificationByEmail

public boolean sendNotificationByEmail(java.lang.String[] emails,
                                       L10nLocale locale,
                                       CoreBO sender,
                                       boolean asBCC,
                                       java.util.Collection<CoreBO> replyTos)

sendNotification

@Deprecated
public boolean sendNotification(CoreBO recipient)

Deprecated. please use createBenachrichtigungsAuftrag(), the fluent interface of MyTISMBenachrichtigungsAuftrag for configuring the notification order and sendNotification(de.ipcon.db.core.MyTISMBenachrichtigungsAuftrag) instead.

Convenience frontend for just one recipient for the multiple recipient version of this method.

sendNotification

public boolean sendNotification(CoreBO recipient,
                                L10nLocale locale)

sendNotification

public boolean sendNotification(CoreBO recipient,
                                L10nLocale locale,
                                CoreBO sender)

sendNotification

@Deprecated
public boolean sendNotification(CoreBO[] recipients)

Deprecated. please use createBenachrichtigungsAuftrag(), the fluent interface of MyTISMBenachrichtigungsAuftrag for configuring the notification order and sendNotification(de.ipcon.db.core.MyTISMBenachrichtigungsAuftrag) instead.

Sends out notifications using the BenachrichtigungsVorlage of the Alarm of this instance to multiple recipients. The recipients must be of type CoreBO and implement NotifiableI.

sendNotification

public boolean sendNotification(CoreBO[] recipients,
                                L10nLocale locale)

sendNotification

public boolean sendNotification(CoreBO[] recipients,
                                L10nLocale locale,
                                CoreBO sender)

sendNotification

public boolean sendNotification(CoreBO[] recipients,
                                L10nLocale locale,
                                CoreBO sender,
                                boolean asBCC)

sendNotification

public boolean sendNotification(CoreBO[] recipients,
                                L10nLocale locale,
                                CoreBO sender,
                                boolean asBCC,
                                java.util.Collection<CoreBO> replyTos)

sendNotification

public boolean sendNotification(MyTISMBenachrichtigungsAuftrag notificationOrder)

Sends out a notification using the passed new MyTISMBenachrichtigungsAuftrag that was created using createBenachrichtigungsAuftrag() and configured via its fluent API.

Example usage:

 
 def ticket = api.getTriggeringBO()
 def sender = ticket.getAbarbeiter()
 def notificationOrder = api.createBenachrichtigungsAuftrag()
       .setSender(sender)
       .addRecipientEmail('develop@oashi.com')
       .addRecipientEmailBCC('team@oashi.com')
       .setReplyToAddress(ticket.getEintragVon())
       .setL10nLocale(L10nLocale.byLocale(Locale.ENGLISH))
 api.sendNotification(notificationOrder)
 
 

Parameters:

notificationOrder - the MyTISMBenachrichtigungsAuftrag to send

Returns:

true, unless an exception is thrown

Throws:

java.lang.IllegalStateException - if the passed MyTISMBenachrichtigungsAuftrag is not still new or was created using a foreign Transaction, i.e. not "the" tx of this BenachrichtigungsScriptAPI.

createBenachrichtigungsAuftrag

public abstract MyTISMBenachrichtigungsAuftrag createBenachrichtigungsAuftrag()

Returns:

a MyTISMBenachrichtigungsAuftrag with various data pre-filled using the BenachrichtigungsVorlage etc. which can be used to send more customized notifications