XactCommerce Xact Objects
Home
News
XactCommerce
Typical Applications
Custom Development
Private Backend
XactScript Language
Performance
Deployment
Partners
Portfolio
About Us
leXml Language < Interface Modules & Commands < If_LineItemBrowser

If_LineItemBrowser
If_LineItemBrowser interface provides commands for browsing order line items

load
Called to load a list of items into the session.
 
Optional arguments:
owner_id = Owner ID of line items to browse or 0 for all owners (default=0)
cli_id = Client ID of line items to browse or 0 for all clients (default=0)
ord_id = Order ID of line items to browse or 0 for all orders (default=0)
close_ord_id = Closing Order ID of line items to browse or 0 for all orders (default=0)
item_id = Item ID of line items to browse or 0 for all items (default=0)
alt_item_id = Alternate Item ID of line items to browse or 0 for all (default=0)
line_refno =line ref number
orderby = Valid values: name,priceasc,pricedesc,id,partno,none (default=name)
search_text = Any text used to search in item name or descriptions
ord_type = Order Type
orderby = Order results by this column
isauthline = Wheather to show only authorization lines true/false (default=false)
isblanketline = Wheather to show only blanket lines true/false (default=false)


resume
Resumes an existing item browse session
Optional arguments:
startat - Item counter to start at (default=-1)
Returns 'yes' or 'no' depending on whether there was a session to resume


isready
Returns 'yes' or 'no' depending on if we have any more items to view. This will also return 'no' if we've just loaded an item list but haven't called next yet!


hasnext
Returns 'yes' or 'no' depending on whether there is a next item


next
Moves to next item and returns 'yes' or 'no' like isready


getcounter
Returns and prints the item counter


templatelinelist
This command allows a different approach to the listing of items. It loops 'itemcount' times and uses 'template' to create the HTML to list. 'template' contains HTML and can contain a series of special macros that will be replaced with specific info about the item. The item list also stops if no more items are available.
 
Here are the macros that can be included in the template:
 
##COUNT## - Replaced with a counter starting at 0
##NAME## - Replaced with Name of line item
##DESC## - Replaced with Description of line item
##SHDSEC## - Replaced with Short Description of line item
##LINE_ID## - Replaced with line item ID
##ITEM_ID## - Replaced with item ID
##OWNER_ID## - Replaced with owner ID
##CLI_ID## - Replaced with client ID
##ORD_ID## - Replaced with order ID
##ORD_REFID## - Replaced with order ref ID
##REL_ORD_ID## - Replaced with release order ID
##PRICE## - Replaced with line item price
##EXTPRICE## - Replaced with line item extended price
##ORDERED## - Replaced with line item ordered quantity
##STARTTIME## - Replaced with line item start time
##STOPTIME## - Replaced with line item stop time
##LINE_NO## - Replaced with line item number as it appears in the order
##AUTH_LINE## - Replaced with line item authorization line item id
##LINE_RELAUTH## - Replaced with number of releases authorized for the line item
##LAST_REL_TIME## - Replaced with the date of the most recent release
##ORD_TYPE## - Replaced with the order type
##REL_ORD_TYPE## - Replaced with the release order type
##CLINAME## - Replaced with the client name
 
Arguments:
itemcount - Number of items to display (default=10)
template - The main HTML template as described above (required)
jsescape -Wheather to jsEscape the results (default=no)
useasciitable - (true/false) - whether to output results in an ascii table default = false
tablespec - ColumnType/Prefix/Postfix/Width/Attr see AsciiTable spec
pagewidth - number of characters wide the AsciiTable should be
 
Returns how many line items were actually printed or "error:..." if an error occurred.


These are commands to print/get info about the current item They do nothing if we're not ready with an item in the result cursor! All of these that print something support 'prefix' and 'postfix'.


name
Prints employee name


cli_id
Prints and returns cli_id


totallinecount
Prints and returns total number of items in current cursor


remaininglinecount
Prints and returns number of items remaining
If 'truncateto' is set, this value will be limited to 'truncateto'
(e.g. for doing 'view next ## items')