public abstract class BenachrichtigungsScriptAPI extends java.lang.Object implements BenachrichtigungsScriptAPII
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.VARNAME_ALARM, VARNAME_API, VARNAME_AUFTRAG, VARNAME_BOT, VARNAME_BT, VARNAME_DATENOW, VARNAME_ID_BO, VARNAME_LOG
Constructor and Description |
---|
BenachrichtigungsScriptAPI(AlarmHandler _ah,
AlarmAusloesung _aa,
Alarm _alarm) |
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 BO> 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 |
sendNotification(CoreBO recipient)
Convenience frontend for just one recipient for the multiple recipient
version of this method.
|
boolean |
sendNotification(CoreBO[] recipients)
Sends out notifications using the
BenachrichtigungsVorlage of the
Alarm of this instance to multiple recipients. |
boolean |
sendNotification(CoreBO[] recipients,
L10nLocale locale)
Sends out notifications using the
BenachrichtigungsVorlage of the
Alarm of this instance to multiple recipients. |
boolean |
sendNotification(CoreBO[] recipients,
L10nLocale locale,
CoreBO sender)
Sends out notifications using the
BenachrichtigungsVorlage of the
Alarm of this instance to multiple recipients. |
boolean |
sendNotification(CoreBO[] recipients,
L10nLocale locale,
CoreBO sender,
boolean asBCC)
Sends out notifications using the
BenachrichtigungsVorlage of the
Alarm of this instance to multiple recipients. |
boolean |
sendNotification(CoreBO[] recipients,
L10nLocale locale,
CoreBO sender,
boolean asBCC,
java.util.Collection<CoreBO> replyTos)
Sends out notifications using the
BenachrichtigungsVorlage of the
Alarm of this instance to multiple recipients. |
boolean |
sendNotification(CoreBO recipient,
L10nLocale locale)
Convenience frontend for just one recipient for the multiple recipient
version of this method.
|
boolean |
sendNotification(CoreBO recipient,
L10nLocale locale,
CoreBO sender)
Convenience frontend for just one recipient for the multiple recipient
version of this method.
|
boolean |
sendNotificationByEmail(java.lang.String email)
Convenience frontend for just one recipient address for the multiple
recipient addresses version of this method.
|
boolean |
sendNotificationByEmail(java.lang.String[] emails)
Sends out notifications using the
BenachrichtigungsVorlage of the
Alarm of this instance to multiple addresses by e-mail. |
boolean |
sendNotificationByEmail(java.lang.String[] emails,
L10nLocale locale)
Sends out notifications using the
BenachrichtigungsVorlage of the
Alarm of this instance to multiple addresses by e-mail. |
boolean |
sendNotificationByEmail(java.lang.String[] emails,
L10nLocale locale,
CoreBO sender)
Sends out notifications using the
BenachrichtigungsVorlage of the
Alarm of this instance to multiple addresses by e-mail. |
boolean |
sendNotificationByEmail(java.lang.String[] emails,
L10nLocale locale,
CoreBO sender,
boolean asBCC)
Sends out notifications using the
BenachrichtigungsVorlage of the
Alarm of this instance to multiple addresses by e-mail. |
boolean |
sendNotificationByEmail(java.lang.String[] emails,
L10nLocale locale,
CoreBO sender,
boolean asBCC,
java.util.Collection<CoreBO> replyTos)
Sends out notifications using the
BenachrichtigungsVorlage of the
Alarm of this instance to multiple addresses by e-mail. |
boolean |
sendNotificationByEmail(java.lang.String email,
L10nLocale locale)
Convenience frontend for just one recipient address for the multiple
recipient addresses version of this method.
|
boolean |
sendNotificationByEmail(java.lang.String email,
L10nLocale locale,
CoreBO sender)
Convenience frontend for just one recipient address for the multiple
recipient addresses version of this method.
|
boolean |
sendNotificationByEmail(java.lang.String email,
L10nLocale locale,
CoreBO sender,
boolean asBCC)
Convenience frontend for just one recipient address for the multiple
recipient addresses version of this method.
|
boolean |
sendNotificationByEmail(java.lang.String email,
L10nLocale locale,
CoreBO sender,
boolean asBCC,
java.util.Collection<CoreBO> replyTos)
Convenience frontend for just one recipient address for the multiple
recipient addresses version of this method.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
hasUnsavedData
public BenachrichtigungsScriptAPI(AlarmHandler _ah, AlarmAusloesung _aa, Alarm _alarm)
public org.apache.log4j.Logger getLogger()
getLogger
in interface BenachrichtigungsScriptAPII
Logger
for outputting log and debug messagespublic Transaction getTransaction()
BenachrichtigungsScriptAPII
Transaction
provided by this api instance that can be
used to persist changes in the database.getTransaction
in interface BenachrichtigungsScriptAPII
Transaction
(the internal transaction of this instance)
that can be used to persist changes in the databasepublic Transaction getTransaction(java.lang.String desc)
BenachrichtigungsScriptAPII
Transaction
provided by this api instance that can be
used to persist changes in the database.getTransaction
in interface BenachrichtigungsScriptAPII
desc
- an (optional) description that should overwrite the (current)
default description of the Transaction
provided by this api
instance; if null the description will remain as isTransaction
(the internal transaction of this instance)
that can be used to persist changes in the databasepublic BO getBO(java.lang.Long id)
BenachrichtigungsScriptAPII
BO
from the database using the internal Transaction of this api instance.getBO
in interface BenachrichtigungsScriptAPII
id
- the Id of the BO to getBO
with the given Idpublic BO getBO(java.lang.Long id, java.lang.Class<? extends BO> classTip)
BenachrichtigungsScriptAPII
BO
from the database using the internal Transaction of this api instance.getBO
in interface BenachrichtigungsScriptAPII
id
- the Id of the BO to getclassTip
- the (optional) class of the BO to get; defaults to BO.classBO
with the given Id and classpublic boolean sendNotificationByEmail(java.lang.String email)
BenachrichtigungsScriptAPII
sendNotificationByEmail
in interface BenachrichtigungsScriptAPII
public boolean sendNotificationByEmail(java.lang.String email, L10nLocale locale)
BenachrichtigungsScriptAPII
sendNotificationByEmail
in interface BenachrichtigungsScriptAPII
public boolean sendNotificationByEmail(java.lang.String email, L10nLocale locale, CoreBO sender)
BenachrichtigungsScriptAPII
sendNotificationByEmail
in interface BenachrichtigungsScriptAPII
public boolean sendNotificationByEmail(java.lang.String email, L10nLocale locale, CoreBO sender, boolean asBCC)
BenachrichtigungsScriptAPII
sendNotificationByEmail
in interface BenachrichtigungsScriptAPII
public boolean sendNotificationByEmail(java.lang.String email, L10nLocale locale, CoreBO sender, boolean asBCC, java.util.Collection<CoreBO> replyTos)
BenachrichtigungsScriptAPII
sendNotificationByEmail
in interface BenachrichtigungsScriptAPII
public boolean sendNotificationByEmail(java.lang.String[] emails)
BenachrichtigungsScriptAPII
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
in interface BenachrichtigungsScriptAPII
public boolean sendNotificationByEmail(java.lang.String[] emails, L10nLocale locale)
BenachrichtigungsScriptAPII
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
in interface BenachrichtigungsScriptAPII
public boolean sendNotificationByEmail(java.lang.String[] emails, L10nLocale locale, CoreBO sender)
BenachrichtigungsScriptAPII
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
in interface BenachrichtigungsScriptAPII
public boolean sendNotificationByEmail(java.lang.String[] emails, L10nLocale locale, CoreBO sender, boolean asBCC)
BenachrichtigungsScriptAPII
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
in interface BenachrichtigungsScriptAPII
public boolean sendNotificationByEmail(java.lang.String[] emails, L10nLocale locale, CoreBO sender, boolean asBCC, java.util.Collection<CoreBO> replyTos)
BenachrichtigungsScriptAPII
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
in interface BenachrichtigungsScriptAPII
public boolean sendNotification(CoreBO recipient)
BenachrichtigungsScriptAPII
sendNotification
in interface BenachrichtigungsScriptAPII
public boolean sendNotification(CoreBO recipient, L10nLocale locale)
BenachrichtigungsScriptAPII
sendNotification
in interface BenachrichtigungsScriptAPII
public boolean sendNotification(CoreBO recipient, L10nLocale locale, CoreBO sender)
BenachrichtigungsScriptAPII
sendNotification
in interface BenachrichtigungsScriptAPII
public boolean sendNotification(CoreBO[] recipients)
BenachrichtigungsScriptAPII
BenachrichtigungsVorlage
of the
Alarm
of this instance to multiple recipients.
The recipients must be of type CoreBO
and implement NotifiableI
.sendNotification
in interface BenachrichtigungsScriptAPII
public boolean sendNotification(CoreBO[] recipients, L10nLocale locale)
BenachrichtigungsScriptAPII
BenachrichtigungsVorlage
of the
Alarm
of this instance to multiple recipients.
The recipients must be of type CoreBO
and implement NotifiableI
.sendNotification
in interface BenachrichtigungsScriptAPII
public boolean sendNotification(CoreBO[] recipients, L10nLocale locale, CoreBO sender)
BenachrichtigungsScriptAPII
BenachrichtigungsVorlage
of the
Alarm
of this instance to multiple recipients.
The recipients must be of type CoreBO
and implement NotifiableI
.sendNotification
in interface BenachrichtigungsScriptAPII
public boolean sendNotification(CoreBO[] recipients, L10nLocale locale, CoreBO sender, boolean asBCC)
BenachrichtigungsScriptAPII
BenachrichtigungsVorlage
of the
Alarm
of this instance to multiple recipients.
The recipients must be of type CoreBO
and implement NotifiableI
.sendNotification
in interface BenachrichtigungsScriptAPII
public boolean sendNotification(CoreBO[] recipients, L10nLocale locale, CoreBO sender, boolean asBCC, java.util.Collection<CoreBO> replyTos)
BenachrichtigungsScriptAPII
BenachrichtigungsVorlage
of the
Alarm
of this instance to multiple recipients.
The recipients must be of type CoreBO
and implement NotifiableI
.sendNotification
in interface BenachrichtigungsScriptAPII
public abstract MyTISMBenachrichtigungsAuftrag createBenachrichtigungsAuftrag()
MyTISMBenachrichtigungsAuftrag
with various data
pre-filled using the BenachrichtigungsVorlage
etc. which can be
used to send more customized notificationsCopyright © 2000-2024 OAshi S.à r.l. All Rights Reserved.