de.ipcon.db.core

Interface NotificationReceiverI

All Superinterfaces:

BOI, CryptoConfigurationProviderI, DescribableI, Identifiable, NotifiableI, SchemaProviderI

All Known Implementing Classes:

Benutzer, MyTISMAdresse, MyTISMAdresseEmail, de.ipcon.db.core.MyTISMAdresseEmailBase, MyTISMAdresseSolstice, de.ipcon.db.core.MyTISMAdresseSolsticeBase

public interface NotificationReceiverI
extends CryptoConfigurationProviderI, NotifiableI

This interface must be implemented by all classes that should be used as recipients for MyTISM notifications and which basically represent only one recipient (as opposed to NotificationReceiverCollectionI which represents a group of recipients).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	$0

Fields inherited from interface de.ipcon.schema.BOI

ATT_Badge, ATT_Badge2, ATT_Badge3, ATT_Badge4, ATT_BLOBCreatedBy, ATT_BLOBCreatedOn, ATT_BLOBDeletedBy, ATT_BLOBDeletedOn, ATT_BLOBLastModifiedBy, ATT_BLOBLastModifiedOn, ATT_Bot, ATT_Crea, ATT_CreatedBy, ATT_CreatedModifiedText, ATT_Id, ATT_InvolvedInProcs, ATT_LastModifiedBy, ATT_Ldel, ATT_Lmod, ATT_Procs, EMPTY_ARRAY, ENT_BO

Method Summary

Modifier and Type	Method and Description
MyTISMAdresse[]	getAdressenInOrder(Transaction tx) Returns the concrete address or addresses to which the notification should actually be sent.
L10nLocale	getPreferredLocale() Returns the locale that should be used when interpreting subject and text body templates of the notification.
default boolean	hasValidMyTISMAdresseEmail() Returns true if the AdressenInOrder of this NotificationReceiverI contains at least one MyTISMAdresseEmail with an Email set.
boolean	isDeleted() Checks whether this BO has been marked as (soft) deleted and should therefore no longer be taken into account.
boolean	isNew() Checks whether this BO has been created recently.

Methods inherited from interface de.ipcon.db.notification.CryptoConfigurationProviderI

getOpenPGPPublicKey, getWillInlinePGP, getWillSignatur, getWillVerschluesselung

Methods inherited from interface de.ipcon.db.core.NotifiableI

asCoreBO, asFrappedCoreBO, byNames, byNames, describe, filterNotifiableI, getId, getOrCreateNotifiables, getUsersOrGroupsToNotify, getUsersOrGroupsToNotifyByCSV, getUsersOrGroupsToNotifyByEV

Methods inherited from interface de.ipcon.schema.BOI

bumpVersion, cancelCheckConstraints, consumeAndAssureTransientPropertyExists, contains, equalsBO, equalsBO, getAttribute, getAttribute, getBLOB, getBLOB, getBOVersion, getClazz, getCrea, getEntity, getEntity, getRootLoaderSchema, getSchema, getTransientProperty, hasBLOB, hasTransientProperty, hasTransientPropertyUnfiltered, isMandatory, isReadOnly, isSubEntityOf, isSubEntityOf, isTemporary, isVisible, setTransientProperty, toRelationMapRO

Methods inherited from interface de.ipcon.schema.Identifiable

collectIds, collectIds, getCommaSeparatedIdList, toMap, toMap

Methods inherited from interface de.ipcon.schema.DescribableI

collectDescribe, collectDescribe, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, describe, describe, describe, describeAndConciseDesc, describeAndConciseDesc, describeAndConciseDesc, describeAndConciseDesc, describeAndConciseDesc, describeNE, describeNE, join, join, join, notEmptyDescription

Field Detail

$0

static final java.lang.String $0

See Also:

Constant Field Values

Method Detail

getAdressenInOrder

MyTISMAdresse[] getAdressenInOrder(Transaction tx)

Returns the concrete address or addresses to which the notification should actually be sent. May return null or an empty array in which case the notification(s) will be redirected to the catchall recipient if any is configured for the MyTISM node; otherwise no notifications will be sent out for this NotificationReceiverI.

Parameters:

tx - a Transaction that must be used if the BOs that are returned by a given implementation of this method are created on the fly; since the returned BOs must be persistent (or will get persisted) for correct use by the notification system any BOs returned here that are not already persistent must be included in the given transaction and will be persisted automatically by the notification system. When this method is called by the notification system, a transaction will always be given; for other uses of/calls to this method tx may be null so implementations should not rely on a transaction being given

Returns:

an array of MyTISMAdresse instances to which the notification should actually be sent; may be null or empty

hasValidMyTISMAdresseEmail

default boolean hasValidMyTISMAdresseEmail()

Returns true if the AdressenInOrder of this NotificationReceiverI contains at least one MyTISMAdresseEmail with an Email set.

getPreferredLocale

L10nLocale getPreferredLocale()

Returns the locale that should be used when interpreting subject and text body templates of the notification. May return null in which case the system default (MyTISM or OS) will be used.

Returns:

the custom preferred L10nLocale to be used for interpreting the subject and text body templates; null to use system default

isNew

boolean isNew()

Description copied from interface: BOI

Checks whether this BO has been created recently. Recently in this case means: Its Id is null or negative or it is included in the transaction which created -and possibly already saved- this BO.

Specified by:

isNew in interface BOI

Returns:

true, if this BO is not yet persisted or has been created within the transaction it is included in. false otherwise, i.e. it was loaded from persistent storage.

isDeleted

boolean isDeleted()

Description copied from interface: BOI

Checks whether this BO has been marked as (soft) deleted and should therefore no longer be taken into account.

Specified by:

isDeleted in interface BOI

Returns:

true if this BO has its deleted flag set to true, false otherwise.