com.ibm.workflow.api
Interface ProgramData


public interface ProgramData


Method Summary
 byte[] asStream()
          Returns the program data as a binary stream.
 java.lang.String description()
          Returns the description of the implementing program.
 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.
 ReadOnlyContainer inContainer()
          Returns the input container of the program.
 boolean isEmpty()
          Indicates whether no program data information is available yet.
 boolean isUnattended()
          States whether the program can run unattended.
 ReadWriteContainer outContainer()
          Returns the output container of the program.
 boolean programTrusted()
          States whether the program can be trusted.
 

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.

inContainer

public ReadOnlyContainer inContainer()
                              throws FmcException
Returns the input 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 data 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.

outContainer

public ReadWriteContainer outContainer()
                                throws FmcException
Returns the output container of 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.

asStream

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

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


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