Octobox API  4.1.0
Octobox Scripting API
Public Member Functions | Properties
ActivityConditionScriptBaseabstract

Base class for activity conditions. More...

Inheritance diagram for ActivityConditionScriptBase:
ScriptBase

Public Member Functions

abstract bool CanExecuteActivity (SCProcess batch)
 Check if the current batch shall be executed by the current activity. More...
 
virtual bool CanExecuteDocument (SCDocument document)
 Check if the current document shall be executed by the current activity. More...
 

Properties

string ActivityName [get, set]
 Name of the activity checking the condition More...
 
string ProfileName [get, set]
 Name of the profile checking the condition More...
 
- Properties inherited from ScriptBase
SCProcess Batch [get, set]
 Batch object containing global values available to all scripts. More...
 
CancellationToken CancellationToken [get, set]
 Cancellation token that can be checked for process cancellation on long running script actions. More...
 
SourceApplications SourceApplication [get, set]
 Application that called this function. More...
 

Additional Inherited Members

- Data Fields inherited from ScriptBase
Action< string > LogInfo
 Write text to the Octobox logging at information level. More...
 
Action< string > LogMsg
 Write text to the Octobox logging at normal level. More...
 

Detailed Description

Base class for activity conditions.

Member Function Documentation

◆ CanExecuteActivity()

abstract bool CanExecuteActivity ( SCProcess  batch)
pure virtual

Check if the current batch shall be executed by the current activity.

Parameters
batchBatch object used to validate if the current activity should be executed
Returns
True if this activity should be processed, false otherwise

◆ CanExecuteDocument()

virtual bool CanExecuteDocument ( SCDocument  document)
inlinevirtual

Check if the current document shall be executed by the current activity.

Parameters
documentDocument object to check for execution
Returns
True if this document should be processed, false otherwise

Property Documentation

◆ ActivityName

string ActivityName
getset

Name of the activity checking the condition

◆ ProfileName

string ProfileName
getset

Name of the profile checking the condition