C# Class LinnworksAPI.RulesEngineMethods

Show file Open project: LinnSystems/LinnworksNetSDK

Public Methods

Method	Description
AddAction ( ActionWeb action, String ApiToken, String ApiServer ) : ActionWeb
CheckConditionNameExists ( Int32 fkRuleId, Int32 fkConditionId, Int32 excludeConditionId, String conditionName, String ApiToken, String ApiServer ) : System.Boolean
CopyAction ( Int32 pkRuleId, Int32 targetParentConditionId, Int32 pkActionId, String ApiToken, String ApiServer ) : RuleAction
CopyCondition ( Int32 pkRuleId, Int32 targetParentConditionId, Int32 pkConditionId, System.Boolean includeChildren, System.Boolean includeActions, String ApiToken, String ApiServer ) : RuleConditionHeader
CreateDraftFromExisting ( Int32 pkRuleId, String ApiToken, String ApiServer ) : Int32
CreateNewCondition ( ConditionHeaderBasic header, String ApiToken, String ApiServer ) : RuleConditionHeader
CreateNewDraft ( String ruleName, RuleSetType type, String ApiToken, String ApiServer ) : RuleHeaderBasic
CreateNewDraftFromExisting ( Int32 pkRuleId, String ruleName, String ApiToken, String ApiServer ) : RuleHeaderBasic
DeleteAction ( Int32 pkActionId, String ApiToken, String ApiServer ) : void
DeleteCondition ( Int32 pkConditionId, String ApiToken, String ApiServer ) : void
DeleteRuleById ( Int32 pkRuleId, String ApiToken, String ApiServer ) : void
GetActionOptions ( ActionType type, String ApiToken, String ApiServer ) : List
GetActionTypes ( RuleSetType type, String ApiToken, String ApiServer ) : List
GetConditionWeb ( Int32 pkConditionId, String ApiToken, String ApiServer ) : ConditionHeaderBasic
GetEvaluationFields ( RuleSetType type, String ApiToken, String ApiServer ) : List
GetEvaluatorTypes ( String ApiToken, String ApiServer ) : List
GetKeyOptions ( RuleSetType type, String fieldName, String ApiToken, String ApiServer ) : List
GetMultiKeyOptions ( RuleSetType type, List fieldNames, String ApiToken, String ApiServer ) : List
GetMultiOptions ( RuleSetType type, List fieldKeys, String ApiToken, String ApiServer ) : List
GetOptions ( String fieldName, RuleSetType type, String key, String ApiToken, String ApiServer ) : List
GetRequiredFieldsByRuleId ( Int32 pkRuleId, String ApiToken, String ApiServer ) : RulesFields
GetRequiredFieldsByType ( RuleSetType type, String ApiToken, String ApiServer ) : RulesFields
GetRuleConditionNodes ( Int32 pkRuleId, String ApiToken, String ApiServer ) : List
GetRules ( String ApiToken, String ApiServer ) : List
GetRulesByType ( RuleSetType type, String ApiToken, String ApiServer ) : List
GetValuesFromExisting ( Int32 pkRuleId, Object id, String ApiToken, String ApiServer ) : List
SaveConditionChanges ( ConditionHeaderBasic conditionHeader, String ApiToken, String ApiServer ) : void
SetConditionEnabled ( Int32 pkConditionId, System.Boolean enabled, String ApiToken, String ApiServer ) : void
SetDraftLive ( Int32 pkRuleId, String ApiToken, String ApiServer ) : Int32?
SetRuleEnabled ( Int32 pkRuleId, System.Boolean enabled, String ApiToken, String ApiServer ) : void
SetRuleName ( Int32 pkRuleId, String ruleName, String ApiToken, String ApiServer ) : void
SwapConditions ( Int32 pkConditionId1, Int32 pkConditionId2, String ApiToken, String ApiServer ) : void
SwapRules ( Int32 pkRuleId1, Int32 pkRuleId2, String ApiToken, String ApiServer ) : void
TestEvaluateRule ( List testValues, Int32 pkRuleId, String ApiToken, String ApiServer ) : RuleEvaluationResult
UpdateAction ( ActionWeb action, String ApiToken, String ApiServer ) : void

Method Details

AddAction() public static method

public static AddAction ( ActionWeb action, String ApiToken, String ApiServer ) : ActionWeb
action	ActionWeb
ApiToken	String
ApiServer	String
return	ActionWeb

