All Classes Namespaces Functions Properties Pages
Public Member Functions | List of all members
BusinessRuleService Class Reference

Provides methods to work with business rules. Currently only exposes ExecuteBusinessRule method. More...

Public Member Functions

BusinessRuleOutputCollection ExecuteBusinessRule (string sessionId, BusinessRuleRuntimeIdentity businessRuleRuntimeIdentity, BusinessRuleInputCollection ruleInputs)
 Executes a specified business rule using the supplied rule inputs. More...
 

Description

Provides methods to work with business rules. Currently only exposes ExecuteBusinessRule method.

Member Functions

BusinessRuleOutputCollection ExecuteBusinessRule ( string  sessionId,
BusinessRuleRuntimeIdentity  businessRuleRuntimeIdentity,
BusinessRuleInputCollection  ruleInputs 
)

Executes a specified business rule using the supplied rule inputs.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
businessRuleRuntimeIdentityA BusinessRuleRuntimeIdentity identity object identifying the required business rule. Cannot be null
Name Type Comment Required
Id String The rule id Yes
Name String The rule name No. Name not used by this API
ruleInputsA BusinessRuleInputCollection collection of BusinessRuleInput objects identifying the rule inputs and their values. Can be null BusinessRuleInput members.
Name Type Comment Required
Name String Id of the rule input variable Yes
Type Int16 The rule input's type Yes. See Remarks section for the supported types and the number to be supplied as type member
Value Object The value of the rule input Yes. Will need to be an appropriate value for the specified type
Returns
A collection of BusinessRuleOutput objects with name, type and value BusinessRuleOutput members.
Name Type Comment
Name String Name of a rule output
Type Int16 The rule output's type. See Remarks section for the returned value and its corresponding type
Value Object The value of the rule output
Remarks
The latest released version of the specified business rule will be executed
The supported rule input and output types and their corresponding numerical values are as follows:
Enumeration Description
2 Short
3 Long
4 Float
5 Double
6 Currency
7 Date
8 String
11 Bool
14 Decimal
17 Byte
8204 Complex
32759 Folder
32760 Document
32761 Entity
32762 NullableString
32763 NullableDate
32764 Checklist
32766 XmlExpression
32767 Xml
Security
No restrictions apply.