Package org.rapidcontext.core.proc

Class AddOnProcedure

java.lang.Object

org.rapidcontext.core.proc.AddOnProcedure

All Implemented Interfaces:

Procedure

@Deprecated(forRemoval=true)
public abstract class AddOnProcedure
extends Object
implements Procedure

Deprecated, for removal: This API element is subject to removal in a future version.

Use org.rapidcontext.core.type.Procedure API instead.

An add-on procedure base class. All procedures that are not built-in must extend this base class, since it serves as a marker for standard security, modification and serialization support. It also provides default implementations for some of the methods in the procedure interface. Subclasses to this class should meet the following requirements:

• The class must have a public constructor taking no arguments.
• The constructor should only throw ProcedureException:s.
• A unique procedure type name must be registered for the procedure class. See Library.registerProcedureType().
• All configurable aspects of the procedure must be stored as string values in the default procedure bindings. This is the only procedure data handled in the serialization process.
• The procedure should preferably not manage connections to other systems by itself when called. A better model is to use declared adapter connection pool names, which is handled transparently by the framework.

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
protected Bindings	defaults	Deprecated, for removal: This API element is subject to removal in a future version. The default procedure bindings.

Constructor Summary

Constructors

Constructor	Description
AddOnProcedure()	Deprecated, for removal: This API element is subject to removal in a future version. The default public constructor required for serialization support.

Method Summary

Modifier and Type	Method	Description
Bindings	getBindings()	Deprecated, for removal: This API element is subject to removal in a future version. Returns the bindings for this procedure.
Dict	getData()	Deprecated, for removal: This API element is subject to removal in a future version. Returns the procedure data object.
String	getDescription()	Deprecated, for removal: This API element is subject to removal in a future version. Returns the procedure description.
Date	getLastModified()	Deprecated, for removal: This API element is subject to removal in a future version. Returns the timestamp for the last modification of this procedure.
String	getName()	Deprecated, for removal: This API element is subject to removal in a future version. Returns the procedure name.
String	getType()	Deprecated, for removal: This API element is subject to removal in a future version. Returns the procedure type name.
void	setData(Dict data)	Deprecated, for removal: This API element is subject to removal in a future version. Sets the procedure data object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.rapidcontext.core.proc.Procedure

call

Field Details

defaults

protected Bindings defaults

Deprecated, for removal: This API element is subject to removal in a future version.

The default procedure bindings. These are normally modified and thereafter sealed by the subclass constructors. The procedure bindings returned will always inherit the default bindings.

Constructor Details

AddOnProcedure

public AddOnProcedure()
               throws ProcedureException

Deprecated, for removal: This API element is subject to removal in a future version.

The default public constructor required for serialization support.

Throws:

ProcedureException - if the initialization failed

Method Details

getData

public Dict getData()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the procedure data object. This object contains all the required procedure configuration data and is used when serializing the procedure.

Returns:

the procedure data object

setData

public void setData(Dict data)

Deprecated, for removal: This API element is subject to removal in a future version.

Sets the procedure data object. This method will completely reset this procedure to whatever the contents of the data object is. It is called when procedures are unserialized or changed due to user action.

Parameters:

data - the procedure data object

getName

public String getName()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the procedure name.

Specified by:

getName in interface Procedure

Returns:

the procedure name

getDescription

public String getDescription()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the procedure description.

Specified by:

getDescription in interface Procedure

Returns:

the procedure description

getType

public String getType()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the procedure type name.

Returns:

procedure type name

getLastModified

public Date getLastModified()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the timestamp for the last modification of this procedure. Note that this will be reset to the current system time whenever a change is made to the procedure, such as when initially created or similar.

Returns:

the timestamp for the last modification

getBindings

public Bindings getBindings()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the bindings for this procedure. If this procedure requires any special data, adapter connection or input argument binding, those bindings should be set (but possibly to null or blank values).

Specified by:

getBindings in interface Procedure

Returns:

the bindings for this procedure