com.heirloomcomputing.ecs.exec

Interface ICallable

public interface ICallable

This interface must be implemented by any Java program
that wishes to be called by a COBOL CALL statement.

Example Java:

 public class myprogram implements ICallableProgram {
  public void call() { System.out.println("Called with no params."); }
  public void call(parameterList param) { System.out.println("Called with params."); }
  public void cancel() { System.out.println("Cancelled."); }
  public String redirectCall() { return null; }
   ...
 }
 

Example COBOL:

 CALL "myprogram".

 CALL "myprogram" USING VALUE-1 VALUE-2 ... VALUE-N.

 CANCEL "myprogram".

 

Note that all COBOL program compiled with PERCobol already implement the ICallableProgram interface.

See Also:

parameterList

Method Summary

Modifier and Type	Method and Description
java.lang.Object	call(com.heirloomcomputing.ecs.exec.Context parentContext) This is the entry point for the class when CALL'd with no parameters.
java.lang.Object	call(com.heirloomcomputing.ecs.exec.Context parentContext, com.heirloomcomputing.ecs.exec.parameterList param) This is the entry point for the class when CALL'd with parameters.
void	cancel() This method should reinitialize the class to its initial state. This is the method that is called whenever COBOL CANCEL's a program. Never throw an exception from this method.
java.lang.String	redirectCall() redirectCall reroutes calls to this class to instead go to another class. Return null if you desire normal behavior for the class.

Method Detail

call

java.lang.Object call(com.heirloomcomputing.ecs.exec.Context parentContext)
               throws java.lang.Throwable

This is the entry point for the class when CALL'd with no parameters. Do all normal processing for the CALL within this method or the next. If you require parameters, just return from this function or throw a COBOL exception by calling com.heirloomcomputing.ecs.exec.CobolException.runtimeError (String,Throwable)

Throws:

java.lang.Throwable

call

java.lang.Object call(com.heirloomcomputing.ecs.exec.Context parentContext,
                      com.heirloomcomputing.ecs.exec.parameterList param)
               throws java.lang.Throwable

This is the entry point for the class when CALL'd with parameters. Do all normal processing for the CALL within this method or the previous method. If you do not require parameters, just return from this function or throw a COBOL exception by calling com.heirloomcomputing.ecs.exec.CobolException .runtimeError(String,Throwable)

Throws:

java.lang.Throwable

See Also:

parameterList

cancel

void cancel()

This method should reinitialize the class to its initial state.
This is the method that is called whenever COBOL CANCEL's a program.
Never throw an exception from this method.

redirectCall

java.lang.String redirectCall()

redirectCall reroutes calls to this class to instead go to another class.
Return null if you desire normal behavior for the class.

It is strongly recommended to always return null.