project BLF > class Session > method GetBusinessFields

Description

Returns a full description of all business fields of a business class, browse or report.


Parameters


icReferenceinputcharacter- <classname> for receiving business field information of a business class
- <classname>.<methodname> for receiving business field information of a browse or report
tBusinessFieldsoutputtemp-table
tCustomRelationoutputtemp-table
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


BLF
method BCustomField.ValReturnField
method BStoredSearch.GetFields
method Session.GetBusinessFieldsWithLng


program code (program3/session.p)

if oiReturnStatus = 0
then oiReturnStatus = -98.

empty temp-table tBusinessFields.

if vlLoginFailed
then do:
    <M-1 run SetMessage
          (input  #T-6'You are not logged in.':100(28)t-6# (icMessage), 
           input  '' (icArguments), 
           input  '' (icFieldName), 
           input  '' (icFieldValue), 
           input  'D':U (icType), 
           input  2 (iiSeverity), 
           input  '' (icRowid), 
           input  'BLF-400':U (icFcMsgNumber), 
           input  '' (icFcExplanation), 
           input  '' (icFcIdentification), 
           input  '' (icFcContext), 
           output viFcReturnSuper (oiReturnStatus)) in Session>
    assign oiReturnStatus = -5.
    return.
end.

if num-entries(icReference,".":U) = 2
then assign vcClass     = entry(1,icReference,".":U)
            icReference = entry(2,icReference,".":U).
else assign vcClass     = icReference.

if vcClass matches "*SAO":U
then assign vcClass = substring(vcClass,1,length(vcClass,"CHARACTER":U) - 3,"CHARACTER":U).

if index(vcClass, "[") = 0
then assign vcUserDefinedContext = "".
else assign vcUserDefinedContext = entry(1, entry(2, vcClass, "["), "]")
            vcClass              = entry(1, vcClass, "[").

if search("program/":U + lc(vcClass) + ".r":U) <> ?
or search("program/":U + lc(vcClass) + ".p":U) <> ?
then do:
    <M-2 run BusinessClassActions
       (input  vcClass (icClassShortname), 
        input  'START+OPEN':U (icAction), 
        input  no (ilSubtransaction), 
        input-output vidatabase1OC (biClassOpenCount), 
        input-output vhdatabase1Inst (bhClassInstanceHandle), 
        input-output vidatabase1ID (biClassInstanceId), 
        input  '' (icDraftReference), 
        input  vcUserDefinedContext (icUserDefinedContext), 
        output viFcReturnSuper (oiReturnStatus)) in Session>

    if viFcReturnSuper <> 0
    then oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper < 0
    then return.
    
    <M-5 run GetBusinessFields
       (input  icReference (icReference), 
        output tBusinessFields (tBusinessFields), 
        output tCustomRelation (tCustomRelation), 
        output viLocalReturn (oiReturnStatus)) in database>
    
    <M-4 run BusinessClassActions
       (input  vcClass (icClassShortname), 
        input  'CLOSE+STOP':U (icAction), 
        input  no (ilSubtransaction), 
        input-output vidatabase1OC (biClassOpenCount), 
        input-output vhdatabase1Inst (bhClassInstanceHandle), 
        input-output vidatabase1ID (biClassInstanceId), 
        input  '' (icDraftReference), 
        input  vcUserDefinedContext (icUserDefinedContext), 
        output viFcReturnSuper (oiReturnStatus)) in Session>

    if viLocalReturn <> 0
    then oiReturnStatus = viLocalReturn.
    if viLocalReturn < 0
    then return.

    /* BLF-3818 sort filter fields without explicit sequence alphabetically on (translated) side label */
    for each tBusinessFields where
             tBusinessFields.tcFcFieldType = "F":U
             by tBusinessFields.tiSequence descending on error undo, throw:
        viFilterSequence = tBusinessFields.tiSequence.
        leave.
    end.
    
    for each tBusinessFields where
             tBusinessFields.tcFcFieldType = "F":U and
             tBusinessFields.tiSequence = 0
             by tBusinessFields.tcSideLabel on error undo, throw:
        viFilterSequence = viFilterSequence + 1.
        tBusinessFields.tiSequence = viFilterSequence.
    end.
end.
else do:
    if search ("appinfo/":U + lc(icReference) + "_bf.r":U) <> ?
    or search ("appinfo/":U + lc(icReference) + "_bf.p":U) <> ?
    then run value ("appinfo/":U + lc(icReference) + "_bf.p":U) (input table tBusinessFields by-reference, input vhFcSuper, output oiReturnStatus).
end.

if can-find(first tBusinessFields where
                  tBusinessFields.tcFcFieldType = "F" and
                  lookup("IsEntityCode", tBusinessFields.tcValidationMask, chr(2)) > 0)
then do:
    <M-39 run FixEntityFilters
       (input  vcClass (icicReportClass), 
        input  icReference (icReference), 
        output viFcReturnSuper (oiReturnStatus)) in Session>

    if viFcReturnSuper <> 0
    then assign oiReturnStatus = viFcReturnSuper.

    if viFcReturnSuper < 0
    then return.
end.

if oiReturnStatus = -98
then oiReturnStatus = 0.


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 = "Session".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "GetBusinessFields".
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 = "".

/* 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.