EfficiencySpring: EfficiencySpring Coder's Guide

API Classes

Below are the key classes available within the EfficiencySpring API commonly used within customized code. For in-depth documentation of each property and function, you may utilize Visual Studio's Intellisense capabilities.

Class	Description
EfficiencyCommon.ContentManager.ContentImporter	This class provides the ability to import static content into EfficiencySpring from a folder structure containing HTML content files, and supporting files such as images and PDFs. Regular expressions are used to parse out the headers and footers of content files so that the content bodies can be saved into the Content database table.
EfficiencyCommon.DataAccess.AdapterProvider	This class provides a method for creating an AdapterProvider based on a SQL statement.
EfficiencyCommon.DataAccess.ReaderProvider	This class combines the Connection, Command, Reader, and Transaction objects from System.Data into one class, and provides methods for opening a connection to a database and running SQL queries. Methods exist for running queries that both do and do not return results. Connection strings passed into the constructor can be for SQL Server, OLEDB, or ODBC connections.
EfficiencyCommon.Navigation.SectionMenuCollection	This class assembles and contains all of the EfficiencyCommon.Navigation.SectionMenuItem objects necessary to render the navigation interfaces within an EfficiencySpring installation, including top menus, side menus, tree navigation, parent section links, etc...
EfficiencyCommon.Navigation.SectionMenuItem	This class inherits the EfficiencyCommon.Section class, and provides new properties for storing the menu behaviors for the section, as well as an array of the Section's submenu items. Instantiations of this class are commonly contained in an instantiation of a EfficiencyCommon.Navigation.SectionMenuCollection class.
EfficiencyCommon.Navigation.SubmenuItem	This class provides a representation of a section's submenu item. Instantiations of this class are typically stored as an array within an instantiation of the EfficiencyCommon.Navigation.SectionMenuItem class.
EfficiencyCommon.EfficiencySection	This class is used to represent a configured EfficiencySpring section. It includes functions for retrieving configuration from the EfficiencySpring database, including configured structure elements and rules.
EfficiencyCommon.Security.User	This class holds both a user's profile information, as well as their security rights for each section. Instantiations of this class are often passed into constructors and functions of other classes, as the User class provides the primary methods for evaluating a user's security privileges.
EfficiencyCommon.Utilities.CoreObjectFactory	This class is used to create instances of core EfficiencySpring objects, such as ContentPage, Record, RecordSearch, Instance, and StructureElement. An inherited version of this class can be used to create customized versions of the core EfficiencySpring objects.
EfficiencyCommon.Utilities.FormulaEvaluator	This class contains EfficiencySpring's mathematical formula evaluator. The evaluatior supports parentheses-based order-of-operations and the following operators: + - * / ^
EfficiencyCommon.Utilities.EfficiencySpringError	This class represents an error raised by EfficiencySpring, and contains the error's Type, Priority, Text, Related Section, and Error Code.
EfficiencyCommon.Utilities.EfficiencySpringErrorCollection	This class receives and stores errors raised by EfficiencySpring. HTML or Excel reports can then be generated from the class.