Package com.e1c.g5.v8.dt.check.context

Class CheckContextCollectingSession

java.lang.Object

com.e1c.g5.v8.dt.check.context.CheckContextCollectingSession

public final class CheckContextCollectingSession
extends Object

The session which must be used by ICheck developers to react on data changes and schedule the check to run, as the part of com.e1c.g5.v8.dt.check.context.*ContextCollector call lifecycle. To schedule the check the developer should call one of add*Check methods of this class. This class is instantiated by the check engine and must not be instantiated by check developers. Technically is a IContextCollectingSession wrapper that limits the ability of users to operate with DD contexts with only necessary operations/scopes. It helps to prevent check developers from overloading the system with cross- activated checks, etc

Constructor Summary

Constructors

Constructor	Description
CheckContextCollectingSession(String checkId, CheckComplexity complexity, boolean criticalDataIntegrityCheck, IContextCollectingSession session)	Constructs an instance of the session

Method Summary

Modifier and Type	Method	Description
void	addFullCheck(IBmObject modelObject)	Schedule a full model check for a given object (starting from the corresponding top object) and a current check.
void	addLanguageCheck(String moduleUri)	Schedules a language check for the given language module
void	addModelCheck(IBmObject modelObject)	Schedule a model check for the given model object.
void	addModelCheck(IBmObject modelObject, Map<String,String> additionalContext)	Schedule a model check for the given model object.
Map<String,String>	getAdditionalContext(IBmObject modelObject)	Gets a current state of an additional context being collected at the moment

Methods inherited from class java.lang.Object

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

Constructor Details

CheckContextCollectingSession

public CheckContextCollectingSession(String checkId,
 CheckComplexity complexity,
 boolean criticalDataIntegrityCheck,
 IContextCollectingSession session)

Constructs an instance of the session

Parameters:

checkId - The identifier of the check the session is being constructed. May not be null

complexity - The complexity of the check. May not be null

criticalDataIntegrityCheck - The critical data integrity check flag

session - The DD context collecting session. May not be null

Method Details

addLanguageCheck

public void addLanguageCheck(String moduleUri)

Schedules a language check for the given language module

Parameters:

moduleUri - The module to schedule the check for. May not be null

addModelCheck

public void addModelCheck(IBmObject modelObject,
 Map<String,String> additionalContext)

Schedule a model check for the given model object.

Parameters:

modelObject - The model object to add the check for. May not be null. The object should be received from the context object being provided by ACC via the OnModelObjectAssociationContextCollector.collectContextOnObjectAssociation(IBmObject, com._1c.g5.v8.bm.core.event.BmSubEvent, CheckContextCollectingSession) or or be attached to the transaction being collected from the context object

additionalContext - Additional context which may be supplied to the check execution stage. Cannot be null, may be empty

addModelCheck

public void addModelCheck(IBmObject modelObject)

Schedule a model check for the given model object.

Parameters:

modelObject - The model object to add the check for. May not be null. The object should be received from the context object being provided by ACC via the OnModelObjectAssociationContextCollector.collectContextOnObjectAssociation(IBmObject, com._1c.g5.v8.bm.core.event.BmSubEvent, CheckContextCollectingSession) or or be attached to the transaction being collected from the context object

getAdditionalContext

public Map<String,String> getAdditionalContext(IBmObject modelObject)

Gets a current state of an additional context being collected at the moment

Parameters:

modelObject - The target model object, cannot be null

Returns:

The current state of an additional context. Never null

addFullCheck

public void addFullCheck(IBmObject modelObject)

Schedule a full model check for a given object (starting from the corresponding top object) and a current check. Does nothing in case if the full model check for all objects (full rebuild) is already scheduled for the object

Parameters:

modelObject - The model object to add the check for. May not be null. The object should be received from the context object being provided by ACC via the OnModelObjectAssociationContextCollector.collectContextOnObjectAssociation(IBmObject, com._1c.g5.v8.bm.core.event.BmSubEvent, CheckContextCollectingSession) or or be attached to the transaction being collected from the context object