com.canto.cumulus.db.trigger

Class TriggerManager

java.lang.Object

com.canto.cumulus.db.trigger.TriggerManager

public class TriggerManager
extends java.lang.Object

Manager to create, list and delete triggers.

Since:

7.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	SOURCE_TYPE_CATALOG
static int	SOURCE_TYPE_CATEGORIES
static int	SOURCE_TYPE_CATEGORY
static int	SOURCE_TYPE_RECORD
static int	SOURCE_TYPE_RECORDS
static int	SOURCE_TYPE_SERVER

Method Summary

Methods

Modifier and Type	Method and Description
void	addCatalogTrigger(Catalog catalog, Trigger trigger) Adds the given trigger as a catalog trigger.
void	addCategoriesTrigger(Catalog catalog, Trigger trigger) Adds the given trigger as a trigger for all categories of the specified catalog.
void	addItemTrigger(Item item, Trigger trigger) Adds the given trigger as a trigger for the specified item.
void	addRecordsTrigger(Catalog catalog, Trigger trigger) Adds the given trigger as a trigger for all records of the specified catalog.
void	addServerTrigger(Trigger trigger) Adds the given trigger as a server trigger.
Binding	createBinding(Catalog catalog) Returns a binding for the given catalog.
Binding	createBinding(Item item) Returns a binding for the given item.
Binding	createBindingForCategories(Catalog catalog) Returns a binding for the categories of the given catalog.
Binding	createBindingForRecords(Catalog catalog) Returns a binding for the records of the given catalog.
ActionESP	getActionESP(GUID guid) Returns the trigger action ESP for the given GUID.
GUID[]	getActionsAvailable(int condition) Returns an array of GUIDs of available action ESPs supporting the given condition.
java.util.Collection<Trigger>	getCatalogTriggers(Catalog catalog) Returns a collection of all existing triggers for the given catalog.
java.util.Collection<Trigger>	getCategoriesTriggers(Catalog catalog) Returns a collection of all existing triggers for all categories of the given catalog.
static TriggerManager	getInstance(Server server) Returns the trigger manager instance for the given server.
java.util.Collection<Trigger>	getItemTriggers(Item item) Returns a collection of all existing triggers for the given item.
java.util.Collection<Trigger>	getRecordsTriggers(Catalog catalog) Returns a collection of all existing triggers for all records of the given catalog.
Server	getServer() Returns the server of this connection.
java.util.Collection	getServerTriggers() Returns a collection of all existing server triggers.
void	removeCatalogTrigger(Catalog catalog, Trigger trigger) Removes the given trigger as a catalog trigger.
void	removeCategoriesTrigger(Catalog catalog, Trigger trigger) Removes the given trigger as a trigger for all categories of the specified catalog.
void	removeItemTrigger(Item item, Trigger trigger) Removes the given trigger as a trigger for the specified record.
void	removeRecordsTrigger(Catalog catalog, Trigger trigger) Removes the given trigger as a trigger for all records of the specified catalog.
void	removeServerTrigger(Trigger trigger) Removes the given trigger as a server trigger.

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_TYPE_SERVER

public static final int SOURCE_TYPE_SERVER

See Also:

Constant Field Values

SOURCE_TYPE_CATALOG

public static final int SOURCE_TYPE_CATALOG

See Also:

Constant Field Values

SOURCE_TYPE_RECORD

public static final int SOURCE_TYPE_RECORD

See Also:

Constant Field Values

SOURCE_TYPE_RECORDS

public static final int SOURCE_TYPE_RECORDS

See Also:

Constant Field Values

SOURCE_TYPE_CATEGORY

public static final int SOURCE_TYPE_CATEGORY

See Also:

Constant Field Values

SOURCE_TYPE_CATEGORIES

public static final int SOURCE_TYPE_CATEGORIES

See Also:

Constant Field Values

Method Detail

getInstance

public static TriggerManager getInstance(Server server)

Returns the trigger manager instance for the given server.

Parameters:

server - server to get the trigger manager for

Returns:

trigger manager

getServer

public Server getServer()

Returns the server of this connection.

Returns:

server

Since:

8.5

getActionESP

public ActionESP getActionESP(GUID guid)
                       throws CumulusException,
                              java.lang.ClassNotFoundException,
                              InvalidStateException

Returns the trigger action ESP for the given GUID.

Parameters:

guid - GUID of the trigger action

Returns:

instance of ActionESP or null if not found

Throws:

CumulusException - in case of an error

java.lang.ClassNotFoundException - class of the action ESP could not be found

InvalidStateException - in case of an error

getActionsAvailable

public GUID[] getActionsAvailable(int condition)
                           throws CumulusException,
                                  InvalidStateException

Returns an array of GUIDs of available action ESPs supporting the given condition. The supported conditions are ConditionTypes.CONDITION_TYPE_CATALOG_SETTINGS_CHANGED, ConditionTypes.CONDITION_TYPE_FIELD_VALUE_CHANGED, ConditionTypes.CONDITION_TYPE_RECORD_CATEGORY_ADDED and ConditionTypes.CONDITION_TYPE_RECORD_CATEGORY_DELETED.

Parameters:

condition - the condition wanted

Returns:

action ESP GUIDs supporting the condition.

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

