CSP page that provides a standard lookup for wizard-generated forms. More...

Inheritance diagram for PageLookup:

[legend]

Collaboration diagram for PageLookup:

[legend]

Static Public Member Functions
_.Library.Status	BuildSelectStatement (_.Library.String class, _.Library.List proplist, _.Library.String statement, _.Library.Boolean getcount, _.Library.String idname, _.Library.String select, _.Library.Integer idfield)
	Constructs a SELECT statement for the property list proplist.

_.Library.Status	CreateResultSet (_.Library.String class, _.Library.List restrict, _.Library.List return, _.Library.List orderby, _.Library.Boolean getcount, _.Library.ResultSet resultset, _.Library.Integer rcount, _.Library.String idname, _.Library.Integer idfield)
	Constructs a query using the input values, opens a <CLASS>ResultSet</CLASS> object. More...

_.Library.Status	GetPropSqlName (_.Library.String classname, _.Library.String prop, _.Library.String column)
	Returns the SQL name of property prop for class classname More...

_.Library.List	GetPropType (_.Library.String classname, _.Library.String prop)
	Returns the type (SQL Category) of property prop for class classname.

_.Library.Status	OnPage ()
	Event handler for PAGE event: this is invoked in order to More...

_.Library.String	PageName ()
	URL Name of this class.

Static Public Member Functions inherited from Page
_.Library.Status	ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value)
	You pass this the <parameter>url</parameter> of the page you are going to and a. More...

_.Library.Binary	Decrypt (_.Library.String data)
	Decrypts the input string using the session.Key value that is unique to. More...

_.Library.String	Encrypt (_.Library.Binary data)
	Encrypts the input string using the session.Key value that is unique to this. More...

_.Library.String	EscapeHTML (in)
	This method converts input HTML text into Escaped HTML text.

_.Library.String	EscapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in input URL string into Escaped URL string. More...

_.Library.String	HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile)
	This method returns the string that needs to be written to the current. More...

_.Library.String	HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker)
	This method returns the string that needs to be written to the current. More...

	Include (_.Library.String url)
	Include another csp page or file in the output at this point. More...

_.Library.String	InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra)
	Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More...

_.Library.String	InsertHiddenFields (_.Library.String url, _.Library.String query)
	Return the string containing the hidden form tags. More...

_.Library.Boolean	IsPrivate ()
	Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>).

_.Library.String	Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ)
	Tranforms the link specified by link into a URL and returns it as a string. More...

_.Library.Status	OnHTTPHeader (_.Library.Boolean OutputBody)
	Event handler for PAGE event: this is invoked in order to More...

	OnPageError (_.Library.Status sc)
	Event handler for any error that occurs on the page. More...

	OnPostHTTP ()
	Event handler for POSTPAGE event: this is invoked after the data. More...

_.Library.Status	OnPostHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked after a hyperevent method is called on this page.

_.Library.Boolean	OnPreHTTP ()
	Event handler for PreHTTP event: this is invoked before. More...

_.Library.Status	OnPreHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked before a hyperevent method is called on this page. More...

_.Library.Status	Page (_.Library.Boolean skipheader)
	Process a request to serve a CSPPage. More...

_.Library.String	QuoteJS (in)
	This method converts input string into quoted JavaScript literal.

_.Library.String	RewriteURL (_.Library.String url)
	This method will rewrite a URL to use #url()# if needed.

	ShowError (_.Library.Status sc)
	Display a <class>Status</class> error code to the CSP Page.

	StartTimer (_.Library.String name)
	Used to get performance information on your CSP pages. More...

	StopTimer (_.Library.String name)
	Used to time performance information on your CSP pages. More...

	ThrowError (_.Library.Status sc)
	Passed a <class>Status</class> code this goes to the error page passing this status code.

_.Library.String	UnescapeHTML (in)
	This method converts Escaped HTML text into normal HTML text.

_.Library.String	UnescapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in Escaped URL string back to its original form. More...

