• Api Documentation
Show / Hide Table of Contents
  • Softadmin.Api
    • AdminMessageException
    • CustomComponent
    • ICookies
    • ICredentialsStore
    • IEnvironment
    • IForwardState
    • IHttpHeaders
    • IParameters
    • ISessionVariables
    • ISystemSettings
    • Plugin
  • Softadmin.Api.Database
    • IDbRequest
    • IDbRequestFactory
  • Softadmin.Api.Diagnostics
    • ILogger
  • Softadmin.Api.Login
    • IUserState
    • LoginPlugin
    • PostLoginPlugin
    • PreLoginPlugin
    • UserAuthenticationPlugin
  • Softadmin.Api.Logout
    • LogoutPlugin
  • Softadmin.Api.Page
    • ICustomPage
    • PagePlugin
  • Softadmin.Api.Ui
    • IDebugWindow
    • IProgressWindow

Interface IDbRequestFactory

Creates database requests.

Namespace: Softadmin.Api.Database
Assembly: Softadmin.Api.dll
Syntax
public interface IDbRequestFactory
Remarks

All requests created by the request factory will call the same procedure. For a plugin the procedure will be whatever procedure was registered for the plugin through the administration menu items. For a custom component the procedure will be the one that the menu item is bound against.

Methods

CreateRequest(String)

Creates a database request.

Declaration
IDbRequest CreateRequest(string requestName)
Parameters
Type Name Description
System.String requestName

The request's name, which is purely informational. See RequestName.

Returns
Type Description
IDbRequest

A new database request.

Exceptions
Type Condition
System.NotSupportedException

If the request factory belongs to a menu item that is bound against something other than SQL.

Back to top Generated by DocFX