|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.able.conversation.StartCPForm
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 |
public StartCPForm()
public StartCPForm(java.lang.String newName)
Method Detail |
public java.lang.String getCPName()
public void setCPName(java.lang.String name)
public java.lang.String getRoleA()
public void setRoleA(java.lang.String role)
public java.lang.String getRoleB()
public void setRoleB(java.lang.String role)
protected javax.agent.Payload makePayload(java.lang.String cpName, java.lang.String roleA, java.lang.String roleB)
public boolean parseMessagePayload(javax.agent.Payload payload)
MessageForm
parseMessagePayload
in interface MessageForm
MessageForm.parseMessagePayload(Payload)
public javax.agent.Payload formMessagePayload() throws java.lang.IllegalStateException
MessageForm
formMessagePayload
in interface MessageForm
MessageForm.formMessagePayload()
public javax.agent.Payload sampleMessagePayload()
MessageForm
sampleMessagePayload
in interface MessageForm
MessageForm.sampleMessagePayload()
public void setData(java.lang.Object[] data) throws java.lang.IllegalArgumentException
MessageForm
setData
in interface MessageForm
MessageForm.setData(Object[])
public java.lang.Object[] getData()
MessageForm
getData
in interface MessageForm
MessageForm.getData()
public void clearData()
MessageForm
clearData
in interface MessageForm
MessageForm.clearData()
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |