SAP ABAP Class /IPRO/CL_RULE_ENGINE (Rules Engine (fobu functions))

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-GTF-DOB (Application Component) Document Builder
     ⤷ /IPRO/PROGS (Package) programs

Properties

Class	/IPRO/CL_RULE_ENGINE
Short Description	Rules Engine (fobu functions)
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	/IPRO/PROGS	programs
Created	20040826	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /IPRO/CL_RULE_ENGINE has no forward declaration.

Interfaces

Class /IPRO/CL_RULE_ENGINE has no interface implemented.

Friends

Class /IPRO/CL_RULE_ENGINE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_EXCLUDED	Constant	Public	☐	Type reference (TYPE)	STRING	'RE'	Excluded flag	20040826
2	GC_FALSE	Constant	Public	☐	Type reference (TYPE)	SEU_BOOL	SPACE	Boolean	20040826
3	GC_MANDATORY_CUSTOM	Constant	Public	☐	Type reference (TYPE)	STRING	'MC'	Mandatory via customizing flag	20040930
4	GC_OPTIONAL	Constant	Public	☐	Type reference (TYPE)	STRING	'OR'	Optional flag	20040826
5	GC_RECOMMENDED	Constant	Public	☐	Type reference (TYPE)	STRING	'RR'	Recommended flag	20040826
6	GC_REQUIRED	Constant	Public	☐	Type reference (TYPE)	STRING	'MR'	Required flag	20040826
7	GC_SEPARATOR	Constant	Public	☐	Type reference (TYPE)	STRING	':'	Separating char	20040826
8	GC_TRUE	Constant	Public	☐	Type reference (TYPE)	SEU_BOOL	'X'	Boolean	20040826
9	GC_USER_EXCLUDED	Constant	Public	☐	Type reference (TYPE)	STRING	'UE'	User excluded flag	20040826
10	GC_USER_INCLUDED	Constant	Public	☐	Type reference (TYPE)	STRING	'UI'	User included	20090902
11	MO_DOCUMENT	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCUMENT		Document Builder Document Interface	20040826
12	MV_RULE	Static Attribute	Protected	☐	Type reference (TYPE)	/IPRO/RULE_ID		Rule Identifier	20070504

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	EVAL	Static method	Public	Method	Formula builder main method	20040826
2	EXCLUDE_ELEMENT	Static method	Public	Method	Exclude an element	20040826
3	GET_DOCUMENT	Static method	Public	Method	Get the Document	20040826
4	GET_ELEMENT	Static method	Private	Method	Get the given element	20040826
5	INCLUDE_ELEMENT	Static method	Public	Method	Include an element	20040826
6	INCLUDE_MANDATORY_ELEMENT	Static method	Public	Method	Include a mandatory element	20040826
7	INCLUDE_OPTIONAL_ELEMENT	Static method	Public	Method	Include an optional element	20040826
8	INCLUDE_RECOMMENDED_ELEMENT	Static method	Public	Method	Include a recommended element	20040826
9	IS_ELEMENT_EXCLUDED	Static method	Public	Method	Determine if an element is excluded	20040826
10	IS_ELEMENT_INCLUDED	Static method	Public	Method	Determine if an element is included	20040826
11	IS_PRECONDITION_VALID	Static method	Public	Method	Is the precondition valid	20040826
12	IS_VALUE_IN_TABLE	Static method	Public	Method	Find an entry with the given value in the table	20040826
13	SET_DOCUMENT	Static method	Public	Method	Set the Document	20040826
14	SET_RULE	Static method	Public	Method	Set the value of the rule currently running	20070504
15	SET_VALUE	Static method	Public	Method	Set the value for the given variable	20061031

Events

Class /IPRO/CL_RULE_ENGINE has no event.

Types

Class /IPRO/CL_RULE_ENGINE has no local type.

Method Signatures

Method EVAL Signature

Method EVAL on class /IPRO/CL_RULE_ENGINE has no parameter.
Method EVAL on class /IPRO/CL_RULE_ENGINE has no exception.

Method EXCLUDE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_ELEMENT	Call by reference	☐	Type reference (TYPE)	STRING		Element ID	20040826
2	Returning	PRV_RETURN	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20040826

Method EXCLUDE_ELEMENT on class /IPRO/CL_RULE_ENGINE has no exception.

Method GET_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRO_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCUMENT		Document Builder Document Interface	20040826

Method GET_DOCUMENT on class /IPRO/CL_RULE_ENGINE has no exception.

Method GET_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_ELEMENT	Call by reference	☐	Type reference (TYPE)	STRING		Element ID	20040826
2	Returning	PRV_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Interface to document builder element	20040826

Method GET_ELEMENT on class /IPRO/CL_RULE_ENGINE has no exception.

Method INCLUDE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_ELEMENT	Call by reference	☐	Type reference (TYPE)	STRING		Element ID	20040826
2	Importing	PIV_STATUS	Call by reference	☐	Type reference (TYPE)	STRING		status	20040826
3	Returning	PRV_RETURN	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20040826

Method INCLUDE_ELEMENT on class /IPRO/CL_RULE_ENGINE has no exception.

Method INCLUDE_MANDATORY_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_ELEMENT	Call by reference	☐	Type reference (TYPE)	STRING		Element ID	20040826
2	Returning	PRV_RETURN	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20040826

Method INCLUDE_MANDATORY_ELEMENT on class /IPRO/CL_RULE_ENGINE has no exception.

Method INCLUDE_OPTIONAL_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_ELEMENT	Call by reference	☐	Type reference (TYPE)	STRING		Element ID	20040826
2	Returning	PRV_RETURN	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20040826

Method INCLUDE_OPTIONAL_ELEMENT on class /IPRO/CL_RULE_ENGINE has no exception.

Method INCLUDE_RECOMMENDED_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_ELEMENT	Call by reference	☐	Type reference (TYPE)	STRING		Element ID	20040826
2	Returning	PRV_RETURN	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20040826

Method INCLUDE_RECOMMENDED_ELEMENT on class /IPRO/CL_RULE_ENGINE has no exception.

Method IS_ELEMENT_EXCLUDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_ELEMENT	Call by reference	☐	Type reference (TYPE)	STRING		Element ID	20040826
2	Returning	PRV_RETURN	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20040826

Method IS_ELEMENT_EXCLUDED on class /IPRO/CL_RULE_ENGINE has no exception.

Method IS_ELEMENT_INCLUDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_ELEMENT	Call by reference	☐	Type reference (TYPE)	STRING		Element ID	20040826
2	Returning	PRV_RETURN	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20040826

Method IS_ELEMENT_INCLUDED on class /IPRO/CL_RULE_ENGINE has no exception.

Method IS_PRECONDITION_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RULE	Call by reference	☐	Type reference (TYPE)	/IPRO/RULE_ID		Rule Identifier	20040826
2	Returning	RV_VALID	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20040826

Method IS_PRECONDITION_VALID on class /IPRO/CL_RULE_ENGINE has no exception.

Method IS_VALUE_IN_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_COLUMN_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Column Name	20040826
2	Importing	PIV_TABLE_VAR	Call by reference	☐	Type reference (TYPE)	STRING		Table variable ID	20040826
3	Importing	PIV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Value	20040826
4	Returning	PRV_VAL	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20040826

Method IS_VALUE_IN_TABLE on class /IPRO/CL_RULE_ENGINE has no exception.

Method SET_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCUMENT		Document Builder Document Interface	20040826

Method SET_DOCUMENT on class /IPRO/CL_RULE_ENGINE has no exception.

Method SET_RULE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RULE	Call by reference	☐	Type reference (TYPE)	/IPRO/RULE_ID		Rule Identifier	20070504

Method SET_RULE on class /IPRO/CL_RULE_ENGINE has no exception.

Method SET_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Variable value	20061031
2	Importing	PIV_VARIABLE	Call by reference	☐	Type reference (TYPE)	STRING		Variable ID	20061031
3	Returning	PRV_RETURN	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20061031

Method SET_VALUE on class /IPRO/CL_RULE_ENGINE has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	100