addServerTrigger

public void addServerTrigger(Trigger trigger)
                      throws CumulusException,
                             InvalidStateException

Adds the given trigger as a server trigger.

Parameters:

trigger - the trigger to add

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

removeServerTrigger

public void removeServerTrigger(Trigger trigger)
                         throws CumulusException,
                                InvalidStateException

Removes the given trigger as a server trigger.

Parameters:

trigger - trigger to remove

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

getServerTriggers

public java.util.Collection getServerTriggers()
                                       throws CumulusException,
                                              InvalidStateException

Returns a collection of all existing server triggers.

Returns:

collection of Trigger instances

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

addCatalogTrigger

public void addCatalogTrigger(Catalog catalog,
                     Trigger trigger)
                       throws CumulusException,
                              InvalidStateException

Adds the given trigger as a catalog trigger.

Parameters:

catalog - the catalog to add the trigger for

trigger - the trigger to add

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

removeCatalogTrigger

public void removeCatalogTrigger(Catalog catalog,
                        Trigger trigger)
                          throws CumulusException,
                                 InvalidStateException

Removes the given trigger as a catalog trigger.

Parameters:

catalog - the catalog remove the trigger from

trigger - the trigger to remove

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

getCatalogTriggers

public java.util.Collection<Trigger> getCatalogTriggers(Catalog catalog)
                                                 throws CumulusException,
                                                        InvalidStateException

Returns a collection of all existing triggers for the given catalog.

Parameters:

catalog - the catalog to get all triggers for

Returns:

collection of Trigger instances

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

addRecordsTrigger

public void addRecordsTrigger(Catalog catalog,
                     Trigger trigger)
                       throws InvalidStateException,
                              CumulusException

Adds the given trigger as a trigger for all records of the specified catalog.

Parameters:

catalog - the catalog to add the trigger for

trigger - the trigger to add

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

removeRecordsTrigger

public void removeRecordsTrigger(Catalog catalog,
                        Trigger trigger)
                          throws InvalidStateException,
                                 CumulusException

Removes the given trigger as a trigger for all records of the specified catalog.

Parameters:

catalog - the catalog to remove the trigger from

trigger - the trigger to remove

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

createBinding

public Binding createBinding(Item item)

Returns a binding for the given item.

Parameters:

item - item to create the binding for

Returns:

instance of Binding

Since:

8 .0

createBinding

public Binding createBinding(Catalog catalog)

Returns a binding for the given catalog.

Parameters:

catalog - catalog to create the binding for

Returns:

instance of Binding

createBindingForRecords

public Binding createBindingForRecords(Catalog catalog)

Returns a binding for the records of the given catalog.

Parameters:

catalog - catalog to create the binding for all contained records

Returns:

instance of Binding

createBindingForCategories

public Binding createBindingForCategories(Catalog catalog)

Returns a binding for the categories of the given catalog.

Parameters:

catalog - catalog to create the binding for all contained categories

Returns:

instance of Binding

getRecordsTriggers

public java.util.Collection<Trigger> getRecordsTriggers(Catalog catalog)
                                                 throws CumulusException,
                                                        InvalidStateException

Returns a collection of all existing triggers for all records of the given catalog.

Parameters:

catalog - the catalog to get all triggers for

Returns:

collection of Trigger instances

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

addCategoriesTrigger

public void addCategoriesTrigger(Catalog catalog,
                        Trigger trigger)
                          throws CumulusException,
                                 InvalidStateException

Adds the given trigger as a trigger for all categories of the specified catalog.

Parameters:

catalog - the catalog to add the trigger for

trigger - the trigger to add

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

removeCategoriesTrigger

public void removeCategoriesTrigger(Catalog catalog,
                           Trigger trigger)
                             throws CumulusException,
                                    InvalidStateException

Removes the given trigger as a trigger for all categories of the specified catalog.

Parameters:

catalog - the catalog to remove the trigger from

trigger - the trigger to remove

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

getCategoriesTriggers

public java.util.Collection<Trigger> getCategoriesTriggers(Catalog catalog)
                                                    throws CumulusException,
                                                           InvalidStateException

Returns a collection of all existing triggers for all categories of the given catalog.

Parameters:

catalog - the catalog to get all triggers for

Returns:

collection of Trigger instances

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

addItemTrigger

public void addItemTrigger(Item item,
                  Trigger trigger)
                    throws InvalidStateException,
                           CumulusException

Adds the given trigger as a trigger for the specified item.

Parameters:

item - the item to add the trigger for

trigger - the trigger to add

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

Since:

8.0

removeItemTrigger

public void removeItemTrigger(Item item,
                     Trigger trigger)
                       throws InvalidStateException,
                              CumulusException

Removes the given trigger as a trigger for the specified record.

Parameters:

item - the item to remove the trigger from

trigger - the trigger to add

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

Since:

8.0

getItemTriggers

public java.util.Collection<Trigger> getItemTriggers(Item item)
                                              throws CumulusException,
                                                     InvalidStateException

Returns a collection of all existing triggers for the given item.

Parameters:

item - the item to get all triggers for

Returns:

collection of Trigger instances

Throws:

CumulusException - in case of an error

InvalidStateException - in case of an error

Since:

8.0