LocalCommand
Overview
The LocalCommand class provides the ability to dynamically invoke a Command from the server's Schema.
This class works similarly to the RemoteCommand class, but is designed to be used with Local Data Adapters.
Location
- Reference: RemObjects.DataAbstract.Server.dll
- Namespace: RemObjects.DataAbstract
- Ancestry: BaseComponent | BaseCommand | LocalCommand
constructor
Creates a new instance of the LocalCommand class.
constructor
LocalCommand()
Sub New()
constructor (IContainer)
constructor(container: IContainer)
LocalCommand(IContainer container)
Sub New(container As IContainer)
Parameters:
- container:
constructor (IDataAbstractLocalServiceAccess)
Creates a new instance of the LocalCommand class and initializes the ServiceInstance property.
constructor(serviceInstance: IDataAbstractLocalServiceAccess)
LocalCommand(IDataAbstractLocalServiceAccess serviceInstance)
Sub New(serviceInstance As IDataAbstractLocalServiceAccess)
Parameters:
- serviceInstance: Data Service instance that will be used to execute the command
constructor (IDataAbstractLocalServiceAccess, Guid)
constructor(serviceInstance: IDataAbstractLocalServiceAccess; sessionId: Guid)
LocalCommand(IDataAbstractLocalServiceAccess serviceInstance, Guid sessionId)
Sub New(serviceInstance As IDataAbstractLocalServiceAccess, sessionId As Guid)
Parameters:
- serviceInstance:
- sessionId:
constructor (String)
Creates a new instance of the LocalCommand class and initializes the ServiceName property.
constructor(serviceName: String)
LocalCommand(String serviceName)
Sub New(serviceName As String)
Parameters:
- serviceName: Name of the Data Service that will be used to execute the command
constructor (String, Guid)
constructor(serviceName: String; sessionId: Guid)
LocalCommand(String serviceName, Guid sessionId)
Sub New(serviceName As String, sessionId As Guid)
Parameters:
- serviceName:
- sessionId:
CATEGORY_COMMUNICATION protected (declared in BaseCommand)
const CATEGORY_COMMUNICATION: String = "Communication";
const String CATEGORY_COMMUNICATION = "Communication"
Dim CATEGORY_COMMUNICATION As String = "Communication"
CATEGORY_DYNAMIC_METHOD_BINDING protected (declared in BaseCommand)
const CATEGORY_DYNAMIC_METHOD_BINDING: String = "Dynamic Method Binding";
const String CATEGORY_DYNAMIC_METHOD_BINDING = "Dynamic Method Binding"
Dim CATEGORY_DYNAMIC_METHOD_BINDING As String = "Dynamic Method Binding"
CATEGORY_OPTIONS protected (declared in BaseCommand)
const CATEGORY_OPTIONS: String = "Options";
const String CATEGORY_OPTIONS = "Options"
Dim CATEGORY_OPTIONS As String = "Options"
CATEGORY_STREAMING protected (declared in BaseCommand)
const CATEGORY_STREAMING: String = "Streaming";
const String CATEGORY_STREAMING = "Streaming"
Dim CATEGORY_STREAMING As String = "Streaming"
Dispose protected
method Dispose(disposing: Boolean)
void Dispose(Boolean disposing)
Sub Dispose(disposing As Boolean)
Parameters:
- disposing:
Execute (String): Int32 (declared in BaseCommand)
method Execute(commandName: String): Int32
Int32 Execute(String commandName)
Function Execute(commandName As String) As Int32
Parameters:
- commandName:
Execute (String, array of String, array of Object): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object): Int32
Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues)
Function Execute(commandName As String, parameterNames As String(), parameterValues As Object()) As Int32
Parameters:
- commandName:
- parameterNames:
- parameterValues:
Execute (String, array of String, array of Object, String, Object): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object; out outputNames: String; out outputValues: Object): Int32
Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues, out String outputNames, out Object outputValues)
Function Execute(commandName As String, parameterNames As String(), parameterValues As Object(), <OutAttribute> ByRef outputNames As String, <OutAttribute> ByRef outputValues As Object) As Int32
Parameters:
- commandName:
- parameterNames:
- parameterValues:
- outputNames:
- outputValues:
Execute (String, array of DataParameter): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameters: array of DataParameter): Int32
Int32 Execute(String commandName, DataParameter[] parameters)
Function Execute(commandName As String, parameters As DataParameter()) As Int32
Parameters:
- commandName:
- parameters:
Execute (String, array of DataParameter, DataParameter): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameters: array of DataParameter; out output: DataParameter): Int32
Int32 Execute(String commandName, DataParameter[] parameters, out DataParameter output)
Function Execute(commandName As String, parameters As DataParameter(), <OutAttribute> ByRef output As DataParameter) As Int32
Parameters:
- commandName:
- parameters:
- output:
Execute (String, array of Object): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameterValues: array of Object): Int32
Int32 Execute(String commandName, Object[] parameterValues)
Function Execute(commandName As String, parameterValues As Object()) As Int32
Parameters:
- commandName:
- parameterValues:
ServiceInstance
Gets or sets the Data Service instance that will be used to execute the command.
If the ServiceName property is set then service instance will be automarically acquired on the first command execution.
property ServiceInstance: IDataAbstractLocalServiceAccess read write;
IDataAbstractLocalServiceAccess ServiceInstance { get; set; }
Property ServiceInstance() As IDataAbstractLocalServiceAccess
ServiceName
Gets or sets the name of the Data Service that will be used to execute the command.
property ServiceName: String read write;
String ServiceName { get; set; }
Property ServiceName() As String
SessionID
Gets or sets the ID of the session that will be used by the service during command execution.
property SessionID: Guid read write;
Guid SessionID { get; set; }
Property SessionID() As Guid
CATEGORY_COMMUNICATION protected (declared in BaseCommand)
const CATEGORY_COMMUNICATION: String = "Communication";
const String CATEGORY_COMMUNICATION = "Communication"
Dim CATEGORY_COMMUNICATION As String = "Communication"
CATEGORY_DYNAMIC_METHOD_BINDING protected (declared in BaseCommand)
const CATEGORY_DYNAMIC_METHOD_BINDING: String = "Dynamic Method Binding";
const String CATEGORY_DYNAMIC_METHOD_BINDING = "Dynamic Method Binding"
Dim CATEGORY_DYNAMIC_METHOD_BINDING As String = "Dynamic Method Binding"
CATEGORY_OPTIONS protected (declared in BaseCommand)
const CATEGORY_OPTIONS: String = "Options";
const String CATEGORY_OPTIONS = "Options"
Dim CATEGORY_OPTIONS As String = "Options"
CATEGORY_STREAMING protected (declared in BaseCommand)
const CATEGORY_STREAMING: String = "Streaming";
const String CATEGORY_STREAMING = "Streaming"
Dim CATEGORY_STREAMING As String = "Streaming"
ServiceInstance
Gets or sets the Data Service instance that will be used to execute the command.
If the ServiceName property is set then service instance will be automarically acquired on the first command execution.
property ServiceInstance: IDataAbstractLocalServiceAccess read write;
IDataAbstractLocalServiceAccess ServiceInstance { get; set; }
Property ServiceInstance() As IDataAbstractLocalServiceAccess
ServiceName
Gets or sets the name of the Data Service that will be used to execute the command.
property ServiceName: String read write;
String ServiceName { get; set; }
Property ServiceName() As String
SessionID
Gets or sets the ID of the session that will be used by the service during command execution.
property SessionID: Guid read write;
Guid SessionID { get; set; }
Property SessionID() As Guid
constructor
Creates a new instance of the LocalCommand class.
constructor
LocalCommand()
Sub New()
constructor (IContainer)
constructor(container: IContainer)
LocalCommand(IContainer container)
Sub New(container As IContainer)
Parameters:
- container:
constructor (IDataAbstractLocalServiceAccess)
Creates a new instance of the LocalCommand class and initializes the ServiceInstance property.
constructor(serviceInstance: IDataAbstractLocalServiceAccess)
LocalCommand(IDataAbstractLocalServiceAccess serviceInstance)
Sub New(serviceInstance As IDataAbstractLocalServiceAccess)
Parameters:
- serviceInstance: Data Service instance that will be used to execute the command
constructor (IDataAbstractLocalServiceAccess, Guid)
constructor(serviceInstance: IDataAbstractLocalServiceAccess; sessionId: Guid)
LocalCommand(IDataAbstractLocalServiceAccess serviceInstance, Guid sessionId)
Sub New(serviceInstance As IDataAbstractLocalServiceAccess, sessionId As Guid)
Parameters:
- serviceInstance:
- sessionId:
constructor (String)
Creates a new instance of the LocalCommand class and initializes the ServiceName property.
constructor(serviceName: String)
LocalCommand(String serviceName)
Sub New(serviceName As String)
Parameters:
- serviceName: Name of the Data Service that will be used to execute the command
constructor (String, Guid)
constructor(serviceName: String; sessionId: Guid)
LocalCommand(String serviceName, Guid sessionId)
Sub New(serviceName As String, sessionId As Guid)
Parameters:
- serviceName:
- sessionId:
Dispose protected
method Dispose(disposing: Boolean)
void Dispose(Boolean disposing)
Sub Dispose(disposing As Boolean)
Parameters:
- disposing:
Execute (String): Int32 (declared in BaseCommand)
method Execute(commandName: String): Int32
Int32 Execute(String commandName)
Function Execute(commandName As String) As Int32
Parameters:
- commandName:
Execute (String, array of String, array of Object): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object): Int32
Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues)
Function Execute(commandName As String, parameterNames As String(), parameterValues As Object()) As Int32
Parameters:
- commandName:
- parameterNames:
- parameterValues:
Execute (String, array of String, array of Object, String, Object): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object; out outputNames: String; out outputValues: Object): Int32
Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues, out String outputNames, out Object outputValues)
Function Execute(commandName As String, parameterNames As String(), parameterValues As Object(), <OutAttribute> ByRef outputNames As String, <OutAttribute> ByRef outputValues As Object) As Int32
Parameters:
- commandName:
- parameterNames:
- parameterValues:
- outputNames:
- outputValues:
Execute (String, array of DataParameter): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameters: array of DataParameter): Int32
Int32 Execute(String commandName, DataParameter[] parameters)
Function Execute(commandName As String, parameters As DataParameter()) As Int32
Parameters:
- commandName:
- parameters:
Execute (String, array of DataParameter, DataParameter): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameters: array of DataParameter; out output: DataParameter): Int32
Int32 Execute(String commandName, DataParameter[] parameters, out DataParameter output)
Function Execute(commandName As String, parameters As DataParameter(), <OutAttribute> ByRef output As DataParameter) As Int32
Parameters:
- commandName:
- parameters:
- output:
Execute (String, array of Object): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameterValues: array of Object): Int32
Int32 Execute(String commandName, Object[] parameterValues)
Function Execute(commandName As String, parameterValues As Object()) As Int32
Parameters:
- commandName:
- parameterValues: