Interoperability Editor API for InterSystems IRIS
Business logic class defined by OpenAPI in Api.InteropEditors.v1.spec
Updated Mar 7, 2024 16:16:36. More...

Inheritance diagram for impl:

[legend]

Collaboration diagram for impl:

[legend]

Static Public Member Functions
_.Library.DynamicObject	CompileRule (_.Library.String namespace, _.Library.String ruleClass)
	Compile this rule class. More...

_.Stream.Object	DispatchPlugin (_.Library.String namespace, _.Library.String pluginPath)
	Dispatch to plugin endpoint. More...

_.Library.DynamicObject	GetClassSummaries (_.Library.String namespace)
	Get summaries of non-hidden classes in this namespace. More...

_.Library.DynamicObject	GetConstraintOptions (_.Library.String namespace, _.Library.String assistClass, _.Library.DynamicArray constraints)
	Get a list of constraint options for this rule type. More...

_.Library.DynamicObject	GetContextInputs (_.Library.String namespace, _.Library.String contextClass)
	Get information on this context class. More...

_.Library.DynamicObject	GetDocTypes (_.Library.String namespace)
	Get a list of doctype names and categories for HL7 rule testing More...

_.Library.DynamicObject	GetExpiry ()
	Get the expiry of the current session.

_.Library.DynamicObject	GetInputPluginsList (_.Library.String namespace)
	Get list of input plugins. More...

_.Library.DynamicObject	GetLanguage ()
	Get the language for this session.

_.Library.DynamicObject	GetLookupTables (_.Library.String namespace)
	Get a list of lookup tables in this namespace. More...

_.Library.DynamicObject	GetMgmtUrl (_.Library.String namespace)
	Get the 'path' portion of the Interoperability management URL for a given namespace. More...

_.Library.DynamicObject	GetPackages (_.Library.String namespace)
	Get a list of defined packages. More...

_.Library.DynamicObject	GetPermissions ()
	Get a list of permissions for the current user and namespaces they can access.

_.Library.DynamicObject	GetProductionConfigItems (_.Library.String namespace, _.Library.String production, _.Library.Boolean targets)
	Get a list of production configuration items. More...

_.Library.DynamicObject	GetProductionItems (_.Library.String namespace)
	Get a list of production items in rule. More...

_.Library.DynamicObject	GetProductions (_.Library.String namespace)
	Get a list of productions. More...

_.Library.DynamicObject	GetRule (_.Library.String namespace, _.Library.String ruleClass)
	Get this rule class. More...

_.Library.DynamicObject	GetRuleTypeSchema (_.Library.String namespace, _.Library.String assistClassName)
	Get the schema for this rule type. More...

_.Library.DynamicObject	GetRuleTypes (_.Library.String namespace)
	Get a list of rule types available on the server. More...

_.Library.DynamicObject	GetRules (_.Library.String namespace)
	Get a list of rule classes available on the server. More...

_.Library.DynamicObject	GetSystemMode ()
	Get the system mode of this instance.

_.Library.DynamicObject	GetTestingInputs (_.Library.String namespace, _.Library.String ruleClass)
	Get information on this class. More...

_.Library.DynamicObject	GetTransforms (_.Library.String namespace)
	Get a list of data transforms. More...

_.Stream.Object	Logout ()
	Terminate CSP Session.

_.Library.DynamicObject	PostRule (_.Library.String namespace, _.Library.String ruleClass, _.Library.DynamicObject ruleDefinition)
	Create a new rule class. More...

_.Library.DynamicObject	PutRule (_.Library.String namespace, _.Library.String ruleClass, _.Library.DynamicObject ruleDefinition, _.Library.Boolean ignoreConflict)
	Overwrite this rule class. More...

_.Library.DynamicObject	SetLanguage (_.Library.String language)
	Set the language for this session More...

_.Library.DynamicObject	SourceControlAfterUserAction (_.Library.String namespace, _.Library.DynamicObject sourceControlRequestBody)
	Requests Source Control After User Action for the given parameters More...

_.Library.DynamicObject	SourceControlEnabled (_.Library.String namespace)
	Returns enabled true or false if Source Control Enabled for the namespace More...

_.Library.DynamicObject	SourceControlGetMenus (_.Library.String namespace, _.Library.DynamicObject sourceControlRequestBody)
	Returns Source Control Menu for the given parameters More...

_.Library.DynamicObject	SourceControlGetStatus (_.Library.String namespace, _.Library.DynamicObject sourceControlRequestBody)
	Requests Source Control GetStatus for the given parameters More...

