de.ipcon.db.core

Interface NotifiableI

All Superinterfaces:

BOI, DescribableI, Identifiable, SchemaProviderI

All Known Subinterfaces:

NotificationReceiverCollectionI, NotificationReceiverI

All Known Implementing Classes:

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

public interface NotifiableI
extends BOI

Common base interface for NotificationReceiverCollectionI and NotificationReceiverI because in a number of situations it is convenient to handle both in the same way.

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
default CoreBO	asCoreBO() Convenience method for casting NotifiableI instances to CoreBO.
default CoreBO	asFrappedCoreBO(Transaction tx) Convenience method for casting NotifiableI instances to CoreBO, using a passed transaction for frapping.
static java.util.Collection<NotifiableI>	byNames(BOQueryLoaderI boql, java.util.Collection<java.lang.String> names) Tries to get a Benutzer or Gruppe for each String contained in the passed list of names, loaded with the passed BOQueryLoaderI, and returns an immutable collection containing all existing NotifiableI-s (Benutzer / Gruppe) having one of those names.
static java.util.Collection<NotifiableI>	byNames(BOQueryLoaderI boql, java.lang.String namesCSV) Tries to get a Benutzer or Gruppe for each String contained in the passed comma separated list of names, loaded with the passed BOQueryLoaderI, and returns an immutable collection containing all existing NotifiableI-s (Benutzer / Gruppe) having one of those names.
java.lang.String	describe() Returns a nice description of this DescribableI.
static java.util.Collection<NotifiableI>	filterNotifiableI(java.util.Collection c) Returns a new Collection containing only instances from the passed Collection that are NotifiableI-s.
java.lang.Long	getId() Gets the internal Id of this Identifiable.
static java.util.Collection<NotifiableI>	getOrCreateNotifiables(Transaction tx, java.util.Collection<java.lang.String> emails) Static helper method for getting or creating new instances of MyTISMAdresseEmail for a passed collection of email strings.
static java.util.Collection<NotifiableI>	getUsersOrGroupsToNotify(BOQueryLoaderI boql, java.util.Collection<java.lang.String> groupTidsOrUserNames)
static java.util.Collection<NotifiableI>	getUsersOrGroupsToNotifyByCSV(BOQueryLoaderI boql, java.lang.String csv)
static java.util.Collection<NotifiableI>	getUsersOrGroupsToNotifyByEV(BOLoaderI bol, java.lang.String evName)

Methods inherited from interface de.ipcon.schema.BOI

bumpVersion, cancelCheckConstraints, consumeAndAssureTransientPropertyExists, contains, delete, equalsBO, equalsBO, filterDeleted, filterDeleted, filterDeleted, filterDeleted, filterDeletedAndReturnMap, filterDeletedAndReturnMap, getAttribute, getAttribute, getBLOB, getBLOB, getBOVersion, getClazz, getCrea, getEntity, getEntity, getRootLoaderSchema, getSchema, getTransientProperty, hasBLOB, hasTransientProperty, hasTransientPropertyUnfiltered, isDeleted, isMandatory, isNew, 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

getId

java.lang.Long getId()

Description copied from interface: Identifiable

Gets the internal Id of this Identifiable. The returned value can either be positive or negative in case of not yet persisted BOs. Can be null if the Identifiable is not completely initialized yet.

Specified by:

getId in interface Identifiable

Returns:

a Long with the unique Id of this Identifiable, nullable.

describe

java.lang.String describe()

Description copied from interface: DescribableI

Returns a nice description of this DescribableI. Format is specified in the schema.

Specified by:

describe in interface DescribableI

asCoreBO

default CoreBO asCoreBO()

Convenience method for casting NotifiableI instances to CoreBO.

Returns:

the current instance cast to CoreBO

asFrappedCoreBO

default CoreBO asFrappedCoreBO(Transaction tx)

Convenience method for casting NotifiableI instances to CoreBO, using a passed transaction for frapping.

Parameters:

tx - the transaction to be used for frapping

Returns:

the current instance cast to CoreBO, using the provided transaction for frapping

getOrCreateNotifiables

static java.util.Collection<NotifiableI> getOrCreateNotifiables(Transaction tx,
                                                                java.util.Collection<java.lang.String> emails)

Static helper method for getting or creating new instances of MyTISMAdresseEmail for a passed collection of email strings.

Parameters:

tx - the transaction to use for looking up existing or creating new instances

emails - a collection of email strings for which to get or create their corresponding NotifiableI instances (actually always MyTISMAdresseEmail).

Returns:

a collection of NotifiableI instances corresponding to the provided email strings

filterNotifiableI

static java.util.Collection<NotifiableI> filterNotifiableI(java.util.Collection c)

Returns a new Collection containing only instances from the passed Collection that are NotifiableI-s.

byNames

static java.util.Collection<NotifiableI> byNames(BOQueryLoaderI boql,
                                                 java.lang.String namesCSV)

Tries to get a Benutzer or Gruppe for each String contained in the passed comma separated list of names, loaded with the passed BOQueryLoaderI, and returns an immutable collection containing all existing NotifiableI-s (Benutzer / Gruppe) having one of those names.

byNames

static java.util.Collection<NotifiableI> byNames(BOQueryLoaderI boql,
                                                 java.util.Collection<java.lang.String> names)

Tries to get a Benutzer or Gruppe for each String contained in the passed list of names, loaded with the passed BOQueryLoaderI, and returns an immutable collection containing all existing NotifiableI-s (Benutzer / Gruppe) having one of those names.

getUsersOrGroupsToNotifyByEV

static java.util.Collection<NotifiableI> getUsersOrGroupsToNotifyByEV(BOLoaderI bol,
                                                                      java.lang.String evName)

Returns:

a collection of notification recipients as loaded from a CSV list stored in the given variable, representing the Tids of groups or the names of users.

getUsersOrGroupsToNotifyByCSV

static java.util.Collection<NotifiableI> getUsersOrGroupsToNotifyByCSV(BOQueryLoaderI boql,
                                                                       java.lang.String csv)

Returns:

a collection of notification recipients as loaded from a CSV list, representing the Tids of groups or the names of users.

getUsersOrGroupsToNotify

static java.util.Collection<NotifiableI> getUsersOrGroupsToNotify(BOQueryLoaderI boql,
                                                                  java.util.Collection<java.lang.String> groupTidsOrUserNames)

Returns:

a collection of notification recipients as loaded from a collection of Strings, representing the Tids of groups or the names of users.