Static Public Attributes
	CANCELBTN = None
	CSP page that provides a standard lookup for wizard-generated forms. More...

	CHARSET = None
	Make default charset for the page UTF-8.

	CLEARBTN = None
	Caption for Clear Button.

	DEFAULTCAPTION = None
	Caption displayed if none specified (for normal mode).

	ENCODED = None
	Override ENCODED from CSP.Page.

	FINDMSG1 = None
	First half of "Find all" message.

	FINDMSG2 = None
	Second half of "Find all" message.

	FOUNDMSG1 = None
	First half of "Items Found" message.

	FOUNDMSG2 = None
	Second half of "Items Found" message.

	NOCRITERIA = None
	Error message to display when no criteria are specified. More...

	NOMATCH = None
	No matching items message.

	PREDICATELIST = None
	List of values displayed in search predicate combo box.

	PRIVATE = None
	Override PRIVATE from CSP.Page.

	SEARCHBTN = None
	Caption for Search Button.

	SHOWNMSG1 = None
	First half of "Items Shown" message.

	SHOWNMSG2 = None
	Second half of "Items Shown" message.

Static Public Attributes inherited from Page
	CHARSET = None
	The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More...

	CONTENTTYPE = None
	Specifies the default content type for the page. More...

	CONVERTINPUTSTREAM = None
	Specifies if input request.Content or request.MimeData values are converted from their. More...

	CSPFILE = None
	If this page was compiled from a .csp file, then this parameter contains the. More...

	CSPSTRICT = None
	The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More...

	CSPURL = None
	This parameter is used to make sure that if multiple. More...

	CSPXHTML = None
	The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More...

	DOMAIN = None
	The default domain for csp:text, span and div tags. More...

	ENCODED = None
	Controls how the query parameters for this page are passed, it can. More...

	ERRORPAGE = None
	Specify a custom error page to call if there are any problems with generating this page. More...

	EXPIRES = None
	Specified the default value for the response.Expires. More...

	NOCHARSETCONVERT = None
	Specifies if we wish to turn off charset conversion for this page. More...

	PAGETIMING = None
	If this parameter is true then we automatically record timing statistics of how long it takes to. More...

	PRIVATE = None
	Controls the access to the page, it can be set to one of the following: More...

	SECURITYRESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...

	TIMINGSLOTS = None
	Used by the timing to decide how many slots a day should be divided up into. More...

	UseSession = None
	This parameter controls the CSP session support. More...

Static Private Member Functions
	__ShowCaption ()
	Display the caption for a lookup page.

	__ShowCriteria (_.Library.String classname, _.Library.List where)
	Display the criteria form for a lookup page. More...

	__ShowForm (_.Library.String classname, _.Library.List where, _.Library.List select, _.Library.String currval)
	Display the criteria form for a lookup page. More...

	__ShowNoCriteria ()
	Display an error message when search criteria must be specified. More...

	__ShowOneChoice (_.Library.String val, _.Library.String id, _.Library.String initval)
	Display a choice option.

	__ShowPredicates (_.Library.String name, _.Library.String pred, _.Library.Boolean showOptions)
	Display a list of predicates in a SELECT box.

_.Library.Status	__ShowResults (_.Library.String classname, _.Library.List select, _.Library.List where, _.Library.List sort, _.Library.Integer maxrows, _.Library.Boolean showcount, _.Library.String idname)
	Display the results of the lookup in an HTML table.

	__ShowScripts ()
	Display the client scripts for the lookup page. More...

	__ShowSelectChoices (_.Library.String classname, _.Library.String name, _.Library.String initval, _.Library.String pred)
	Display the choices for a select predicate.

	__ShowSort (_.Library.List select, _.Library.String currval)
	Display the sort options for a lookup page. More...

	__ShowStyleSheet ()
	Display the HTML Style Sheet for the lookup page. More...

	__ShowTitle ()
	Display the title for a lookup page.

Detailed Description

CSP page that provides a standard lookup for wizard-generated forms.

It expects the following input:

CLASSNAME	Name of class to perform lookup on.
OBJID	ID of current instance.
SELECT	A comma-delimited list of fields to display in the search result table. Each field is of the form 'property alias\|desc' where alias and \|desc are optional. If not specified, the WHERE list is used as the SELECT list.
WHERE	A comma-delimited list of fields to search on. Each field is of the form 'property alias\|desc' where alias and \|desc are optional.
ORDER	A comma-delimited list of fields used to sort the search results. Each field is of the form 'property \|desc' where \|desc is optional.
MAXROWS	Maximum rows to display; if missing don't execute query.
TARGET	URL of page to return to with results.
CAPTION	Caption for search window.
OPTIONS	Comma separated list of feature codes. These include popup, create, and clear.
OBJIDATTR	The name of the OBJID attribute for the associated form.

Note: For range operations the value in the WHERE parameter contains two values delimited by &.