_.Library.DynamicObject	SourceControlUserAction (_.Library.String namespace, _.Library.DynamicObject sourceControlRequestBody)
	Requests Source Control User Action for the given parameters More...

_.Library.DynamicObject	TestRule (_.Library.String namespace, _.Library.String ruleClass, _.Library.DynamicObject ruleTestMessage)
	Run rule and return logs More...

Static Public Attributes
	ExposeServerExceptions = None
	Interoperability Editor API for InterSystems IRIS Business logic class defined by OpenAPI in Api.InteropEditors.v1.spec Updated Mar 7, 2024 16:16:36. More...

Static Public Attributes inherited from Impl
	ExposeServerExceptions = None
	If ExposeServerExceptions is overridden as true, then details of internal errors will be exposed.

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Private Member Functions
_.Library.DynamicObject	ReportRESTError (_.Library.String statusCode, _.Library.Status sc, _.Library.Boolean exposeServerExceptions, _.Library.Status externalError)
	Overwrite ReportRESTError for customized external error messages.

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Detailed Description

Interoperability Editor API for InterSystems IRIS
Business logic class defined by OpenAPI in Api.InteropEditors.v1.spec
Updated Mar 7, 2024 16:16:36.

Member Function Documentation

◆ CompileRule()

_.Library.DynamicObject CompileRule	(	_.Library.String	namespace,
		_.Library.String	ruleClass
	)

static

Compile this rule class.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.

Reimplemented in impl.

◆ DispatchPlugin()

_.Stream.Object DispatchPlugin	(	_.Library.String	namespace,
		_.Library.String	pluginPath
	)

static

Dispatch to plugin endpoint.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
pluginPath, Path of the plugin endpoint to hit.

Reimplemented in impl.

◆ GetClassSummaries()

_.Library.DynamicObject GetClassSummaries ( _.Library.String namespace )

static

Get summaries of non-hidden classes in this namespace.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ GetConstraintOptions()

_.Library.DynamicObject GetConstraintOptions	(	_.Library.String	namespace,
		_.Library.String	assistClass,
		_.Library.DynamicArray	constraints
	)

static

Get a list of constraint options for this rule type.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
assistClass, Rule type, in the form of an assist class.
constraints, Constraints to get options for.

Reimplemented in impl.

◆ GetContextInputs()

_.Library.DynamicObject GetContextInputs	(	_.Library.String	namespace,
		_.Library.String	contextClass
	)

static

Get information on this context class.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
contextClass, Name of the ObjectScript class used as a context class for a rule.

Reimplemented in impl.

◆ GetDocTypes()

_.Library.DynamicObject GetDocTypes ( _.Library.String namespace )

static

Get a list of doctype names and categories for HL7 rule testing

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ GetInputPluginsList()

_.Library.DynamicObject GetInputPluginsList ( _.Library.String namespace )

static

Get list of input plugins.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ GetLookupTables()

_.Library.DynamicObject GetLookupTables ( _.Library.String namespace )

static

Get a list of lookup tables in this namespace.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ GetMgmtUrl()

_.Library.DynamicObject GetMgmtUrl ( _.Library.String namespace )

static

Get the 'path' portion of the Interoperability management URL for a given namespace.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ GetPackages()

_.Library.DynamicObject GetPackages ( _.Library.String namespace )

static

Get a list of defined packages.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ GetProductionConfigItems()

_.Library.DynamicObject GetProductionConfigItems	(	_.Library.String	namespace,
		_.Library.String	production,
		_.Library.Boolean	targets
	)

static

Get a list of production configuration items.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
production, Get the configuration items for only this production.
targets, Only get the configuration items of type 'target'.

Reimplemented in impl.

◆ GetProductionItems()

_.Library.DynamicObject GetProductionItems ( _.Library.String namespace )

static

Get a list of production items in rule.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ GetProductions()

_.Library.DynamicObject GetProductions ( _.Library.String namespace )

static

Get a list of productions.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ GetRule()

_.Library.DynamicObject GetRule	(	_.Library.String	namespace,
		_.Library.String	ruleClass
	)

static

Get this rule class.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.

Reimplemented in impl.

◆ GetRuleTypeSchema()

_.Library.DynamicObject GetRuleTypeSchema	(	_.Library.String	namespace,
		_.Library.String	assistClassName
	)

static

Get the schema for this rule type.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
assistClassName, Rule type in the form of an assist class name.

Reimplemented in impl.

◆ GetRuleTypes()

