Oracle© Collaboration Suite Workspaces Web Services API Reference
10g Release 1 (10.1.2.2)

Part No. B28209-01


oracle.workspaces.ws.beans
Class WorkflowParameter

java.lang.Object
  extended byoracle.workspaces.ws.beans.WorkflowParameter


public class WorkflowParameter
extends java.lang.Object

This class represents workflow parameter attributes associated with a workflow operation.


Constructor Summary
WorkflowParameter()
          Default constructor

 

Method Summary
 java.lang.String get_default()
          Gets the default value for this WorkflowParameter.
 java.lang.String getDescription()
          Gets the description of workflow parameter.
 java.lang.String getDisplayName()
          Gets the display name of workflow parameter.
 java.lang.String getName()
          Gets the name.
 java.lang.String getValue()
          Gets the value.
 boolean is_final()
          Gets whether the WorkflowParameter is final (immutable), which means its default value cannot be set for a WorkflowConfiguration.
 boolean isHidden()
          Gets whether the WorkflowParameter is hidden or exposed to user.
 boolean isPrompted()
          Gets whether the user should be prompted to fill WorkflowParameter value.
 boolean isRequired()
          Gets whether the user must fill the workflow parameter value.
 void setName(java.lang.String name)
          Sets the name value for this WorkflowParameter.
 void setValue(java.lang.String value)
          Sets the value value for this WorkflowParameter.

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

WorkflowParameter

public WorkflowParameter()
Default constructor

Method Detail

get_default

public java.lang.String get_default()
Gets the default value for this WorkflowParameter.
Returns:
_default

getDescription

public java.lang.String getDescription()
Gets the description of workflow parameter.
Returns:
description

getDisplayName

public java.lang.String getDisplayName()
Gets the display name of workflow parameter.
Returns:
displayName

is_final

public boolean is_final()
Gets whether the WorkflowParameter is final (immutable), which means its default value cannot be set for a WorkflowConfiguration.
Returns:
isFinal

isHidden

public boolean isHidden()
Gets whether the WorkflowParameter is hidden or exposed to user.
Returns:
isHidden

isPrompted

public boolean isPrompted()
Gets whether the user should be prompted to fill WorkflowParameter value.
Returns:
isPrompted

isRequired

public boolean isRequired()
Gets whether the user must fill the workflow parameter value. If default value exists and user does not assign value to workflow parameter then default value is taken for workflow parameter value.
Returns:
isRequired

getName

public java.lang.String getName()
Gets the name.
Returns:
name

setName

public void setName(java.lang.String name)
Sets the name value for this WorkflowParameter.
Parameters:
name -

getValue

public java.lang.String getValue()
Gets the value.
Returns:
value

setValue

public void setValue(java.lang.String value)
Sets the value value for this WorkflowParameter.
Parameters:
value -

Copyright © 2001, 2006, Oracle. All rights reserved.