method ApiGetRoleScopeValues

Description

Roles can be scoped to a single object (like for example a single project).
Run this method on the corresponding business component (= bproject) to get a list of possible objects (= projects) to scope a role to.

PreCondition

This method contains no default code.
It must be implemented in each business class that can be used as role scope individually.

Parameters

iiCompanyID	input	integer	current CompanyID
iiSharedSetID	input	integer	current SharedSetID
icBusComponentConcept	input	character	BusComponentConcept of the business-component
ocRoleScopeValues	output	character	chr(2) separated list with the RoleScopeValues
oiReturnStatus	output	integer	Return status of the method.

Internal usage

unused

program code (program/bdebtor.p)

<ANCESTOR-CODE>

    /* ====================================== */
    /* Get all Role-Scope-Values (DebtorCode) */
    /* ====================================== */
    <Q-1 run DebtorPrim (all) (Read) (NoCache)
          (input iiCompanyID, (CompanyId)
           input ?, (DebtorCode)
           input ?, (Debtor_ID)
           output dataset tqDebtorPrim) in BDebtor >
    for each tqDebtorPrim no-lock :
        assign ocRoleScopeValues = ocRoleScopeValues + chr(2) + 
                                   tqDebtorPrim.tcDebtorCode.
    end. /* for each tqDebtorPrim no-lock */
    if length(ocRoleScopeValues,"CHARACTER":U) > 1
    then assign ocRoleScopeValues = substring(ocRoleScopeValues,2,-1,"CHARACTER":U).

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