Namespace: Consultingwerk.SmartFramework
Interface 
IFunctionCallParameter Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.IJsonSerializable
Implemented by: Consultingwerk.SmartFramework.InvokeServiceMethodCallParameter, Consultingwerk.SmartFramework.InvokeStaticMethodCallParameter, Consultingwerk.SmartFramework.RunProcedureCallParameter, Consultingwerk.Web2.SmartFramework.Menu.LaunchWebViewCallParameter, Consultingwerk.Windows.Framework.LaunchAnnotationFormCallParameter, Consultingwerk.Windows.Framework.LaunchFormCallParameter, Consultingwerk.Windows.Framework.WebUriCallParameter

File:IFunctionCallParameter
Purpose:Interface for (Json serialized) functions that can be
launched from a menu structure
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Oct 12 00:55:59 CEST 2012
Notes:As this Interface is required for the client side of the
SmartFramework, there is no requirement for the
optional XML Serialization
Purpose: Invokes/Starts the function associated with the IFunctionCallParameter
object
Notes:

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ Deserialize (longchar) Initializes the object instance based on the passed in LONGCHAR (potentially XML) representation of the object instance
Inherited from Consultingwerk.ISerializable
+ DeserializeFromJsonObject (JsonObject) Initializes the object instance based on the passed in JsonObject representation of the object instance
Inherited from Consultingwerk.IJsonSerializable
+ CHARACTER GetSerializableProperties () Returns the meta data of the serializable properties
Inherited from Consultingwerk.IJsonSerializable
+ Progress.Lang.Object Invoke (logical, Object) Invokes/Starts the function associated with the IFunctionCallParameter object
+ LOGICAL IsActive () Returns true when the function is currently active (runninng)
+ LOGICAL ReActivate () ReActivates the function
+ LONGCHAR Serialize () Returns an LONGCHAR (potentially XML) representation of the object instance
Inherited from Consultingwerk.ISerializable
+ Progress.Json.ObjectModel.JsonObject ToJsonObject () Returns a JsonObject representation of the state of the class instance
Inherited from Consultingwerk.IJsonSerializable


Method Detail
Top

PUBLIC Deserialize (longchar)
Inherited from Consultingwerk.ISerializable
Purpose: Initializes the object instance based on the passed in LONGCHAR
(potentially XML) representation of the object instance
Notes:

Parameters:
pcSerializedReprasentation LONGCHAR
The stored LONGCHAR representation of the objects data
Top

PUBLIC DeserializeFromJsonObject (JsonObject)
Inherited from Consultingwerk.IJsonSerializable
Purpose: Initializes the object instance based on the passed in JsonObject
representation of the object instance
Notes:

Parameters:
poJsonObject JsonObject
The stored JsonObject representation of the objects data
Top

PUBLIC CHARACTER GetSerializableProperties ()
Inherited from Consultingwerk.IJsonSerializable
Purpose: Returns the meta data of the serializable properties
Notes:

Returns CHARACTER
The serializable properties meta data as a comma delimited list
Top

PUBLIC Progress.Lang.Object Invoke (logical, Object)
Purpose: Invokes/Starts the function associated with the IFunctionCallParameter
object
Notes:

Parameters:
plForceNewInstance LOGICAL
Logical value indicating if a new Instance should be started (True/False/?)
poContext Progress.Lang.Object
An optional reference to a context (could be the Control that launches the function)
Returns Progress.Lang.Object
Returns an (optional) reference to the invoked object
Top

PUBLIC LOGICAL IsActive ()
Purpose: Returns true when the function is currently active (runninng)
Notes:

Returns LOGICAL
True when the function is currently active (runninng)
Top

PUBLIC LOGICAL ReActivate ()
Purpose: ReActivates the function
Notes:

Returns LOGICAL
True when the function was successfully reactivated
Top

PUBLIC LONGCHAR Serialize ()
Inherited from Consultingwerk.ISerializable
Purpose: Returns an LONGCHAR (potentially XML) representation of the
object instance
Notes:

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC Progress.Json.ObjectModel.JsonObject ToJsonObject ()
Inherited from Consultingwerk.IJsonSerializable
Purpose: Returns a JsonObject representation of the state of the class instance
Notes: Returns the classname together with the Json serialization of the
object

Returns Progress.Json.ObjectModel.JsonObject
The Progress.Json.ObjectModel.JsonObject representation of the ISerializable objects data


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:06:50