li.strolch.persistence.api

Interface StrolchTransaction

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractTransaction, InMemoryTransaction

public interface StrolchTransaction
extends AutoCloseable

StrolchTransaction is the central element in Strolch. It gives the developer access to the Strolch model and performs all the required actions to keep the model consistent etc.

A Strolch transaction is performed as follows as it is an AutoCloseable implementation

StrolchAgent strolchAgent = getStrolchAgent(); StrolchRealm realm = strolchAgent.getContainer().getRealm(StrolchConstants.DEFAULT_REALM); try(StrolchTransaction tx = realm.openTx(certificate, getClass())){ // do work e.g. add commands tx.commitOnClose(); }

A StrolchTransaction is always opened for a specific realm, should no specific realms be configured, then the StrolchConstants.DEFAULT_REALM is automatically created.

A StrolchTransaction takes care of the following:

• Opening and closing database connections
• Releasing locks to strolch elements, if lock(StrolchRootElement) is used
• Performing Commands correctly
• exception handling
• auditing
• updating observers

Author:

Robert von Burg

See Also:

AbstractTransaction

Method Summary

Modifier and Type	Method and Description
void	addCommand(Command command) Adds the given Command to the transaction.
Audit	auditFrom(AccessType accessType, String elementType, String elementSubType, String id) Helper method to create an Audit with the given arguments.
Audit	auditFrom(AccessType accessType, StrolchRootElement element) Helper method to create an Audit with the given arguments.
void	autoCloseableCommit() DO NOT CALL THIS METHOD.
void	autoCloseableDoNothing() DO NOT CALL THIS METHOD.
void	autoCloseableRollback() DO NOT CALL THIS METHOD.
void	close() DO NOT CALL THIS METHOD.
void	commitOnClose() Sets the TransactionCloseStrategy to TransactionCloseStrategy.COMMIT
void	doNothingOnClose() Sets the TransactionCloseStrategy to TransactionCloseStrategy.DO_NOTHING
<U> List<U>	doQuery(ActivityQuery<U> query) Performs the given ActivityQuery and each returned Activity is passed through the ActivityVisitor attached to the ActivityQuery and the return value of the visitor is added to the return list
<U> List<U>	doQuery(AuditQuery<U> query) Performs the given AuditQuery and each returned Audit is passed through the AuditVisitor attached to the AuditQuery and the return value of the visitor is added to the return list
<U> List<U>	doQuery(OrderQuery<U> query) Performs the given OrderQuery and each returned Order is passed through the OrderVisitor attached to the OrderQuery and the return value of the visitor is added to the return list
<U> List<U>	doQuery(ResourceQuery<U> query) Performs the given ResourceQuery and each returned Resource is passed through the ResourceVisitor attached to the ResourceQuery and the return value of the visitor is added to the return list
StrolchTransactionException	fail(String exceptionMessage) Sets the TransactionCloseStrategy to TransactionCloseStrategy.ROLLBACK and returns a StrolchTransactionException which can be thrown by the caller to stop the exception
<T extends StrolchElement> T	findElement(Locator locator) Used to find a StrolchElement by a Locator.
void	flush() Performs all registered commands
List<Activity>	getActivitiesBy(StringListParameter refP) Returns all Activities which are referenced by the given StringListParameter.
List<Activity>	getActivitiesBy(StringListParameter refP, boolean assertExists) Returns all Activities which are referenced by the given StringListParameter.
Activity	getActivityBy(StringParameter refP) Returns the Activity which is referenced by the given StringParameter.
Activity	getActivityBy(StringParameter refP, boolean assertExists) Returns the Activity which is referenced by the given StringParameter.
Activity	getActivityBy(String type, String id) Returns the Activity with the given type and id, or null if it does not exist
Activity	getActivityBy(String type, String id, boolean assertExists) Returns the Activity with the given type and id, or null if it does not exist
ActivityMap	getActivityMap() Returns a reference to the ActivityMap for the StrolchRealm for which this transaction was opened
Activity	getActivityTemplate(String type) Returns a copy of the Activity of Type StrolchConstants.TEMPLATE with the given type as id, or null if it does not exist
Activity	getActivityTemplate(String type, boolean assertExists) Returns a copy of the Activity of Type StrolchConstants.TEMPLATE with the given type as id.
AuditTrail	getAuditTrail() Returns a reference to the AuditTrail for the StrolchRealm for which this transaction was opened
Certificate	getCertificate() Returns the Certificate which allowed this TX to be opened
TransactionCloseStrategy	getCloseStrategy() Returns the currently set TransactionCloseStrategy
Order	getOrderBy(StringParameter refP) Returns the Order which is referenced by the given StringParameter.
Order	getOrderBy(StringParameter refP, boolean assertExists) Returns the Order which is referenced by the given StringParameter.
Order	getOrderBy(String type, String id) Returns the Order with the given type and id, or null if it does not exist
Order	getOrderBy(String type, String id, boolean assertExists) Returns the Order with the given type and id, or null if it does not exist
OrderMap	getOrderMap() Returns a reference to the OrderMap for the StrolchRealm for which this transaction was opened
List<Order>	getOrdersBy(StringListParameter refP) Returns all Orders which are referenced by the given StringListParameter.
List<Order>	getOrdersBy(StringListParameter refP, boolean assertExists) Returns all Orders which are referenced by the given StringListParameter.
Order	getOrderTemplate(String type) Returns a copy of the Order of Type StrolchConstants.TEMPLATE with the given type as id, or null if it does not exist
Order	getOrderTemplate(String type, boolean assertExists) Returns a copy of the Order of Type StrolchConstants.TEMPLATE with the given type as id.
PersistenceHandler	getPersistenceHandler() Returns the PersistenceHandler.
String	getRealmName() Returns the name of the StrolchRealm for which this transaction was opened
Resource	getResourceBy(StringParameter refP) Returns the Resource which is referenced by the given StringParameter.
Resource	getResourceBy(StringParameter refP, boolean assertExists) Returns the Resource which is referenced by the given StringParameter.
Resource	getResourceBy(String type, String id) Returns the Resource with the given type and id, or null if it does not exist
Resource	getResourceBy(String type, String id, boolean assertExists) Returns the Resource with the given type and id, or null if it does not exist
ResourceMap	getResourceMap() Returns a reference to the ResourceMap for the StrolchRealm for which this transaction was opened
List<Resource>	getResourcesBy(StringListParameter refP) Returns all Resources which are referenced by the given StringListParameter.
List<Resource>	getResourcesBy(StringListParameter refP, boolean assertExists) Returns all Resources which are referenced by the given StringListParameter.
Resource	getResourceTemplate(String type) Returns a copy of the Resource of Type StrolchConstants.TEMPLATE with the given type as id, or null if it does not exist
Resource	getResourceTemplate(String type, boolean assertExists) Returns a copy of the Resource of Type StrolchConstants.TEMPLATE with the given type as id.
TransactionState	getState()
boolean	isClosing()
boolean	isCommitting()
boolean	isRollingBack()
boolean	isSuppressAudits() Returns true if writing Audits is currently suppressed
boolean	isSuppressDoNothingLogging() Returns true if logging of a TransactionCloseStrategy.DO_NOTHING should be suppressed
boolean	isSuppressUpdates() Returns true if the observer updates are currently suppressed
boolean	isVersioningEnabled() Returns true if versioning is enabled on the StrolchRealm for which this transaction has been opened
<T extends StrolchRootElement> void	lock(T element) Locks the given element and registers it on the transaction so the lock is released when the transaction is closed
<T extends StrolchRootElement> void	releaseLock(T element) Releases the lock of the given element so that even though the transaction is still open, another thread/transaction can lock the element
void	rollbackOnClose() Sets the TransactionCloseStrategy to TransactionCloseStrategy.ROLLBACK
void	setSuppressAudits(boolean suppressAudits) If the given argument is true, then no Audits are written
void	setSuppressDoNothingLogging(boolean suppressDoNothingLogging) If the given argument is true, then logging of a TransactionCloseStrategy.DO_NOTHING will be suppressed
void	setSuppressUpdates(boolean suppressUpdates) If the given argument is true, then no observer updates are performed

Method Detail

getRealmName

String getRealmName()

Returns the name of the StrolchRealm for which this transaction was opened

Returns:

the name of the StrolchRealm for which this transaction was opened

getCertificate

Certificate getCertificate()

Returns the Certificate which allowed this TX to be opened

Returns:

the Certificate which allowed this TX to be opened

getAuditTrail

AuditTrail getAuditTrail()

Returns a reference to the AuditTrail for the StrolchRealm for which this transaction was opened

Returns:

the AuditTrail

getResourceMap

ResourceMap getResourceMap()

Returns a reference to the ResourceMap for the StrolchRealm for which this transaction was opened

Returns:

the ResourceMap

getOrderMap

OrderMap getOrderMap()

Returns a reference to the OrderMap for the StrolchRealm for which this transaction was opened

Returns:

the OrderMap

getActivityMap

ActivityMap getActivityMap()

Returns a reference to the ActivityMap for the StrolchRealm for which this transaction was opened

Returns:

the ActivityMap

getPersistenceHandler

PersistenceHandler getPersistenceHandler()

Returns the PersistenceHandler. If the StrolchRealm is not running in DataStoreMode.TRANSIENT mode, then the PersistenceHandler will be a StrolchComponent, otherwise it will be the internal in memory persistence handler

Returns:

the PersistenceHandler

getCloseStrategy

TransactionCloseStrategy getCloseStrategy()

Returns the currently set TransactionCloseStrategy

Returns:

the currently set TransactionCloseStrategy

autoCloseableDoNothing

void autoCloseableDoNothing()
                     throws StrolchTransactionException

DO NOT CALL THIS METHOD. If the currently set close strategy is TransactionCloseStrategy.DO_NOTHING, then when the transaction is closed, this method is called no changes to the model is performed but locks on objects are released and any other resources are released

Throws:

StrolchTransactionException

autoCloseableCommit

void autoCloseableCommit()
                  throws StrolchTransactionException

DO NOT CALL THIS METHOD. If the currently set close strategy is TransactionCloseStrategy.COMMIT, then when the transaction is closed, this method is called and all registered Command are performed, locks on objects are released and any other resources are released

Throws:

StrolchTransactionException

autoCloseableRollback

void autoCloseableRollback()
                    throws StrolchTransactionException

DO NOT CALL THIS METHOD. If the currently set close strategy is TransactionCloseStrategy.ROLLBACK, then when the transaction is closed, no further actions are performed and any Command which were performed have their Command.undo() method called and any DB connections are also rolled back

Throws:

StrolchTransactionException

close

void close()
    throws StrolchTransactionException

DO NOT CALL THIS METHOD. This interface implements AutoCloseable and transactions are expected to be used in a auto closing try block:

StrolchAgent strolchAgent = getStrolchAgent(); StrolchRealm realm = strolchAgent.getContainer().getRealm("defaultRealm"); try(StrolchTransaction tx = realm.openTx(certificate, getClass())){ // do work tx.commitOnClose(); } After the block is closed, the transaction is automatically closed and all allocated resources are released

Specified by:

close in interface AutoCloseable

Throws:

StrolchTransactionException

doNothingOnClose

void doNothingOnClose()

Sets the TransactionCloseStrategy to TransactionCloseStrategy.DO_NOTHING

commitOnClose

void commitOnClose()

Sets the TransactionCloseStrategy to TransactionCloseStrategy.COMMIT

rollbackOnClose

void rollbackOnClose()

Sets the TransactionCloseStrategy to TransactionCloseStrategy.ROLLBACK

fail

StrolchTransactionException fail(String exceptionMessage)

Sets the TransactionCloseStrategy to TransactionCloseStrategy.ROLLBACK and returns a StrolchTransactionException which can be thrown by the caller to stop the exception

Parameters:

exceptionMessage -

Returns:

a StrolchTransactionException to be thrown by the caller

flush

void flush()

Performs all registered commands

This method does not release any locks, nor does it notify any observers

getState

TransactionState getState()

Returns:

the current state of the transaction

See Also:

TransactionState

isRollingBack

boolean isRollingBack()

Returns:

if the current state of the StrolchTransaction is TransactionState.ROLLING_BACK

isCommitting

boolean isCommitting()

Returns:

if the current state of the StrolchTransaction is TransactionState.COMMITTING

isClosing

boolean isClosing()

Returns:

if the current state of the StrolchTransaction is TransactionState.CLOSING

setSuppressUpdates

void setSuppressUpdates(boolean suppressUpdates)

If the given argument is true, then no observer updates are performed

Parameters:

suppressUpdates - true to suppress the updates, false to enable them

isSuppressUpdates

boolean isSuppressUpdates()

Returns true if the observer updates are currently suppressed

Returns:

true if the observer updates are currently suppressed

setSuppressAudits

void setSuppressAudits(boolean suppressAudits)

If the given argument is true, then no Audits are written

Parameters:

suppressAudits - true to suppress writing Audits, false to enable them

isSuppressAudits

boolean isSuppressAudits()

Returns true if writing Audits is currently suppressed

Returns:

true if writing Audits is currently suppressed

setSuppressDoNothingLogging

void setSuppressDoNothingLogging(boolean suppressDoNothingLogging)

If the given argument is true, then logging of a TransactionCloseStrategy.DO_NOTHING will be suppressed

Parameters:

SuppressDoNothingLogging - true to suppress logging of a TransactionCloseStrategy.DO_NOTHING, false to enable logging

isSuppressDoNothingLogging

boolean isSuppressDoNothingLogging()

Returns true if logging of a TransactionCloseStrategy.DO_NOTHING should be suppressed

Returns:

true if logging of a TransactionCloseStrategy.DO_NOTHING should be suppressed

isVersioningEnabled

boolean isVersioningEnabled()

Returns true if versioning is enabled on the StrolchRealm for which this transaction has been opened

Returns:

true if versioning is enabled

lock

<T extends StrolchRootElement> void lock(T element)
                                  throws StrolchLockException

Locks the given element and registers it on the transaction so the lock is released when the transaction is closed

Parameters:

element - the element to lock

Throws:

StrolchLockException

releaseLock

<T extends StrolchRootElement> void releaseLock(T element)
                                         throws StrolchLockException

Releases the lock of the given element so that even though the transaction is still open, another thread/transaction can lock the element

Parameters:

element - the element for which the lock is to be released

Throws:

StrolchLockException

addCommand

void addCommand(Command command)

Adds the given Command to the transaction. Using this method guarantees that a Command is executed properly:

• Command.validate()
• Command.doCommand()

and if an exception occurs:

• Command.undo()

Parameters:

command -

auditFrom

Audit auditFrom(AccessType accessType,
                String elementType,
                String elementSubType,
                String id)

Helper method to create an Audit with the given arguments. The audit can then be saved by calling AuditTrail.add(StrolchTransaction, Audit)

Parameters:

accessType - the type of access

elementType - the element type, i.e. Tags.RESOURCE, Tags.ORDER

elementType - the element sub type, e.g. GroupedParameterizedElement.getType()

id - the id of the element audited

Returns:

the new audit

auditFrom

Audit auditFrom(AccessType accessType,
                StrolchRootElement element)

Helper method to create an Audit with the given arguments. The audit can then be saved by calling AuditTrail.add(StrolchTransaction, Audit)

Parameters:

accessType - the type of access

element - the element from which to to create the audit

Returns:

the new audit

doQuery

<U> List<U> doQuery(OrderQuery<U> query)

Performs the given OrderQuery and each returned Order is passed through the OrderVisitor attached to the OrderQuery and the return value of the visitor is added to the return list

Parameters:

query - the query to perform

Returns:

the result list of elements as returned by the OrderVisitor, never null

doQuery

<U> List<U> doQuery(ResourceQuery<U> query)

Performs the given ResourceQuery and each returned Resource is passed through the ResourceVisitor attached to the ResourceQuery and the return value of the visitor is added to the return list

Parameters:

query - the query to perform

Returns:

the result list of elements as returned by the ResourceVisitor, never null

doQuery

<U> List<U> doQuery(ActivityQuery<U> query)

Performs the given ActivityQuery and each returned Activity is passed through the ActivityVisitor attached to the ActivityQuery and the return value of the visitor is added to the return list

Parameters:

query - the query to perform

Returns:

the result list of elements as returned by the ActivityVisitor, never null

doQuery

<U> List<U> doQuery(AuditQuery<U> query)

Performs the given AuditQuery and each returned Audit is passed through the AuditVisitor attached to the AuditQuery and the return value of the visitor is added to the return list

Parameters:

query - the query to perform

Returns:

the result list of elements as returned by the AuditVisitor, never null

findElement

<T extends StrolchElement> T findElement(Locator locator)
                                  throws StrolchException,
                                         ClassCastException

Used to find a StrolchElement by a Locator.

A Locator has the form <ObjectClassType>/<Type>/<Id> - this is the least amount of path elements to find an object. Thus to query a Resource of type "MyType" and the id "@1" use the following path: Resourcee/MyType/@1

This method can also be used to find a deeper element, e.g. a specific Parameter on an ParameterBag on an Order. This would be done as follows: Order/MyType/@1/myParam

Parameters:

locator - the locator defining the path to the element which is to be found

Returns:

the element described by the locator. If Locator references an element which does not exist, i.e. an inexistant Resource or an inexistand Parameter on a Resource, then a StrolchException is thrown

Throws:

StrolchException - if the element could not be found

ClassCastException - if the querying code is not asking for the correct instance. Do not query a Parameter if the variable to which the result is to be is stored is a Resource, etc.

getResourceTemplate

Resource getResourceTemplate(String type)

Returns a copy of the Resource of Type StrolchConstants.TEMPLATE with the given type as id, or null if it does not exist

Templates are StrolchRootElements which have the type StrolchConstants.TEMPLATE and their id is the type of element for which it is a template. For instance when creating a Resource of type Person then having a template with the id Person helps creating new Person resources; get the resource and then create a clone: Resource.getClone()

Parameters:

type - the id of the Resource template

Returns:

the copy of the Resource template with the given id, or null if it does not exist

getResourceTemplate

Resource getResourceTemplate(String type,
                             boolean assertExists)
                      throws StrolchException

Returns a copy of the Resource of Type StrolchConstants.TEMPLATE with the given type as id. If assertExists is true, then an exception is thrown if the template does not exist does not exist

Templates are StrolchRootElements which have the type StrolchConstants.TEMPLATE and their id is the type of element for which it is a template. For instance when creating a Resource of type Person then having a template with the id Person helps creating new Person resources; get the resource and then create a clone: Resource.getClone()

Parameters:

type - the id of the Resource template

Returns:

the copy of the Resource template with the given id, or if assertExists is true, then an exception is thrown if the resource does not exist

Throws:

StrolchException

getOrderTemplate

Order getOrderTemplate(String type)

Returns a copy of the Order of Type StrolchConstants.TEMPLATE with the given type as id, or null if it does not exist

Templates are StrolchRootElements which have the type StrolchConstants.TEMPLATE and their id is the type of element for which it is a template. For instance when creating an Order of type PurchaseOrder then having a template with the id PurchaseOrder helps creating new PurchaseOrder orders; get the order and then create a clone: Order.getClone()

Parameters:

type - the id of the Order template

Returns:

the copy of the Order template with the given id, or null if it does not exist

getOrderTemplate

Order getOrderTemplate(String type,
                       boolean assertExists)
                throws StrolchException

Returns a copy of the Order of Type StrolchConstants.TEMPLATE with the given type as id. If assertExists is true, then an exception is thrown if the template does not exist does not exist

Templates are StrolchRootElements which have the type StrolchConstants.TEMPLATE and their id is the type of element for which it is a template. For instance when creating an Order of type PurchaseOrder then having a template with the id PurchaseOrder helps creating new PurchaseOrder orders; get the order and then create a clone: Order.getClone()

Parameters:

type - the id of the Order template

Returns:

the copy of the Order template with the given id, or if assertExists is true, then an exception is thrown if the order does not exist

Throws:

StrolchException

getActivityTemplate

Activity getActivityTemplate(String type)

Returns a copy of the Activity of Type StrolchConstants.TEMPLATE with the given type as id, or null if it does not exist

Templates are StrolchRootElements which have the type StrolchConstants.TEMPLATE and their id is the type of element for which it is a template. For instance when creating a Activity of type ToStock then having a template with the id ToStock helps creating new ToStock activities; get the activity and then create a clone: Activity.getClone()

Parameters:

type - the id of the Activity template

Returns:

the copy of the Activity template with the given id, or null if it does not exist

getActivityTemplate

Activity getActivityTemplate(String type,
                             boolean assertExists)
                      throws StrolchException

Returns a copy of the Activity of Type StrolchConstants.TEMPLATE with the given type as id. If assertExists is true, then an exception is thrown if the template does not exist does not exist

Templates are StrolchRootElements which have the type StrolchConstants.TEMPLATE and their id is the type of element for which it is a template. For instance when creating a Activity of type ToStock then having a template with the id ToStock helps creating new ToStock activities; get the activity and then create a clone: Activity.getClone()

Parameters:

type - the id of the Activity template

Returns:

the copy of the Activity template with the given id, or if assertExists is true, then an exception is thrown if the activity does not exist

Throws:

StrolchException

getResourceBy

Resource getResourceBy(String type,
                       String id)

Returns the Resource with the given type and id, or null if it does not exist

Parameters:

type - the type of the Resource

id - the id of the Resource

Returns:

the Resource with the given type and id, or null if it does not exist

getResourceBy

Resource getResourceBy(String type,
                       String id,
                       boolean assertExists)
                throws StrolchException

Returns the Resource with the given type and id, or null if it does not exist

Parameters:

type - the type of the Resource

id - the id of the Resource

assertExists - if true, and resource does not exist, then a StrolchException is thrown

Returns:

the Resource with the given type and id, or null if it does not exist

Throws:

StrolchException - if the resource does not exist, and assertExists is true

getResourceBy

Resource getResourceBy(StringParameter refP)
                throws StrolchException

Returns the Resource which is referenced by the given StringParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_RESOURCE_REF and the UOM must be set to the resource's type and the value is the id of the resource

Parameters:

refP - the StringParameter which references a Resource

Returns:

the resource referenced by the parameter, or null if it does not exist

Throws:

StrolchException - if the StringParameter is not a properly configured as a reference parameter

getResourceBy

Resource getResourceBy(StringParameter refP,
                       boolean assertExists)
                throws StrolchException

Returns the Resource which is referenced by the given StringParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_RESOURCE_REF and the UOM must be set to the resource's type and the value is the id of the resource

Parameters:

refP - the StringParameter which references a Resource

assertExists - if true, and resource does not exist, then a StrolchException is thrown

Returns:

the resource referenced by the parameter, or null if it does not exist

Throws:

StrolchException - if the StringParameter is not a properly configured as a reference parameter, or if the resource does not exist, and assertExists is true

getResourcesBy

List<Resource> getResourcesBy(StringListParameter refP)
                       throws StrolchException

Returns all Resources which are referenced by the given StringListParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_RESOURCE_REF and the UOM must be set to the resource's type and the value is the id of the resource

Parameters:

refP - the StringListParameter which references a list of Resources

Returns:

the resources referenced by the parameter, or the empty list if they do not exist. Note: Any missing resources are not returned!

Throws:

StrolchException - if the StringListParameter is not a properly configured as a reference parameter

getResourcesBy

List<Resource> getResourcesBy(StringListParameter refP,
                              boolean assertExists)
                       throws StrolchException

Returns all Resources which are referenced by the given StringListParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_RESOURCE_REF and the UOM must be set to the resource's type and the value is the id of the resource

Parameters:

refP - the StringListParameter which references a list of Resources

assertExists - if true, and resource does not exist, then a StrolchException is thrown

Returns:

the resources referenced by the parameter, or the empty list if they do not exist. Note: Any missing resources are not returned unless assertExists is true

Throws:

StrolchException - if the StringListParameter is not a properly configured as a reference parameter

getActivityBy

Activity getActivityBy(String type,
                       String id)

Returns the Activity with the given type and id, or null if it does not exist

Parameters:

type - the type of the Activity

id - the id of the Activity

Returns:

the Activity with the given type and id, or null if it does not exist

getActivityBy

Activity getActivityBy(String type,
                       String id,
                       boolean assertExists)
                throws StrolchException

Returns the Activity with the given type and id, or null if it does not exist

Parameters:

type - the type of the Activity

id - the id of the Activity

assertExists - if true, and activity does not exist, then a StrolchException is thrown

Returns:

the Activity with the given type and id, or null if it does not exist

Throws:

StrolchException - if the activity does not exist, and assertExists is true

getActivityBy

Activity getActivityBy(StringParameter refP)
                throws StrolchException

Returns the Activity which is referenced by the given StringParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_ACTIVITY_REF and the UOM must be set to the activity's type and the value is the id of the activity

Parameters:

refP - the StringParameter which references an Activity

Returns:

the activity referenced by the parameter, or null if it does not exist

Throws:

StrolchException - if the StringParameter is not a properly configured as a reference parameter

getActivityBy

Activity getActivityBy(StringParameter refP,
                       boolean assertExists)
                throws StrolchException

Returns the Activity which is referenced by the given StringParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_ACTIVITY_REF and the UOM must be set to the activity's type and the value is the id of the activity

Parameters:

refP - the StringParameter which references an Activity

assertExists - if true, and activity does not exist, then a StrolchException is thrown

Returns:

the activity referenced by the parameter, or null if it does not exist

Throws:

StrolchException - if the StringParameter is not a properly configured as a reference parameter, or if the activity does not exist, and assertExists is true

getActivitiesBy

List<Activity> getActivitiesBy(StringListParameter refP)
                        throws StrolchException

Returns all Activities which are referenced by the given StringListParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_ACTIVITY_REF and the UOM must be set to the activity's type and the value is the id of the activity

Parameters:

refP - the StringListParameter which references a list of Activities

Returns:

the activities referenced by the parameter, or the empty list if they do not exist. Note: Any missing activities are not returned!

Throws:

StrolchException - if the StringListParameter is not a properly configured as a reference parameter

getActivitiesBy

List<Activity> getActivitiesBy(StringListParameter refP,
                               boolean assertExists)
                        throws StrolchException

Returns all Activities which are referenced by the given StringListParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_ACTIVITY_REF and the UOM must be set to the activity's type and the value is the id of the activity

Parameters:

refP - the StringListParameter which references a list of Activities

assertExists - if true, and activity does not exist, then a StrolchException is thrown

Returns:

the activities referenced by the parameter, or the empty list if they do not exist. Note: Any missing activities are not returned unless assertExists is true

Throws:

StrolchException - if the StringListParameter is not a properly configured as a reference parameter

getOrderBy

Order getOrderBy(String type,
                 String id)

Returns the Order with the given type and id, or null if it does not exist

Parameters:

type - the type of the Order

id - the id of the Order

Returns:

the Order with the given type and id, or null if it does not exist

getOrderBy

Order getOrderBy(String type,
                 String id,
                 boolean assertExists)
          throws StrolchException

Returns the Order with the given type and id, or null if it does not exist

Parameters:

type - the type of the Order

id - the id of the Order

assertExists - if true, and order does not exist, then a StrolchException is thrown

Returns:

the Order with the given type and id, or null if it does not exist

Throws:

StrolchException - if the order does not exist, and assertExists is true

getOrderBy

Order getOrderBy(StringParameter refP)
          throws StrolchException

Returns the Order which is referenced by the given StringParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_ORDER_REF and the UOM must be set to the order's type and the value is the id of the order

Parameters:

refP - the StringParameter which references an Order

Returns:

the order referenced by the parameter, or null if it does not exist

Throws:

StrolchException - if the StringParameter is not a properly configured as a reference parameter

getOrderBy

Order getOrderBy(StringParameter refP,
                 boolean assertExists)
          throws StrolchException

Returns the Order which is referenced by the given StringParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_ORDER_REF and the UOM must be set to the order's type and the value is the id of the order

Parameters:

refP - the StringParameter which references an Order

assertExists - if true, and order does not exist, then a StrolchException is thrown

Returns:

the order referenced by the parameter, or null if it does not exist

Throws:

StrolchException - if the StringParameter is not a properly configured as a reference parameter, or if the order does not exist, and assertExists is true

getOrdersBy

List<Order> getOrdersBy(StringListParameter refP)
                 throws StrolchException

Returns all Orders which are referenced by the given StringListParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_ORDER_REF and the UOM must be set to the order's type and the value is the id of the order

Parameters:

refP - the StringListParameter which references a list of Orders

Returns:

the orders referenced by the parameter, or the empty list if they do not exist. Note: Any missing orders are not returned!

Throws:

StrolchException - if the StringListParameter is not a properly configured as a reference parameter

getOrdersBy

List<Order> getOrdersBy(StringListParameter refP,
                        boolean assertExists)
                 throws StrolchException

Returns all Orders which are referenced by the given StringListParameter. A reference Parameter must have its interpretation set to StrolchConstants.INTERPRETATION_ORDER_REF and the UOM must be set to the order's type and the value is the id of the order

Parameters:

refP - the StringListParameter which references a list of Orders

assertExists - if true, and order does not exist, then a StrolchException is thrown

Returns:

the orders referenced by the parameter, or the empty list if they do not exist. Note: Any missing orders are not returned unless assertExists is true

Throws:

StrolchException - if the StringListParameter is not a properly configured as a reference parameter