Member Function Documentation

◆ CreateResultSet()

_.Library.Status CreateResultSet	(	_.Library.String	class,
		_.Library.List	restrict,
		_.Library.List	return,
		_.Library.List	orderby,
		_.Library.Boolean	getcount,
		_.Library.ResultSet	resultset,
		_.Library.Integer	rcount,
		_.Library.String	idname,
		_.Library.Integer	idfield
	)

static

Constructs a query using the input values, opens a <CLASS>ResultSet</CLASS> object.

using this query and returns it via resultset.

class: The name of the class to perform the lookup on.
restrict: A list of restrictions as $lb(property,value).
return: A $list of properties to return in the resultset.
orderby: A list of $lb(property,ASC|DESC) that specify the order of the result set.
getcount: If true, the query should fetch the number of rows in the result.
resultset: Returns a <CLASS>ResultSet</CLASS> object by reference.
rcount: Returns number of selected rows by reference. -1 indicates that the row count is in column 1 of the result set.

Returns a <CLASS>Status</CLASS> indicating success or failure.

◆ GetPropSqlName()

_.Library.Status GetPropSqlName	(	_.Library.String	classname,
		_.Library.String	prop,
		_.Library.String	column
	)

static

Returns the SQL name of property prop for class classname

in field.

◆ OnPage()

_.Library.Status OnPage ( )

static

Event handler for PAGE event: this is invoked in order to

display a csp page.

Reimplemented from Page.

◆ __ShowCriteria()

__ShowCriteria	(	_.Library.String	classname,
		_.Library.List	where
	)

staticprivate

Display the criteria form for a lookup page.

where is $list of criteria, each element is $LB(name,pred,val...)

◆ __ShowForm()

__ShowForm	(	_.Library.String	classname,
		_.Library.List	where,
		_.Library.List	select,
		_.Library.String	currval
	)

staticprivate

Display the criteria form for a lookup page.

where is $list of criteria, each element is $LB(name,pred,val,alias)

select is $list of fields that can be sorted on

currval is current sort field

◆ __ShowNoCriteria()

__ShowNoCriteria ( )

staticprivate

Display an error message when search criteria must be specified.

before a search is requested (OPTIONS=CriteriaRequired) and no criteria are specified.

◆ __ShowScripts()

__ShowScripts ( )

staticprivate

Display the client scripts for the lookup page.

This has to be called within the HEAD section of the document.

◆ __ShowSort()

__ShowSort	(	_.Library.List	select,
		_.Library.String	currval
	)

staticprivate

Display the sort options for a lookup page.

select is a list of selected fields.

◆ __ShowStyleSheet()

__ShowStyleSheet ( )

staticprivate

Display the HTML Style Sheet for the lookup page.

This has to be called within the HEAD section of the document.

Member Data Documentation

◆ CANCELBTN

CANCELBTN = None

static

CSP page that provides a standard lookup for wizard-generated forms.

It expects the following input:

CLASSNAME	Name of class to perform lookup on.
OBJID	ID of current instance.
SELECT	A comma-delimited list of fields to display in the search result table. Each field is of the form 'property alias\|desc' where alias and \|desc are optional. If not specified, the WHERE list is used as the SELECT list.
WHERE	A comma-delimited list of fields to search on. Each field is of the form 'property alias\|desc' where alias and \|desc are optional.
ORDER	A comma-delimited list of fields used to sort the search results. Each field is of the form 'property \|desc' where \|desc is optional.
MAXROWS	Maximum rows to display; if missing don't execute query.
TARGET	URL of page to return to with results.
CAPTION	Caption for search window.
OPTIONS	Comma separated list of feature codes. These include popup, create, and clear.
OBJIDATTR	The name of the OBJID attribute for the associated form.

Note: For range operations the value in the WHERE parameter contains two values delimited by &.

Caption for Cancel Button.

◆ NOCRITERIA

NOCRITERIA = None

static

Error message to display when no criteria are specified.

for a search and the search button is pressed.

Static Public Member Functions

Static Public Attributes

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ CreateResultSet()

◆ GetPropSqlName()

◆ OnPage()

◆ __ShowCriteria()

◆ __ShowForm()

◆ __ShowNoCriteria()

◆ __ShowScripts()

◆ __ShowSort()

◆ __ShowStyleSheet()

Member Data Documentation

◆ CANCELBTN

◆ NOCRITERIA