CheckConditionNameExists() public static method

public static CheckConditionNameExists ( Int32 fkRuleId, Int32 fkConditionId, Int32 excludeConditionId, String conditionName, String ApiToken, String ApiServer ) : System.Boolean
fkRuleId	System.Int32
fkConditionId	System.Int32
excludeConditionId	System.Int32
conditionName	String
ApiToken	String
ApiServer	String
return	System.Boolean

CopyAction() public static method

public static CopyAction ( Int32 pkRuleId, Int32 targetParentConditionId, Int32 pkActionId, String ApiToken, String ApiServer ) : RuleAction
pkRuleId	System.Int32
targetParentConditionId	System.Int32
pkActionId	System.Int32
ApiToken	String
ApiServer	String
return	RuleAction

CopyCondition() public static method

public static CopyCondition ( Int32 pkRuleId, Int32 targetParentConditionId, Int32 pkConditionId, System.Boolean includeChildren, System.Boolean includeActions, String ApiToken, String ApiServer ) : RuleConditionHeader
pkRuleId	System.Int32
targetParentConditionId	System.Int32
pkConditionId	System.Int32
includeChildren	System.Boolean
includeActions	System.Boolean
ApiToken	String
ApiServer	String
return	RuleConditionHeader

CreateDraftFromExisting() public static method

public static CreateDraftFromExisting ( Int32 pkRuleId, String ApiToken, String ApiServer ) : Int32
pkRuleId	System.Int32
ApiToken	String
ApiServer	String
return	System.Int32

CreateNewCondition() public static method

public static CreateNewCondition ( ConditionHeaderBasic header, String ApiToken, String ApiServer ) : RuleConditionHeader
header	ConditionHeaderBasic
ApiToken	String
ApiServer	String
return	RuleConditionHeader

CreateNewDraft() public static method

public static CreateNewDraft ( String ruleName, RuleSetType type, String ApiToken, String ApiServer ) : RuleHeaderBasic
ruleName	String
type	RuleSetType
ApiToken	String
ApiServer	String
return	RuleHeaderBasic

CreateNewDraftFromExisting() public static method

public static CreateNewDraftFromExisting ( Int32 pkRuleId, String ruleName, String ApiToken, String ApiServer ) : RuleHeaderBasic
pkRuleId	System.Int32
ruleName	String
ApiToken	String
ApiServer	String
return	RuleHeaderBasic

DeleteAction() public static method

public static DeleteAction ( Int32 pkActionId, String ApiToken, String ApiServer ) : void
pkActionId	System.Int32
ApiToken	String
ApiServer	String
return	void

DeleteCondition() public static method

public static DeleteCondition ( Int32 pkConditionId, String ApiToken, String ApiServer ) : void
pkConditionId	System.Int32
ApiToken	String
ApiServer	String
return	void

DeleteRuleById() public static method

public static DeleteRuleById ( Int32 pkRuleId, String ApiToken, String ApiServer ) : void
pkRuleId	System.Int32
ApiToken	String
ApiServer	String
return	void

GetActionOptions() public static method

public static GetActionOptions ( ActionType type, String ApiToken, String ApiServer ) : List
type	ActionType
ApiToken	String
ApiServer	String
return	List

GetActionTypes() public static method

public static GetActionTypes ( RuleSetType type, String ApiToken, String ApiServer ) : List
type	RuleSetType
ApiToken	String
ApiServer	String
return	List

GetConditionWeb() public static method

public static GetConditionWeb ( Int32 pkConditionId, String ApiToken, String ApiServer ) : ConditionHeaderBasic
pkConditionId	System.Int32
ApiToken	String
ApiServer	String
return	ConditionHeaderBasic

GetEvaluationFields() public static method

public static GetEvaluationFields ( RuleSetType type, String ApiToken, String ApiServer ) : List
type	RuleSetType
ApiToken	String
ApiServer	String
return	List

GetEvaluatorTypes() public static method

public static GetEvaluatorTypes ( String ApiToken, String ApiServer ) : List
ApiToken	String
ApiServer	String
return	List

GetKeyOptions() public static method

public static GetKeyOptions ( RuleSetType type, String fieldName, String ApiToken, String ApiServer ) : List
type	RuleSetType
fieldName	String
ApiToken	String
ApiServer	String
return	List

GetMultiKeyOptions() public static method

