ABLE 2.0.0 07/02/2003 10:25:01

com.ibm.able.conversation
Class StartCPForm

java.lang.Object
  |
  +--com.ibm.able.conversation.StartCPForm
All Implemented Interfaces:
MessageForm

public class StartCPForm
extends java.lang.Object
implements MessageForm

This class represents the message-form used during the MetaConversation CP to negotiate regarding policies to use and roles to assume in a new conversation.

OLD VERSION -- TO BE UPDATED


Constructor Summary
StartCPForm()
          Constructor
StartCPForm(java.lang.String newName)
           
 
Method Summary
 void clearData()
          Reset the constituent data to null or default values.
 javax.agent.Payload formMessagePayload()
          Creates a message, using constituent data that was stored inside this MessageForm object.
 java.lang.String getCPName()
           
 java.lang.Object[] getData()
          Package & return the constituent data in the form of an array of Objects.
 java.lang.String getRoleA()
           
 java.lang.String getRoleB()
           
protected  javax.agent.Payload makePayload(java.lang.String cpName, java.lang.String roleA, java.lang.String roleB)
          Internal method that constructs the payload for the constituent data
 boolean parseMessagePayload(javax.agent.Payload payload)
          Parses the message into its constituent data, which is (supposed to be) stored inside this message-form object in a type-specific way.
 javax.agent.Payload sampleMessagePayload()
          Return a "sample message" showing the format, but with dummy data values.
 void setCPName(java.lang.String name)
           
 void setData(java.lang.Object[] data)
          Try to set the constituent data by means of the supplied arguments.
 void setRoleA(java.lang.String role)
           
 void setRoleB(java.lang.String role)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StartCPForm

public StartCPForm()
Constructor

StartCPForm

public StartCPForm(java.lang.String newName)
Method Detail

getCPName

public java.lang.String getCPName()

setCPName

public void setCPName(java.lang.String name)

getRoleA

public java.lang.String getRoleA()

setRoleA

public void setRoleA(java.lang.String role)

getRoleB

public java.lang.String getRoleB()

setRoleB

public void setRoleB(java.lang.String role)

makePayload

protected javax.agent.Payload makePayload(java.lang.String cpName,
                                          java.lang.String roleA,
                                          java.lang.String roleB)
Internal method that constructs the payload for the constituent data

parseMessagePayload

public boolean parseMessagePayload(javax.agent.Payload payload)
Description copied from interface: MessageForm
Parses the message into its constituent data, which is (supposed to be) stored inside this message-form object in a type-specific way.
Specified by:
parseMessagePayload in interface MessageForm
See Also:
MessageForm.parseMessagePayload(Payload)

formMessagePayload

public javax.agent.Payload formMessagePayload()
                                       throws java.lang.IllegalStateException
Description copied from interface: MessageForm
Creates a message, using constituent data that was stored inside this MessageForm object. If there's something wrong with the data--e.g., if it hasn't been set, or has been set to bad values, throws an IllegalStateException.
Specified by:
formMessagePayload in interface MessageForm
See Also:
MessageForm.formMessagePayload()

sampleMessagePayload

public javax.agent.Payload sampleMessagePayload()
Description copied from interface: MessageForm
Return a "sample message" showing the format, but with dummy data values. This is inherently limited, because we're not characterizing the range of possible messages. We're only giving one example.
Specified by:
sampleMessagePayload in interface MessageForm
See Also:
MessageForm.sampleMessagePayload()

setData

public void setData(java.lang.Object[] data)
             throws java.lang.IllegalArgumentException
Description copied from interface: MessageForm
Try to set the constituent data by means of the supplied arguments. Does not expect to see any properties in the array. Throws an IllegalArgumentException when the array data doesn't have the right elements.
Specified by:
setData in interface MessageForm
See Also:
MessageForm.setData(Object[])

getData

public java.lang.Object[] getData()
Description copied from interface: MessageForm
Package & return the constituent data in the form of an array of Objects. Does not include the properties in the array. If the constituent data is null, returns an array of the appropriate length, but with null-valued elements.
Specified by:
getData in interface MessageForm
See Also:
MessageForm.getData()

clearData

public void clearData()
Description copied from interface: MessageForm
Reset the constituent data to null or default values. Does not affect the properties.
Specified by:
clearData in interface MessageForm
See Also:
MessageForm.clearData()

ABLE 2.0.0 07/02/2003 10:25:01

(C) Copyright IBM Corporation 1999, 2003