Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkFlowTemplateFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKWorkFlowTemplateFed
All Implemented Interfaces:
DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, java.io.Serializable

public class DKWorkFlowTemplateFed
extends java.lang.Object
implements java.io.Serializable, DKConstantFed, DKMessageIdFed

This is an object oriented representation of a workflow template in the workflow engine.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKWorkFlowTemplateFed(dkWorkFlowServiceFed service, java.lang.String name)
          Constructs a DKWorkFlowTemplateFed object representing a workflow template in the workflow engine.
 
Method Summary
 DKTimestamp creationTime()
          Returns the creation time the workflow template.
 java.lang.String description()
          Returns the description of the workflow template.
 DKTimestamp modifiedTime()
          Returns the last modification time of the workflow template.
 java.lang.String name()
          Returns the name the workflow template.
 void retrieve()
          Retrieves or refreshes the information of the workflow template.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKWorkFlowTemplateFed

public DKWorkFlowTemplateFed(dkWorkFlowServiceFed service,
                             java.lang.String name)
                      throws DKException,
                             java.lang.Exception
Constructs a DKWorkFlowTemplateFed object representing a workflow template in the workflow engine.
Parameters:
service - DKWorkFlowServiceFed object.
name - name of the workflow template.
Method Detail

name

public java.lang.String name()
                      throws DKException,
                             java.lang.Exception
Returns the name the workflow template.
Returns:
name of the workflow template.

description

public java.lang.String description()
                             throws DKException,
                                    java.lang.Exception
Returns the description of the workflow template.
Returns:
description of the workflow template.
Throws:
DKUsageError - if the DKWorkFlowTemplateFed object is not retrieved.

creationTime

public DKTimestamp creationTime()
                         throws DKException,
                                java.lang.Exception
Returns the creation time the workflow template.
Returns:
DKTimestamp object for creation time.
Throws:
DKUsageError - if the DKWorkFlowTemplateFed object is not retrieved.

modifiedTime

public DKTimestamp modifiedTime()
                         throws DKException,
                                java.lang.Exception
Returns the last modification time of the workflow template.
Returns:
DKTimestamp object for modification time.
Throws:
DKUsageError - if the DKWorkFlowTemplateFed object is not retrieved.

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Retrieves or refreshes the information of the workflow template.
Throws:
DKUsageError - if the DKWorkFlowTemplateFed object cannot be retrieved.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.