_.Library.DynamicObject GetRuleTypes ( _.Library.String namespace )

static

Get a list of rule types available on the server.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ GetRules()

_.Library.DynamicObject GetRules ( _.Library.String namespace )

static

Get a list of rule classes available on the server.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ GetTestingInputs()

_.Library.DynamicObject GetTestingInputs	(	_.Library.String	namespace,
		_.Library.String	ruleClass
	)

static

Get information on this class.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.

Reimplemented in impl.

◆ GetTransforms()

_.Library.DynamicObject GetTransforms ( _.Library.String namespace )

static

Get a list of data transforms.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ PostRule()

_.Library.DynamicObject PostRule	(	_.Library.String	namespace,
		_.Library.String	ruleClass,
		_.Library.DynamicObject	ruleDefinition
	)

static

Create a new rule class.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
ruleDefinition, Definition which defines the contents of a rule class.

Reimplemented in impl.

◆ PutRule()

_.Library.DynamicObject PutRule	(	_.Library.String	namespace,
		_.Library.String	ruleClass,
		_.Library.DynamicObject	ruleDefinition,
		_.Library.Boolean	ignoreConflict
	)

static

Overwrite this rule class.

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
ruleDefinition, Definition which defines the contents of a rule class.
ignoreConflict, Overwrite this class if it exists, ignoring conflicts.

Reimplemented in impl.

◆ SetLanguage()

_.Library.DynamicObject SetLanguage ( _.Library.String language )

static

Set the language for this session

The method arguments hold values for:
language, Language code to set for this session.

Reimplemented in impl.

◆ SourceControlAfterUserAction()

_.Library.DynamicObject SourceControlAfterUserAction	(	_.Library.String	namespace,
		_.Library.DynamicObject	sourceControlRequestBody
	)

static

Requests Source Control After User Action for the given parameters

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function

Reimplemented in impl.

◆ SourceControlEnabled()

_.Library.DynamicObject SourceControlEnabled ( _.Library.String namespace )

static

Returns enabled true or false if Source Control Enabled for the namespace

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.

Reimplemented in impl.

◆ SourceControlGetMenus()

_.Library.DynamicObject SourceControlGetMenus	(	_.Library.String	namespace,
		_.Library.DynamicObject	sourceControlRequestBody
	)

static

Returns Source Control Menu for the given parameters

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function

Reimplemented in impl.

◆ SourceControlGetStatus()

_.Library.DynamicObject SourceControlGetStatus	(	_.Library.String	namespace,
		_.Library.DynamicObject	sourceControlRequestBody
	)

static

Requests Source Control GetStatus for the given parameters

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function

Reimplemented in impl.

◆ SourceControlUserAction()

_.Library.DynamicObject SourceControlUserAction	(	_.Library.String	namespace,
		_.Library.DynamicObject	sourceControlRequestBody
	)

static

Requests Source Control User Action for the given parameters

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function

Reimplemented in impl.

◆ TestRule()

_.Library.DynamicObject TestRule	(	_.Library.String	namespace,
		_.Library.String	ruleClass,
		_.Library.DynamicObject	ruleTestMessage
	)

static

Run rule and return logs

The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
ruleTestMessage, Defines test parameters for rule class

Reimplemented in impl.

Member Data Documentation

◆ ExposeServerExceptions

ExposeServerExceptions = None

static

Interoperability Editor API for InterSystems IRIS
Business logic class defined by OpenAPI in Api.InteropEditors.v1.spec
Updated Mar 7, 2024 16:16:36.

If ExposeServerExceptions is true, then details of internal errors will be exposed.

Static Public Member Functions

Static Public Attributes

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CompileRule()

◆ DispatchPlugin()

◆ GetClassSummaries()

◆ GetConstraintOptions()

◆ GetContextInputs()

◆ GetDocTypes()

◆ GetInputPluginsList()

◆ GetLookupTables()

◆ GetMgmtUrl()

◆ GetPackages()

◆ GetProductionConfigItems()

◆ GetProductionItems()

◆ GetProductions()

◆ GetRule()

◆ GetRuleTypeSchema()

◆ GetRuleTypes()

◆ GetRules()

◆ GetTestingInputs()

◆ GetTransforms()

◆ PostRule()

◆ PutRule()

◆ SetLanguage()

◆ SourceControlAfterUserAction()

◆ SourceControlEnabled()

◆ SourceControlGetMenus()

◆ SourceControlGetStatus()

◆ SourceControlUserAction()

◆ TestRule()

Member Data Documentation

◆ ExposeServerExceptions