===== Vortex API =====

Here we will continously document the API for scripting the Vortex. For general information about Vortex scripting, see [[vortex:general#scripting|Vortex scripting]].

==== Vortex Scripting ====
  * [[vortex:scripting:cli|Command Line Scripting]]
  * [[vortex:scripting:tablescripts|Table Scripts]]
  * [[vortex:scripting:tablemethods|Table Methods]]
  * [[vortex:scripting:webservices|SOAP Webservices]]
  * [[vortex:scripting:restservices|REST Webservices]]
  * [[vortex:scripting:htmlmarkup|HTML Markup]]
  * [[vortex:scripting:vxstring|VxString]]
  * [[vortex:scripting:vxtr|vx/tr - classes]] - a new method for easy access to TableRecords

==== API Documentation : Classes (OLD) ====
  * [[vortex:api:fieldfactory|FieldFactory]]
  * [[vortex:api:field|Field]]
    * [[vortex:api:datafield|DataField]]
      * [[vortex:api:categoryfield|CategoryField]]
      * [[vortex:api:checkboxfield|CheckboxField]]
      * [[vortex:api:datefield|DateField]]
      * [[vortex:api:dropdownfield|DropdownField]]
      * [[vortex:api:filefield|FileField]]
      * [[vortex:api:floatfield|FloatField]]
      * [[vortex:api:intfield|IntField]]
      * [[vortex:api:passwordfield|PasswordField]]
      * [[vortex:api:relationfield|RelationField]]
      * [[vortex:api:textfield|TextField]]
  * [[vortex:api:filter|Filter]]
      * [[vortex:api:filterdata|FilterData]]
  * [[vortex:api:import|Import]]
  * [[vortex:api:mailer|Mailer]]
      * [[vortex:api:mailattachment|MailAttachment]]
      * [[vortex:api:mailmessage|MailMessage]]
  * [[vortex:api:optimizer|Optimizer]]
  * [[vortex:api:relationfactory|RelationFactory]]
  * [[vortex:api:relation|Relation]]
  * [[vortex:api:table|Table]]
  * [[vortex:api:tablefactory|TableFactory]]
  * [[vortex:api:tablerecord|TableRecord]]
  * [[vortex:api:tablerecordfactory|TableRecordFactory]]
  * [[vortex:api:user|User]]
  * [[vortex:api:view|View]]
  * [[vortex:api:vortex|Vortex]]
  * [[vortex:api:vxstringparser|VxStringParser]]

==== API Documentation : Classes (NEW) ====

  * [[vortex:apidoc:ajaxhandler|AjaxHandler]]
  * [[vortex:apidoc:categoryfield|CategoryField]]
  * [[vortex:apidoc:checkboxfield|CheckBoxField]]
  * [[vortex:apidoc:colorstatusfield|ColorStatusField]]
  * [[vortex:apidoc:csvformatter|CSVFormatter]]
  * [[vortex:apidoc:datafield|DataField]]
  * [[vortex:apidoc:datefield|DateField]]
  * [[vortex:apidoc:dbhandler|DBHandler]]
  * [[vortex:apidoc:dbi|DBI]]
  * [[vortex:apidoc:dbiexport|DBIExport]]
  * [[vortex:apidoc:dbifilehandler|DBIFileHandler]]
  * [[vortex:apidoc:dbiimport|DBIImport]]
  * [[vortex:apidoc:details|Details]]
  * [[vortex:apidoc:display|Display]]
  * [[vortex:apidoc:dropdownfield|DropDownField]]
  * [[vortex:apidoc:export|Export]]
  * [[vortex:apidoc:field|Field]]
  * [[vortex:apidoc:fieldfactory|FieldFactory]]
  * [[vortex:apidoc:filefield|FileField]]
  * [[vortex:apidoc:filter|Filter]]
  * [[vortex:apidoc:filterdata|FilterData]]
  * [[vortex:apidoc:floatfield|FloatField]]
  * [[vortex:apidoc:getdata|GetData]]
  * [[vortex:apidoc:group|Group]]
  * [[vortex:apidoc:history|History]]
  * [[vortex:apidoc:htmlareafield|HTMLAreaField]]
  * [[vortex:apidoc:import|Import]]
  * [[vortex:apidoc:inparser|InParser]]
  * [[vortex:apidoc:intfield|IntField]]
  * [[vortex:apidoc:lang|Lang]]
  * [[vortex:apidoc:logger|Logger]]
  * [[vortex:apidoc:mailattachment|MailAttachment]]
  * [[vortex:apidoc:mailer|Mailer]]
  * [[vortex:apidoc:mailmessage|MailMessage]]
  * [[vortex:apidoc:menu|Menu]]
  * [[vortex:apidoc:optimizer|Optimizer]]
  * [[vortex:apidoc:passwordfield|PasswordField]]
  * [[vortex:apidoc:query|Query]]
  * [[vortex:apidoc:relation|Relation]]
  * [[vortex:apidoc:relationdata|RelationData]]
  * [[vortex:apidoc:relationfactory|RelationFactory]]
  * [[vortex:apidoc:relationfield|RelationField]]
  * [[vortex:apidoc:restservicehandler|RESTServiceHandler]]
  * [[vortex:apidoc:rule|Rule]]
  * [[vortex:apidoc:ruleset|RuleSet]]
  * [[vortex:apidoc:runscript|RunScript]]
  * [[vortex:apidoc:scriptworkflow|Script_workflow]]
  * [[vortex:apidoc:searchcriteria|SearchCriteria]]
  * [[vortex:apidoc:searchcriteriacollection|SearchCriteriaCollection]]
  * [[vortex:apidoc:searchstring|SearchString]]
  * [[vortex:apidoc:showlist|ShowList]]
  * [[vortex:apidoc:stdformatter|StdFormatter]]
  * [[vortex:apidoc:table|Table]]
  * [[vortex:apidoc:tablefactory|TableFactory]]
  * [[vortex:apidoc:tablerecord|TableRecord]]
  * [[vortex:apidoc:tablerecordfactory|TableRecordFactory]]
  * [[vortex:apidoc:textareafield|TextAreaField]]
  * [[vortex:apidoc:textfield|TextField]]
  * [[vortex:apidoc:timer|Timer]]
  * [[vortex:apidoc:upgrader|Upgrader]]
  * [[vortex:apidoc:user|User]]
  * [[vortex:apidoc:uuid|UUID]]
  * [[vortex:apidoc:view|View]]
  * [[vortex:apidoc:viewfield|ViewField]]
  * [[vortex:apidoc:vortex|Vortex]]
  * [[vortex:apidoc:vstring|VString]]
  * [[vortex:apidoc:vxstringparser|VxStringParser]]
  * [[vortex:apidoc:vxworkflowcheckpoint|vxWorkFlowCheckpoint]]
  * [[vortex:apidoc:vxworkflowcondition|vxWorkFlowCondition]]
  * [[vortex:apidoc:vxworkflowdata|VxWorkFlowData]]
  * [[vortex:apidoc:vxworkflowscript|vxWorkFlowScript]]
  * [[vortex:apidoc:vxworkflowsendmail|vxWorkFlowSendMail]]
  * [[vortex:apidoc:vxworkflowstart|vxWorkFlowStart]]
  * [[vortex:apidoc:vxworkflowwait|vxWorkFlowWait]]
  * [[vortex:apidoc:vxworkflowworkflow|vxWorkFlowWorkFlow]]
  * [[vortex:apidoc:warning|Warning]]
  * [[vortex:apidoc:warningcollection|WarningCollection]]
  * [[vortex:apidoc:webservice|WebService]]
  * [[vortex:apidoc:workflow|WorkFlow]]
  * [[vortex:apidoc:xconfig|xConfig]]

  * [[vortex:apidoc:vxtr|vx\tr\*]]

  * [[vortex:apidoc:warnings:temporaryerror|TemporaryError]]
  * [[vortex:apidoc:warnings:persistantwarning|PersistantWarning]]
  * [[vortex:apidoc:warnings:forcederror|ForcedError]]
  * [[vortex:apidoc:warnings:forcedwarning|ForcedWarning]]
  * [[vortex:apidoc:warnings:formaterror|FormatError]]
  * [[vortex:apidoc:warnings:loginerror|LoginError]]
  * [[vortex:apidoc:warnings:permissiondeniederror|PermissionDeniedError]]
  * [[vortex:apidoc:warnings:regexperror|RegexpError]]
  * [[vortex:apidoc:warnings:saveerror|SaveError]]
  * [[vortex:apidoc:warnings:uniqueerror|UniqueError]]
  * [[vortex:apidoc:warnings:uniquewarning|UniqueWarning]]
  * [[vortex:apidoc:warnings:temporaryerror|TemporaryError]]

==== API Documentation : Interfaces ====