project BLF > class BNumber > API query SelectNumbers

Description

list of available number sequences


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
iiCompanyIdi
tNumbr.Numbri=,>=,>,<>,<=,<
tNumbr.NumbrIsActivel=,<>
tNumbr.NumbrStatusc=,>=,>,<>,<=,<,begins,can-do,matches
tNumbr.NumbrTypec=,>=,>,<>,<=,<,begins,can-do,matches
tNumbr.NumbrYeari=,>=,>,<>,<=,<


Parameters (internal)


iiCompanyIdintegerCompany id


query condition


  each Numbr where
Numbr.Company_Id = iiCompanyId AND


query sort order


Numbr.NumbrYear (ascending)
Numbr.NumbrType (ascending)
Numbr.Numbr (ascending)


query resultset tqSelectNumbers


field namedata typedb fielddescription
tiNumbrYearintegerNumbr.NumbrYearYear
tcNumbrTypecharacterNumbr.NumbrTypeType
tcNumbrStatuscharacterNumbr.NumbrStatuspossible values:
FREE
Every sequence (combination of company + year + sequence type) always has exactly one 'FREE' status record. This record indicates the next available number and will be increased by one whenever this number is used in a transaction.
CLAIMED
This record indicates a number that is claimed by an ongoing transaction. This record will be deleted when the transaction is committed. When a transaction ends abnormally without releasing it's claimed numbers, the housekeeping process will set the status of these records to 'RELEASED'.
RELEASED
This record indicates a number that was claimed by a cancelled transaction. This record can be 'CLAIMED' by other transactions.
DRAFT
This record indicates a number that is claimed by draft business objects (see table fcDraftInstance).
tcNumbrStatusCalccharactercalculatedNumbrStatusCalc
tiNumbrintegerNumbr.NumbrNumber
tlNumbrIsActivelogicalNumbr.NumbrIsActiveInactive sequences cannot be used in a transaction.
NumbrCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = rowid(Numbr)


Internal usage


BLF
lookup query on tDomains.DomainTimeZone


Sample code: how to call this query 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 = "BNumber".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectNumbers".
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/bnumber.selectnumbers.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().

assign vhParameter::icRange = "A"
       vhParameter::icRowid = ""
       vhParameter::iiRownum = 0
       vhParameter::iiNumber = 5 /* Number of records to read */
       vhParameter::icSortColumns = ""
       vhParameter::ilCountOnly = false
       vhParameter::ilForwardRead = true
       vhParameter::iiMaximumBrowseRecordsToCount = 0.

vhParameter = vhInputDS:get-buffer-handle("tFilter").
vhParameter:buffer-create().

assign vhParameter::<field-name-1> = <field-value-1>
       vhParameter::<field-name-2> = <field-value-2>
       ...

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