com.ibm.workflow.api
Interface ProgramTemplate


public interface ProgramTemplate


Method Summary
 byte[] asStream()
          Returns the program template as a binary stream.
 java.lang.String description()
          Returns the description of the implementing program.
 ReadWriteContainer execute()
          The native implementation of the Java API cannot communicate with the Program Execution Agent.
 ReadWriteContainer execute2(ReadWriteContainer initialInContainer, ReadWriteContainer initialOutContainer, int priority)
           
 ExeMode executionMode()
          States whether the program can participate in global transactions or not.
 ExeUser executionUser()
          Returns the user on whose behalf the program is to be executed.
 java.lang.String icon()
          Returns the icon associated with the implementing program.
 ImplementationData[] implementations()
          Returns the implementation definitions of the program.
 boolean inContainerAccess()
          States whether the input container is accessed by the program.
 ReadWriteContainer initialInContainer()
          Returns the initially defined input container of the program.
 ReadWriteContainer initialOutContainer()
          Returns the initially defined output container of the program.
 boolean isEmpty()
          Indicates whether no program template information is available yet.
 boolean isUnattended()
          States whether the program can run unattended.
 boolean outContainerAccess()
          States whether the output container is accessed by the program.
 boolean programTrusted()
          States whether the program can be trusted.
 boolean structuresFromActivity()
          States whether the program can handle any container passed to it.
 java.util.Calendar validFromTime()
          Returns the time when the process template and thus the program template becomes valid.
 

Method Detail

description

public java.lang.String description()
                             throws FmcException
Returns the description of the implementing program.

Throws:
FmcException - thrown if an API error or a communication error occurred.

executionMode

public ExeMode executionMode()
                      throws FmcException
States whether the program can participate in global transactions or not.

Throws:
FmcException - thrown if an API error or a communication error occurred.

executionUser

public ExeUser executionUser()
                      throws FmcException
Returns the user on whose behalf the program is to be executed.

Throws:
FmcException - thrown if an API error or a communication error occurred.

icon

public java.lang.String icon()
                      throws FmcException
Returns the icon associated with the implementing program.

Throws:
FmcException - thrown if an API error or a communication error occurred.

implementations

public ImplementationData[] implementations()
                                     throws FmcException
Returns the implementation definitions of the program.

Throws:
FmcException - thrown if an API error or a communication error occurred.

inContainerAccess

public boolean inContainerAccess()
                          throws FmcException
States whether the input container is accessed by the program.

Throws:
FmcException - thrown if an API error or a communication error occurred.

initialInContainer

public ReadWriteContainer initialInContainer()
                                      throws FmcException
Returns the initially defined input container of the program.

Throws:
FmcException - thrown if an API error or a communication error occurred.

initialOutContainer

public ReadWriteContainer initialOutContainer()
                                       throws FmcException
Returns the initially defined output container of the program.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isEmpty

public boolean isEmpty()
                throws FmcException
Indicates whether no program template information is available yet.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isUnattended

public boolean isUnattended()
                     throws FmcException
States whether the program can run unattended.

Throws:
FmcException - thrown if an API error or a communication error occurred.

outContainerAccess

public boolean outContainerAccess()
                           throws FmcException
States whether the output container is accessed by the program.

Throws:
FmcException - thrown if an API error or a communication error occurred.

programTrusted

public boolean programTrusted()
                       throws FmcException
States whether the program can be trusted. Only a trusted program can receive its program ID.

Throws:
FmcException - thrown if an API error or a communication error occurred.

structuresFromActivity

public boolean structuresFromActivity()
                               throws FmcException
States whether the program can handle any container passed to it.

Throws:
FmcException - thrown if an API error or a communication error occurred.

validFromTime

public java.util.Calendar validFromTime()
                                 throws FmcException
Returns the time when the process template and thus the program template becomes valid.

Throws:
FmcException - thrown if an API error or a communication error occurred.

asStream

public byte[] asStream()
                throws FmcException
Returns the program template as a binary stream.

Throws:
FmcException - thrown if an API error or a communication error occurred.

execute

public ReadWriteContainer execute()
                           throws FmcException

The native implementation of the Java API cannot communicate with the Program Execution Agent. The execute method is kept to provide compatibility to the classic Java API and has not function. This API call throws an FMC_NOT_SUPPORTED exception.

Throws:
FmcException - FMC_NOT_SUPPORTED exception is thrown

execute2

public ReadWriteContainer execute2(ReadWriteContainer initialInContainer,
                                   ReadWriteContainer initialOutContainer,
                                   int priority)
                            throws FmcException


© Copyright IBM Corporation 1999, 2007. All Rights Reserved.