project BLF > class Query Component > 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


unused


program code (program/query.p)

<ANCESTOR-CODE>

run appinfo/classtables.p (input "", output vcFcMaskList, output vcDBTables).

for each businessFields where
         num-entries(businessFields.tcFcFieldName, ".") = 2
         break by entry(1, businessFields.tcFcFieldName, ".")
        on error undo, throw:
    if first-of(entry(1, businessFields.tcFcFieldName, ".")) and
       can-do (vcDBTables, substr(entry(1, businessFields.tcFcFieldName, "."), 2, -1, "CHARACTER"))
    then assign vcCustomTables = vcCustomTables + "," + entry(1, businessFields.tcFcFieldName, ".")
                vcFieldType    = businessFields.tcFcFieldType.
end.

do viFcCount1 = num-entries(vcCustomTables) to 2 by -1: /* First entry is blanc */
    assign vcDBTables = entry(viFcCount1, vcCustomTables).

    <Q-59 run GetCustomFieldsForTable (all) (Read) (Cache)
       (input vcDBTables, (TableName)
        input '', (ComponentName)
        output dataset tqCustomFieldsForTable) in BCustomField >

    for each tqCustomFieldsForTable on error undo, throw:
    
        /* translations are not loaded by the query itself when user setting use object translations is not active */
        /*
        <M-62 run GetTranslationForObject
           (input  novalue (iiObjectID), 
            input  novalue (icLanguageCode), 
            input  'Show Usage' (icOriginal), 
            input  novalue (icFieldName), 
            output novalue (ocTranslation), 
            output novalue (oiReturnStatus)) in ComponentPool>
        */
        if not vlObjectTranslationsActive
        then do:
            run GetTranslationForObject
               (input tqCustomFieldsForTable.tiCustomField_ID,
                input current-language,
                input "",
                input "",
                output vcValueList,
                output viFcReturnSuper).
    
            if viFcReturnSuper <> 0
            then assign oiReturnStatus = viFcReturnSuper.
    
            if viFcReturnSuper < 0
            then return.
    
            if lookup("CustomFieldSideLabel", vcValueList, "|") > 0 and
               entry(lookup("CustomFieldSideLabel", vcValueList, "|") + 1, vcValueList, "|") <> ""
            then assign tqCustomFieldsForTable.tcCustomFieldSideLabel = entry(lookup("CustomFieldSideLabel", vcValueList, "|") + 1, vcValueList, "|").
    
            if lookup("CustomFieldColumnLabel", vcValueList, "|") > 0 and
               entry(lookup("CustomFieldColumnLabel", vcValueList, "|") + 1, vcValueList, "|") <> ""
            then assign tqCustomFieldsForTable.tcCustomFieldColumnLabel = entry(lookup("CustomFieldColumnLabel", vcValueList, "|") + 1, vcValueList, "|").
        end.
        
        assign vcValueList = "".

        if tqCustomFieldsForTable.tcCustomFieldUIControlType = "ComboBox" and
          (tqCustomFieldsForTable.tiStoredSearch_ID          = 0          or
           tqCustomFieldsForTable.tiStoredSearch_ID          = ?)
        then do:
            <Q-48 run CustomFieldValues (all) (Read) (NoCache)
               (input tqCustomFieldsForTable.tcCustomFieldFieldName, (BusinessFieldName)
                input '', (Value)
                output dataset tqCustomFieldValues) in BCustomField >

            for each tqCustomFieldValues by tqCustomFieldValues.tiCustomValueSequence on error undo, throw:
                assign vcValueList = vcValueList + chr(2) +
                                     tqCustomFieldValues.tcCustomValueCode + chr(2) +
                                     tqCustomFieldValues.tcCustomValueCode.
            end.

            assign vcValueList = substr(vcValueList, 2, -1, "CHARACTER").
            empty temp-table tqCustomFieldValues.
        end.

        create tBusinessFields.

        assign tBusinessFields.tcFcFieldName     = tqCustomFieldsForTable.tcCustomFieldFieldName
               tBusinessFields.tcSideLabel       = tqCustomFieldsForTable.tcCustomFieldSideLabel
               tBusinessFields.tcColumnLabel     = tqCustomFieldsForTable.tcCustomFieldColumnLabel
               tBusinessFields.tcFcFieldType     = vcFieldType
               tBusinessFields.tcFcDescription   = tqCustomFieldsForTable.tcCustomFieldDescription
               tBusinessFields.tcDataType        = tqCustomFieldsForTable.tcCustomFieldDataType
               tBusinessFields.tcDisplayFormat   = tqCustomFieldsForTable.tcCustomFieldDisplayFormat
               tBusinessFields.tcControlType     = tqCustomFieldsForTable.tcCustomFieldUIControlType
               tBusinessFields.tiStoredSearch_ID = tqCustomFieldsForTable.tiStoredSearch_ID
               tBusinessFields.tcValueList       = vcValueList.

        if tBusinessFields.tiStoredSearch_ID <> 0 and
           tBusinessFields.tiStoredSearch_ID <> ?
        then do:
            <Q-83 run StoredSearchPrim (all) (Read) (Cache)
               (input tBusinessFields.tiStoredSearch_ID, (StoredSearchID)
                input ?, (Name)
                input ?, (LookupReference)
                input ?, (UsrId)
                input ?, (CompanyId)
                output dataset tqStoredSearchPrim) in BStoredSearch >

            find first tqStoredSearchPrim where
                       tqStoredSearchPrim.tiStoredSearch_ID = tBusinessFields.tiStoredSearch_ID
                       no-error.

            if available tqStoredSearchPrim
            then do:
                if tqStoredSearchPrim.tcStoredSearchLookupRef = "QAD.Browse.MfgProLookupProvider"
                then assign tBusinessFields.tcLookupQuery = tqStoredSearchPrim.tcStoredSearchLookupRef + ":" +
                                                            tqStoredSearchPrim.tcStoredSearchName      + ":" +
                                                            tqCustomFieldsForTable.tcCustomFieldSSReturnField.
                else
                if index(tqStoredSearchPrim.tcStoredSearchLookupRef, ":") > 0
                then assign tBusinessFields.tcLookupQuery = tqStoredSearchPrim.tcStoredSearchLookupRef.
                else
                if tqCustomFieldsForTable.tcCustomFieldUIControlType = "ComboBox"
                then do:
                    <M-57 run GetBusinessFieldsGenCode
                       (input  tqStoredSearchPrim.tcStoredSearchLookupRef (icGenCode), 
                        output vcValueList (ocValueList), 
                        output viFcReturnSuper (oiReturnStatus)) in query>
                    if viFcReturnSuper <> 0
                    then assign oiReturnStatus = viFcReturnSuper.

                    if viFcReturnSuper < 0
                    then return.

                    assign tBusinessFields.tcValueList = vcValueList.
                end.
                else
                if tqStoredSearchPrim.tcStoredSearchName = {&LOOKUPTYPE-GENCODE}
                then assign tBusinessFields.tcLookupQuery       = "BMfgGeneralizedCodeSAO.SelectGeneralizedCode"
                            tBusinessFields.tcLookupFilterField = "tcode_mstr.code_value"
                            tBusinessFields.tcLookupReturnField = "tqSelectGeneralizedCode.tccode_value"
                            tBusinessFields.tcRelatedObject     = tqStoredSearchPrim.tcStoredSearchLookupRef.
                else do:
                    assign vcLookupRef = if num-entries(tqStoredSearchPrim.tcStoredSearchLookupRef, "/") > 1
                                         then entry(2, tqStoredSearchPrim.tcStoredSearchLookupRef, "/")
                                         else tqStoredSearchPrim.tcStoredSearchLookupRef.

                    if num-entries(vcLookupRef, ".") = 2
                    then do:
                        assign tBusinessFields.tcLookupQuery       = entry(1, vcLookupRef, ".") + "SAO." + entry(2, vcLookupRef, ".")
                               tBusinessFields.tcLookupFilterField = tqCustomFieldsForTable.tcCustomFieldSSReturnField.

                        if tBusinessFields.tcLookupFilterField                  <> "" and
                           tBusinessFields.tcLookupFilterField                  <> ?  and
                           num-entries(tBusinessFields.tcLookupFilterField, ".") = 2
                        then assign tBusinessFields.tcLookupReturnField = "tq" + entry(2, vcLookupRef, ".") + ".t" + tBusinessFields.tcDataType + entry(2, tBusinessFields.tcLookupFilterField, ".").
                    end.
                end.
            end.
        end.

        if vcFieldType = "F"
        then do:
            find first tBusinessFields where
                       tBusinessFields.tcFcFieldType = "B"
                       no-error.

            if available tBusinessFields
            then do:
                create tBusinessFields.

                assign vcTable                           = entry(1, tBusinessFields.tcFcFieldName, ".")
                       tBusinessFields.tcFcFieldName     = vcTable + "." + replace(substr(tqCustomFieldsForTable.tcCustomFieldFieldName, 2, -1, "CHARACTER"), ".", "_")
                       tBusinessFields.tcSideLabel       = tqCustomFieldsForTable.tcCustomFieldSideLabel
                       tBusinessFields.tcColumnLabel     = tqCustomFieldsForTable.tcCustomFieldColumnLabel
                       tBusinessFields.tcFcFieldType     = "C"
                       tBusinessFields.tcFcDescription   = tqCustomFieldsForTable.tcCustomFieldDescription
                       tBusinessFields.tcDataType        = tqCustomFieldsForTable.tcCustomFieldDataType
                       tBusinessFields.tcDisplayFormat   = tqCustomFieldsForTable.tcCustomFieldDisplayFormat
                       tBusinessFields.tcControlType     = tqCustomFieldsForTable.tcCustomFieldUIControlType
                       tBusinessFields.tiStoredSearch_ID = tqCustomFieldsForTable.tiStoredSearch_ID
                       tBusinessFields.tcValueList       = vcValueList.
            end.
        end.
    end.
end.


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 = "query".
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.