Home > Class Reference > HSLIB namespace > EnsLib.ITK.Setup.ServiceDefinition

EnsLib.ITK.Setup.ServiceDefinition

persistent class EnsLib.ITK.Setup.ServiceDefinition extends %Library.Persistent, %XML.Adaptor

SQL Table Name: EnsLib_ITK_Setup.ServiceDefinition

This is a master for all Web Services supported by ITK. It holds several Service attributes such as SOAP Action, Client Class etc.

Property Inventory

Method Inventory

Parameters

parameter SrcVer = $Id$;

Properties

property BehaviourType as %String (VALUELIST = ",Request-Response,Post,Queue Collection,Fault Handler,Asynch Response Handler,Acknowledged") [ Required ];
Property methods: BehaviourTypeDisplayToLogical(), BehaviourTypeGet(), BehaviourTypeGetStored(), BehaviourTypeIsValid(), BehaviourTypeLogicalToDisplay(), BehaviourTypeLogicalToOdbc(), BehaviourTypeNormalize(), BehaviourTypeSet()
property Direction as %String (VALUELIST = ",FromMaster,ToMaster") [ InitialExpression = "FromMaster" ];
Contains the direction of this service to/from a master system
Property methods: DirectionDisplayToLogical(), DirectionGet(), DirectionGetStored(), DirectionIsValid(), DirectionLogicalToDisplay(), DirectionLogicalToOdbc(), DirectionNormalize(), DirectionSet()
property DocumentType as %String;
Contains the HL7 DocType for this message (if it is a HL7 message)
Property methods: DocumentTypeDisplayToLogical(), DocumentTypeGet(), DocumentTypeGetStored(), DocumentTypeIsValid(), DocumentTypeLogicalToDisplay(), DocumentTypeLogicalToOdbc(), DocumentTypeNormalize(), DocumentTypeSet()
property RequestClass as %String);
Property methods: RequestClassDisplayToLogical(), RequestClassGet(), RequestClassGetStored(), RequestClassIsValid(), RequestClassLogicalToDisplay(), RequestClassLogicalToOdbc(), RequestClassNormalize(), RequestClassSet()
property ResponseClass as %String);
Property methods: ResponseClassDisplayToLogical(), ResponseClassGet(), ResponseClassGetStored(), ResponseClassIsValid(), ResponseClassLogicalToDisplay(), ResponseClassLogicalToOdbc(), ResponseClassNormalize(), ResponseClassSet()
property SOAPAction as %String) [ Required ];
Property methods: SOAPActionDisplayToLogical(), SOAPActionGet(), SOAPActionGetStored(), SOAPActionIsValid(), SOAPActionLogicalToDisplay(), SOAPActionLogicalToOdbc(), SOAPActionNormalize(), SOAPActionSet()
property ServiceName as %String) [ Required ];
Property methods: ServiceNameDisplayToLogical(), ServiceNameGet(), ServiceNameGetStored(), ServiceNameIsValid(), ServiceNameLogicalToDisplay(), ServiceNameLogicalToOdbc(), ServiceNameNormalize(), ServiceNameSet()
property WebClientClass as %String);
Property methods: WebClientClassDisplayToLogical(), WebClientClassGet(), WebClientClassGetStored(), WebClientClassIsValid(), WebClientClassLogicalToDisplay(), WebClientClassLogicalToOdbc(), WebClientClassNormalize(), WebClientClassSet()
property WebServiceClass as %String);
Property methods: WebServiceClassDisplayToLogical(), WebServiceClassGet(), WebServiceClassGetStored(), WebServiceClassIsValid(), WebServiceClassLogicalToDisplay(), WebServiceClassLogicalToOdbc(), WebServiceClassNormalize(), WebServiceClassSet()

Methods

classmethod FromAction(action As %String) as EnsLib.ITK.Setup.ServiceDefinition [ Language = objectscript ]
classmethod ImportFromFile(pFileName As %String, pDelim As %String = "|") as %Status [ Language = objectscript ]

Queries

query GetFaultHandlers()
SQL Query:
SELECT ServiceName FROM ServiceDefinition WHERE BehaviourType = 'Fault Handler' ORDER BY ServiceName
query GetResponseHandlers()
SQL Query:
SELECT ServiceName FROM ServiceDefinition WHERE BehaviourType = 'Asynch Response Handler' ORDER BY ServiceName
query GetServicForDocType(pDoctype As %String, pDirection As %String)
SQL Query:
SELECT ServiceName FROM ServiceDefinition WHERE DocumentType = :pDoctype and Direction = :pDirection ORDER BY ServiceName
query GetServiceList()
SQL Query:
SELECT ServiceName FROM ServiceDefinition ORDER BY ServiceName
query GetServiceListUI()
SQL Query:
SELECT ServiceName, SOAPAction, BehaviourType, DocumentType, Direction, RequestClass, ResponseClass, WebClientClass, WebServiceClass FROM ServiceDefinition ORDER BY ServiceName

Indexes

index (NU1 on BehaviourType);
Index methods: NU1Exists()
index (NU2 on DocumentType,Direction);
Index methods: NU2Exists()
index (U1 on ServiceName) [IdKey, Type = key, Unique];
Index methods: U1Check(), U1Delete(), U1Exists(), U1Open(), U1SQLCheckUnique(), U1SQLExists(), U1SQLFindPKeyByConstraint(), U1SQLFindRowIDByConstraint()
index (U2 on SOAPAction) [Unique];
Index methods: U2Check(), U2CheckUnique(), U2Delete(), U2Exists(), U2Open(), U2SQLCheckUnique(), U2SQLExists(), U2SQLFindPKeyByConstraint(), U2SQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (EnsLib.ITK.Setup.ServiceDefinition)

^EnsITK.ServiceDefinitionD(ID)
=
%%CLASSNAME
SOAPAction
BehaviourType
RequestClass
ResponseClass
WebClientClass
WebServiceClass
DocumentType
Direction

Subclasses

FeedbackOpens in a new window