wt.clients.lifecycle
Class SubmitLifeCycleTask

java.lang.Object
  wt.clients.lifecycle.SubmitLifeCycleTask

public class SubmitLifeCycleTask

extends Object

Class SubmitLifeCycleTask is a generic utility for submitting LifeCycleManaged objects to a life cycle. E.g.

       SubmitLifeCycleTask submit_task = new SubmitLifeCycleTask();
       submit_task.setLifeCycleObject( my_lifecycle_managed_obj );
       try {
          my_lifecycle_managed_obj = submit_task.submitLifeCycleObject();
       } catch (LifeCycleException lce) {
          ...
       } catch (WTException wte) {
          ...
       }
    

Supported API: false

Extendable: false

See Also:

LifeCycleManaged

Field Summary

private LifeCycleManaged	lcObject
private static String	MESSAGES_RESOURCE
private static String	versionID

Constructor Summary

SubmitLifeCycleTask()

Method Summary

private void	dispatchRefresh(Object obj, int action)
private String	getIdentity(LifeCycleManaged object)
LifeCycleManaged	getLifeCycleObject() Method getLifeCycleObject returns the LifeCycleManaged object submitted by this task.
void	setLifeCycleObject(LifeCycleManaged lc_object) Method setLifeCycleObject sets the LifeCycleManaged object to be submitted by this task.
LifeCycleManaged	submitLifeCycleObject() Method submitLifeCycleObject submits the LifeCycleManaged object of this task to the life cycle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

versionID

private static final String versionID

See Also:

Constant Field Values

MESSAGES_RESOURCE

private static String MESSAGES_RESOURCE

lcObject

private LifeCycleManaged lcObject

Constructor Detail

SubmitLifeCycleTask

public SubmitLifeCycleTask()

Method Detail

setLifeCycleObject

public void setLifeCycleObject(LifeCycleManaged lc_object)
                        throws LifeCycleException

Method setLifeCycleObject sets the LifeCycleManaged object to be submitted by this task. If the given object has already been submitted, an exception is thrown.

Parameters:

lc_object - the LifeCycleManaged object to be submitted by this task

Throws:

LifeCycleException - if the given object has already been submitted

Supported API: false

Extendable: false

See Also:

getLifeCycleObject(), LifeCycleManaged

getLifeCycleObject

public LifeCycleManaged getLifeCycleObject()

Method getLifeCycleObject returns the LifeCycleManaged object submitted by this task.

Supported API: false

Extendable: false

Returns:

the LifeCycleManaged object submitted by this task

See Also:

setLifeCycleObject(wt.lifecycle.LifeCycleManaged), LifeCycleManaged

submitLifeCycleObject

public LifeCycleManaged submitLifeCycleObject()
                                       throws LifeCycleException,
                                              WTException

Method submitLifeCycleObject submits the LifeCycleManaged object of this task to the life cycle. Because submitting the object results in the object being modified, a RefreshEvent announcing the modification is broadcast.

Supported API: false

Extendable: false

Returns:

the LifeCycleManaged object which has been submitted

Throws:

LifeCycleException - if an error occurs submitting the LifeCycleManaged object

WTException - if an error occurs submitting the LifeCycleManaged object

dispatchRefresh

private void dispatchRefresh(Object obj,
                             int action)

getIdentity

private String getIdentity(LifeCycleManaged object)