project BLF > class BControlProperty > method ApiGetCustomisedLevelsV01

Description

Returns a list of customisation levels that are in use.


Parameters


icBusComponentCodeinputcharactermandatory
icBusActivityCodeinputcharacteroptional
iiLayerTypeinputintegerLimitation on which customization levels (= layer types) to look for :

0 / 1 = check all levels
2 = only check role + system level
3 = only check system level
icBusComponentLabelinputcharacter
icBusActivityLabelinputcharacter
icForminputcharacter
tCustomisedLevelsoutputtemp-table
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program3/bcontrolproperty.p)

    
    /* ============================================================================================ */
    /* This method is simply a wrapper to the non-api but remoting method GetCustomisedLevels where */
    /* we indicate that we also want the report-variants and the stored-searches in the result-set  */
    /* ============================================================================================ */
    <M-56 run GetCustomisedLevels
       (input  icBusComponentCode (icBusComponentCode), 
        input  icBusComponentLabel (icBusComponentLabel), 
        input  icBusActivityCode (icBusActivityCode), 
        input  icBusActivityLabel (icBusActivityLabel), 
        input  iiLayerType (iiLayerType), 
        input  true (ilIncludeRepVarAndStoredSearches), 
        input  icForm (icForm), 
        output tCustomisedLevels (tCustomisedLevels), 
        output viFcReturnSuper (oiReturnStatus)) in BControlProperty>
    if viFcReturnSuper < 0 or
       oiReturnStatus  = 0
    then assign oiReturnStatus = viFcReturnSuper.
    if oiReturnStatus < 0
    then return.
    
    
    
    


Sample code: how to call this method through RPCRequestService (QXtend Inbound)

define temp-table ttContext no-undo
    field propertyQualifier as character
    field propertyName as character
    field propertyValue as character
    index entityContext is primary unique
        propertyQualifier
        propertyName
    index propertyQualifier
        propertyQualifier.

define dataset dsContext for ttContext.

define variable vhContextDS as handle no-undo.
define variable vhExceptionDS as handle no-undo.
define variable vhServer as handle no-undo.
define variable vhInputDS as handle no-undo.
define variable vhInputOutputDS as handle no-undo.
define variable vhOutputDS as handle no-undo.
define variable vhParameter as handle no-undo.

/* Create context */
create ttContext.
assign ttContext.propertyName = "programName"
       ttContext.propertyValue = "BControlProperty".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiGetCustomisedLevelsV01".
create ttContext.
assign ttContext.propertyName = "applicationId"
       ttContext.propertyValue = "fin".
create ttContext.
assign ttContext.propertyName = "entity"
       ttContext.propertyValue = "1000".
create ttContext.
assign ttContext.propertyName = "userName"
       ttContext.propertyValue = "mfg".
create ttContext.
assign ttContext.propertyName = "password"
       ttContext.propertyValue = "".

/* Create input dataset */
create dataset vhInputDS.
vhInputDS:read-xmlschema("file", "xml/bcontrolproperty.apigetcustomisedlevelsv01.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icBusComponentCode = <parameter value>
       vhParameter::icBusActivityCode = <parameter value>
       vhParameter::iiLayerType = <parameter value>
       vhParameter::icBusComponentLabel = <parameter value>
       vhParameter::icBusActivityLabel = <parameter value>
       vhParameter::icForm = <parameter value>.

/* Connect the AppServer */
create server vhServer.
vhServer:connect("-URL <appserver-url>").

if not vhServer:connected()
then do:
    message "Could not connect AppServer" view-as alert-box error title "Error".
    return.
end.

/* Run */
assign vhContextDS = dataset dsContext:handle.

run program/rpcrequestservice.p on vhServer
    (input-output dataset-handle vhContextDS by-reference,
           output dataset-handle vhExceptionDS,
     input        dataset-handle vhInputDS by-reference,
     input-output dataset-handle vhInputOutputDS by-reference,
           output dataset-handle vhOutputDS).

/* Handle output however you want, in this example, we dump it to xml */
if valid-handle(vhExceptionDS)
then vhExceptionDS:write-xml("file", "Exceptions.xml", true).

if valid-handle(vhOutputDS)
then vhOutputDS:write-xml("file", "Output.xml", true).

/* Cleanup */
vhServer:disconnect().
assign vhServer = ?.

if valid-handle(vhInputDS)
then delete object vhInputDS.

if valid-handle(vhOutputDS)
then delete object vhOutputDS.

if valid-handle(vhExceptionDS)
then delete object vhExceptionDS.