IBM WebSphere Application ServerTM
Release 8

com.ibm.task.api
Class WorkBasketDefinitionFactory

java.lang.Object
  extended by com.ibm.task.api.WorkBasketDefinitionFactory

public class WorkBasketDefinitionFactory
extends java.lang.Object

Factory to create a work basket definition object.

Since:
6.2.0.3

Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 WorkBasketDefinition createWorkBasketDefinition(java.lang.String name)
          Creates a work basket definition object with the specified work basket name.
 WorkBasketDefinition createWorkBasketDefinition(java.lang.String name, WorkBasketDefinition fromWorkBasketDefinition)
          Creates a work basket definition object based on the specified work basket definition.
static WorkBasketDefinitionFactory newInstance()
          Returns the single instance of a WorkBasketDefinitionFactory.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

newInstance

public static WorkBasketDefinitionFactory newInstance()
Returns the single instance of a WorkBasketDefinitionFactory.

Returns:
WorkBasketDefinitionFactory The WorkBasketDefinitionFactory object.

createWorkBasketDefinition

public WorkBasketDefinition createWorkBasketDefinition(java.lang.String name)
                                                throws ParameterNullException
Creates a work basket definition object with the specified work basket name. A work basket definition object is used to create a persistently stored work basket. The work basket definition object itself is not stored on the database.

Note that the type is set to TYPE_GROUP and the substitution policy to SUBSTITUTION_POLICY_NO_SUBSTITUTION.

Parameters:
name - The name of the work basket. Note that work basket names must conform to the XML NCName specification.
Returns:
The work basket definition object.
Throws:
ParameterNullException

createWorkBasketDefinition

public WorkBasketDefinition createWorkBasketDefinition(java.lang.String name,
                                                       WorkBasketDefinition fromWorkBasketDefinition)
                                                throws ParameterNullException
Creates a work basket definition object based on the specified work basket definition. All properties except the work basket name are copied from the specified work basket definition into the newly created work basket definition.

Parameters:
name - The name of the work basket. Note that work basket names must conform to the XML NCName specification.
fromWorkBasketDefinition - The work basket definition to be copied.
Returns:
The newly created work basket definition object.
Throws:
ParameterNullException

IBM WebSphere Application ServerTM
Release 8