TBeasCbServiceRegInfo

Die Klasse TBeasCbServiceRegInfo ermöglicht das Registrieren von Service-Methoden für die Verwendung im beas.

Eigenschaften
CbMethodName:C	Name der zu registrierenden Service-Methode. Es sind nur Namen mit dem Prefix "cb_" erlaubt Namen müssen dem regulären Ausdruck "^[_a-zA-Z\-]{1}[_a-zA-Z\d\-]*$" genügen.
CbMethodDescription:C	Beschreibung der zu registrierenden Service-Methode zu Dokumentationszwecken.
CbServiceTypes:N	Legt fest, wie die zu registrierende Service-Methode aufgerufen werden kann. Erlaubt sind als Werte alle Kombinationen der Konstanten: beasServiceTypeStandard: Die Service-Methode wird als RPC-Aufruf behandelt. beasServiceTypeHttp: Die Service-Methode wird als HTTP-Request behandelt.
CbContextClass:N	Legt fest, welche Kontext-Klasse für den Aufruf verwendet werden muss. Erlaubt sind als Werte die Konstanten: beasContext beasMobileContext
CbTypeVisibility:N	Sichtbarkeit des registrierenden Parametertypen in der generierten Schnittstellendokumentation des beas. Erlaubt sind als Werte die Konstanten: beasUndocumented beasDocumented
CbProgramName:C	Name des Codeblockprogrammes, das beim Aufruf der Service-Methode ausgeführt werden soll. Das Programm muss sich im Ordner "beas\" befinden.
CbExecutionTimeout:N	Timeout der Ausführung der Service-Methode in Millisekunden. Der Wert '0' bedeutet kein Timeout. Optional. Defaultwert ist der Wert des Startparameters SERVICE_METHOD_EXEC_TIMEOUT
CbExecutionMode:N	Mode der Ausführung der Service-Methode Erlaubt sind als Werte die Konstanten: beasSequential beasConcurrent Optional. Defaultwert ist beasSequential.
CbEnforceURIQueryParamValuesAsString:L	Erzwinge, dass die Werte der URI Query Parameter immer als Strings behandelt werden Optional. Defaultwert ist False

Funktionen / Methoden

CbAddParameterInfo()

Fügt mit den übergebenen Parametern eine Parameterdefinition hinzu.

aParameterName:C - Name des Parameters.
aParameterDescription:C - Beschreibung des Parameters zu Dokumentationszwecken.
aParameterTypeName:C - Name eines bereits registrierten Typs des Parameters
aParameterKind:N - Legt fest, von welcher Art der Parameter ist.

Erlaubt sind als Werte die Konstanten:
- beasIn
- beasResult
aParameterUsage:N - Legt fest, wie die Werte des Parameters verwendet werden sollen.

Erlaubt sind als Werte die Konstanten:
- beasRequired
- beasOptional

Beispiel

CODE

//******************************************************************************
// Registriert und deregistriert die Servive-Methode
// "cb_RegisteredDynamicCbService".
//******************************************************************************

|oServiceRegInfo|
oServiceRegInfo := CreateObject("TBeasCbServiceRegInfo"),
Startseq,
  oServiceRegInfo.CbMethodName        := "cb_RegisteredDynamicCbService",
  oServiceRegInfo.CbMethodDescription := "Methode cb_RegisteredDynamicCbService",
  oServiceRegInfo.CbServiceTypes      := _OR(beasServiceTypeStandard, beasServiceTypeHttp),
  oServiceRegInfo.CbContextClass      := beasContext,
  oServiceRegInfo.CbVisibility        := beasDocumented,
  oServiceRegInfo.CbExecutionTimeout  := 100,
  oServiceRegInfo.CbExecutionMode     := beasConcurrent,
  oServiceRegInfo.CbProgramName       := "beas\dynamic_services\TestServices\Database",
  oServiceRegInfo.CbAddParameterInfo("Param0", "Dies ist Parameter 0", "Integer", beasResult, beasRequired ),
  oServiceRegInfo.CbAddParameterInfo("Param1", "Dies ist Parameter 1", "TCb_MyIntegerArray", beasIn, beasRequired ),
  oServiceRegInfo.CbAddParameterInfo("Param2", "Dies ist Parameter 2", "TCb_CompositeField", beasIn, beasOptional ),
  CbRegisterService(oServiceRegInfo),
Always,
  DestroyObject(oServiceRegInfo),
StopSeq,
CbUnregisterService("RegisteredDynamicCbService"),