org.rapidcontext.app.proc

Class TypeListProcedure

java.lang.Object

org.rapidcontext.app.proc.TypeListProcedure

All Implemented Interfaces:

Procedure

public class TypeListProcedure
extends java.lang.Object
implements Procedure

The built-in type list procedure.

Version:

1.0

Author:

Per Cederberg

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME The procedure name constant.
static Path	PATH_APP The app object storage path.

Constructor Summary

Constructors

Constructor and Description
TypeListProcedure() Creates a new app list procedure.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	call(CallContext cx, Bindings bindings) Executes a call of this procedure in the specified context and with the specified call bindings.
Bindings	getBindings() Returns the bindings for this procedure.
java.lang.String	getDescription() Returns the procedure description.
java.lang.String	getName() Returns the procedure name.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_APP

public static final Path PATH_APP

The app object storage path.

NAME

public static final java.lang.String NAME

The procedure name constant.

See Also:

Constant Field Values

Constructor Detail

TypeListProcedure

public TypeListProcedure()

Creates a new app list procedure.

Method Detail

getName

public java.lang.String getName()

Returns the procedure name.

Specified by:

getName in interface Procedure

Returns:

the procedure name

getDescription

public java.lang.String getDescription()

Returns the procedure description.

Specified by:

getDescription in interface Procedure

Returns:

the procedure description

getBindings

public Bindings getBindings()

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

call

public java.lang.Object call(CallContext cx,
                             Bindings bindings)
                      throws ProcedureException

Executes a call of this procedure in the specified context and with the specified call bindings. The semantics of what the procedure actually does, is up to each implementation. Note that the call bindings are normally inherited from the procedure bindings with arguments bound to their call values.

Specified by:

call in interface Procedure

Parameters:

cx - the procedure call context

bindings - the call bindings to use

Returns:

the result of the call, or null if the call produced no result

Throws:

ProcedureException - if the call execution caused an error