public static GetMultiKeyOptions ( RuleSetType type, List fieldNames, String ApiToken, String ApiServer ) : List
type	RuleSetType
fieldNames	List
ApiToken	String
ApiServer	String
return	List

GetMultiOptions() public static method

public static GetMultiOptions ( RuleSetType type, List fieldKeys, String ApiToken, String ApiServer ) : List
type	RuleSetType
fieldKeys	List
ApiToken	String
ApiServer	String
return	List

GetOptions() public static method

public static GetOptions ( String fieldName, RuleSetType type, String key, String ApiToken, String ApiServer ) : List
fieldName	String
type	RuleSetType
key	String
ApiToken	String
ApiServer	String
return	List

GetRequiredFieldsByRuleId() public static method

public static GetRequiredFieldsByRuleId ( Int32 pkRuleId, String ApiToken, String ApiServer ) : RulesFields
pkRuleId	System.Int32
ApiToken	String
ApiServer	String
return	RulesFields

GetRequiredFieldsByType() public static method

public static GetRequiredFieldsByType ( RuleSetType type, String ApiToken, String ApiServer ) : RulesFields
type	RuleSetType
ApiToken	String
ApiServer	String
return	RulesFields

GetRuleConditionNodes() public static method

public static GetRuleConditionNodes ( Int32 pkRuleId, String ApiToken, String ApiServer ) : List
pkRuleId	System.Int32
ApiToken	String
ApiServer	String
return	List

GetRules() public static method

public static GetRules ( String ApiToken, String ApiServer ) : List
ApiToken	String
ApiServer	String
return	List

GetRulesByType() public static method

public static GetRulesByType ( RuleSetType type, String ApiToken, String ApiServer ) : List
type	RuleSetType
ApiToken	String
ApiServer	String
return	List

GetValuesFromExisting() public static method

public static GetValuesFromExisting ( Int32 pkRuleId, Object id, String ApiToken, String ApiServer ) : List
pkRuleId	System.Int32
id	Object
ApiToken	String
ApiServer	String
return	List

SaveConditionChanges() public static method

public static SaveConditionChanges ( ConditionHeaderBasic conditionHeader, String ApiToken, String ApiServer ) : void
conditionHeader	ConditionHeaderBasic
ApiToken	String
ApiServer	String
return	void

SetConditionEnabled() public static method

public static SetConditionEnabled ( Int32 pkConditionId, System.Boolean enabled, String ApiToken, String ApiServer ) : void
pkConditionId	System.Int32
enabled	System.Boolean
ApiToken	String
ApiServer	String
return	void

SetDraftLive() public static method

public static SetDraftLive ( Int32 pkRuleId, String ApiToken, String ApiServer ) : Int32?
pkRuleId	System.Int32
ApiToken	String
ApiServer	String
return	Int32?

SetRuleEnabled() public static method

public static SetRuleEnabled ( Int32 pkRuleId, System.Boolean enabled, String ApiToken, String ApiServer ) : void
pkRuleId	System.Int32
enabled	System.Boolean
ApiToken	String
ApiServer	String
return	void

SetRuleName() public static method

public static SetRuleName ( Int32 pkRuleId, String ruleName, String ApiToken, String ApiServer ) : void
pkRuleId	System.Int32
ruleName	String
ApiToken	String
ApiServer	String
return	void

SwapConditions() public static method

public static SwapConditions ( Int32 pkConditionId1, Int32 pkConditionId2, String ApiToken, String ApiServer ) : void
pkConditionId1	System.Int32
pkConditionId2	System.Int32
ApiToken	String
ApiServer	String
return	void

SwapRules() public static method

public static SwapRules ( Int32 pkRuleId1, Int32 pkRuleId2, String ApiToken, String ApiServer ) : void
pkRuleId1	System.Int32
pkRuleId2	System.Int32
ApiToken	String
ApiServer	String
return	void

TestEvaluateRule() public static method

public static TestEvaluateRule ( List testValues, Int32 pkRuleId, String ApiToken, String ApiServer ) : RuleEvaluationResult
testValues	List
pkRuleId	System.Int32
ApiToken	String
ApiServer	String
return	RuleEvaluationResult

UpdateAction() public static method

public static UpdateAction ( ActionWeb action, String ApiToken, String ApiServer ) : void
action	ActionWeb
ApiToken	String
ApiServer	String
return	void