| Package
|
Description
|
| sapphire |
Contains only the LabVantageException class, which is an extension of java.lang.Exception. |
| sapphire.accessor |
Provides access to LabVantage components in the Application Server:
| Class | Accesses functionality provided by... | Use to... | | ActionProcessor | Action Processing Manager | Execute individual Actions or Actions in an Action Block. | | AttachmentProcessor | Attachment Processor | Attach files from multiple sources to SDIs. | | ConnectionProcessor | Client Connection Manager | Establish and manage connections to LabVantage. | | DAMProcessor | Data Access Manager | Lock data at the row level and handle RSets, which overcome Oracle's
limitation on the number of 'in' clause conditions. | | HttpProcessor | Tag Manager | Get framework data for 3.x series web applications | | QueryProcessor | Query Manager | Execute queries, SQL and get data from the LabVantage database. | | SDCProcessor | SDC Manager | Get data relevant to an SDC or linked SDC. | | SDIProcessor | SDI List | Get SDI data for specific request. | | SequenceProcessor | Sequence Manager | Get the next sequence number of an SDC, based on the sequence rule
configured for the SDC. | | TranslationProcessor | Translation Manager | Translate to different language sets through configuration. | | ActionException | Extension of sapphire.LabVantageException | Extended to support Actions. |
|
| sapphire.action |
Base classes for specialized LabVantage functionality:
| Class | Extend this class to... | | BaseAction | Create new Actions. | | BaseAuthentication | Authenticate users. | | BasePasswordValidator | Validate passwords. | | BaseScheduleTask | Create new Schedule Tasks. | | BaseSDCRules | Use SDC Rules. | | BaseSpecRule | Create new Specification Rules. |
|
| sapphire.error |
Contains the Error Detail and Error Handler classes. They're not commented
and no one coded them. They simply appeared one day. |
| sapphire.pageelements |
Contains only the BaseElement class. Extend this class to create your
own Elements (see Creating Elements
in the Web Page Designer). |
| sapphire.report |
Contains the JasperReportScriplet class to format Jasper reports according
to user locale/timezone/language. |
| sapphire.servlet |
Contains internal methods used by the Request Controller. |
| sapphire.tagext |
Provides functionality that supports LabVantage Custom Tags:
| Class | Use to... | | ActionTagInfo | Get information about Actions that are executed. | | ControlledPageTagInfo | Get information about the current page (WebPage SDI). | | PageTagInfo | Get values of page properties (from WebPage SDIs), request properties
(submitted from a form or URL), and session properties (information
about the current user). | | QueryTagInfo | Get information regarding Query SDIs. | | RefTypeTagInfo | Get information regarding Reference Type SDIs. | | SDIFormFailureTagInfo | Get and set form failure information. | | SDIFormSuccessTagInfo | Get and set form success information. | | SDITagInfo | Use LabVantage Custom Tag functionality. |
| NOTE: | | Do not try to create instances of these classes. Call methods in
each class on the instances specified below:
| Class | Instance | | Class | Instance | | ActionTagInfo | actioninfo | | ReftypeTagInfo | reftypeinfo | | PageTagInfo | pageinfo | | SDITagInfo | sdiinfo | | QueryTagInfo | queryinfo | | | |
|
|
| sapphire.util |
Provides utility functions such as :
| Class | Description | | ActionBlock | Defines Actions to be executed in an Action Block. | | DataSet | Lets you work with tabular data brought back from the database as
a JDBC result set. Tags within the Query and SDI tags work with these
result sets. Note that these are not LabVantage "Data Sets". | | FormatUtil | Formats a BigDecimal into a locale-sensitve string, or parses a
locale-sensitive string into a BigDecimal. | | ForwardUtil | Creates an HTML form inside of a JSP or servlet. | | HTTPUtil | Lets you work with cookies and redirect to other pages. | | SDIData | Stores and accesses data associated with one or more SDIs, including
primary and detail data (see Result
Set Types in the LabVantage Custom Tag Reference). | | SDIRequest | Defines requests for SDI data. | | StringUtil | Contains utilities that let you generate and manipulate strings. |
This package also contains the DBAccess interface, which provides direct
access to database tables for retrieving data, executing DML statements,
and running stored procedures. |
| sapphire.xml |
Getters and setters for Property
Lists used by the Web Page Designer. |
