com.ibm.able.platform.examples
Class EServerTemplateAgentAboutDataBean

java.lang.Object
  |
  +--com.ibm.able.platform.examples.EServerTemplateAgentAboutDataBean
All Implemented Interfaces:
com.ibm.ui.framework.DataBean, java.io.Serializable

public class EServerTemplateAgentAboutDataBean
extends java.lang.Object
implements com.ibm.ui.framework.DataBean, java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.ibm.ui.framework.DataBean
STATUS_COMPLETE, STATUS_ERROR, STATUS_INCOMPLETE
 
Constructor Summary
EServerTemplateAgentAboutDataBean()
           
 
Method Summary
 java.lang.String getAboutMessage()
          This method returns the value for AboutMessage
 com.ibm.ui.framework.Capabilities getCapabilities()
          Returns a Capabilities object which identifies the attributes that aren't supported by this DataBean.
 void load()
          Initializes this object.
 void save()
          Saves all changes that have been applied to this object via its accessor methods.
 void setAboutMessage(java.lang.String s)
          This method is called by the framework to store the value for AboutMessage
 void verifyChanges()
          Validates any changes that have been applied to this object via its accessor methods.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EServerTemplateAgentAboutDataBean

public EServerTemplateAgentAboutDataBean()
Method Detail

setAboutMessage

public void setAboutMessage(java.lang.String s)
                     throws com.ibm.ui.framework.IllegalUserDataException
This method is called by the framework to store the value for AboutMessage
Parameters:
s - The string control's current value.
Throws:
com.ibm.ui.framework.IllegalUserDataException - Should be thrown when user entered data is invalid.
See Also:
DataBean

getAboutMessage

public java.lang.String getAboutMessage()
This method returns the value for AboutMessage
Returns:
The value for the string control.
See Also:
DataBean

getCapabilities

public com.ibm.ui.framework.Capabilities getCapabilities()
Returns a Capabilities object which identifies the attributes that aren't supported by this DataBean.

There are many reasons why a DataBean might not support a given attribute. For example:

The Capabilities object may provide a list of instructions, or EventTasks, which the UI framework is to perform. Typically these involve disabling or removing certain UI components from a panel.

Specified by:
getCapabilities in interface com.ibm.ui.framework.DataBean
Returns:
A Capabilities object which reflects this object's capabilities.
See Also:
DataBean

verifyChanges

public void verifyChanges()
                   throws com.ibm.ui.framework.IllegalUserDataException
Validates any changes that have been applied to this object via its accessor methods.

This method is called just prior to save to give the receiver an opportunity to verify that its data is consistent with any changes made to other DataBeans associated with a given task. If an inconsistency is discovered the DataBean should throw an IllegalUserDataException. This will prevent the changes from being committed.

Specified by:
verifyChanges in interface com.ibm.ui.framework.DataBean
Throws:
com.ibm.ui.framework.IllegalUserDataException - Should be thrown when user entered data is invalid.
See Also:
DataBean

load

public void load()
Initializes this object.

This method should be called before passing the DataBean to UserTaskManager. On return from this method the bean should be in a state where it is ready to return data on any of its accessor methods.

Specified by:
load in interface com.ibm.ui.framework.DataBean
See Also:
DataBean

save

public void save()
Saves all changes that have been applied to this object via its accessor methods. Called when the user task is committed.
Specified by:
save in interface com.ibm.ui.framework.DataBean
See Also:
DataBean