com.microfocus.cobol.connector.transport.nativelib
Class BINPCobolBean

java.lang.Object
  extended bycom.microfocus.cobol.CobolBean
      extended bycom.microfocus.cobol.connector.transport.nativelib.BINPCobolBean
public class BINPCobolBean
extends com.microfocus.cobol.CobolBean

Class contains methods for constructing a BINPCobolBean

Copyright: Copyright (c) 2002-2003
Company: Micro Focus International Ltd

Since:
Net Express 4.0, Server Express 4.0
Version:
$Revision: 2.3 $, $Date: 2003/11/13 09:50:38 $

Constructor Summary
BINPCobolBean()
          Constructor for a BINPCobolBean

Usage:
 
Method Summary
protected  void attachToThread()
          Method declaration
 void cancel()
          Performs a cancel on any COBOL programs used with in this bean.
 byte[] client_cobcall(byte[] message, byte[] idt)
          Calls a COBOL program with a ParameterList and returns return-code as a int.
 void dispose()
          Dispose this instance of a MiniCobolBean.
protected static void dumpBytes(byte[] bytes)
          Method declaration
 void setBeanIsInitial(boolean beanInitial)
          Sets the "Is initial" state of any programs called from a instance of a COBOL Bean.

When set to true, it ensures that the COBOL program being "cob[r]call"'ed is always in it's initial state.
protected  void throwExceptionIfStatusCodeFailed()
          Method declaration
 
Methods inherited from class com.microfocus.cobol.CobolBean
allocContext, attachContext, cobcall, cobcall, cobload, cobrcall, cobrcall, createContext, destroyContext, detatchContext, freeContext, getContext, getKeySize, setContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BINPCobolBean

public BINPCobolBean()
              throws com.microfocus.cobol.CobolException,
                     Exception
Constructor for a BINPCobolBean

Usage: 
 public myMiniCobolBean extends com.microfocus.cobol.MiniCobolBean
 {
 public myMiniCobolBean()
 {
 super();  // ensure parent constructor is invoked.
 }

 public void setName(String name) throws CobolException, Exception
 {
 super.cobcall("setName", new ParameterList().add(name));
 }

 }

Throws:
com.microfocus.cobol.CobolException
Exception
Method Detail

attachToThread

protected void attachToThread()
                       throws Exception
Method declaration

Throws:
Exception

setBeanIsInitial

public void setBeanIsInitial(boolean beanInitial)
Sets the "Is initial" state of any programs called from a instance of a COBOL Bean.

When set to true, it ensures that the COBOL program being "cob[r]call"'ed is always in it's initial state.

Parameters:
beanInitial - required "is initial" state

throwExceptionIfStatusCodeFailed

protected void throwExceptionIfStatusCodeFailed()
                                         throws com.microfocus.cobol.CobolException
Method declaration

Throws:
com.microfocus.cobol.CobolException

client_cobcall

public byte[] client_cobcall(byte[] message,
                             byte[] idt)
                      throws com.microfocus.cobol.CobolException,
                             Exception
Calls a COBOL program with a ParameterList and returns return-code as a int.

Returns:
a int RETURN-CODE
Throws:
com.microfocus.cobol.CobolException - - COBOL Exception
Exception - - NON COBOL Exception

cancel

public void cancel()
            throws com.microfocus.cobol.CobolException,
                   Exception
Performs a cancel on any COBOL programs used with in this bean.

Throws:
com.microfocus.cobol.CobolException - - COBOL Exception
Exception - - NON COBOL Exception

dispose

public void dispose()
             throws com.microfocus.cobol.CobolException,
                    Exception
Dispose this instance of a MiniCobolBean.

Throws:
com.microfocus.cobol.CobolException - - COBOL Exception
Exception - - NON COBOL Exception

dumpBytes

protected static void dumpBytes(byte[] bytes)
Method declaration

Parameters:
bytes -

Copyright © 2000 Micro Focus International Limited. All rights reserved.
This document and the proprietary marks and names used herein are protected by international law.