Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.commons.protocol
Class AbstractReferenceBuilder

java.lang.Object
  extended bycom.genesyslab.platform.commons.protocol.AbstractReferenceBuilder
All Implemented Interfaces:
ReferenceBuilder
Direct Known Subclasses:
IntReferenceBuilder

public abstract class AbstractReferenceBuilder
extends java.lang.Object
implements ReferenceBuilder


Method Summary
abstract  java.lang.Object createReference()
          Create next reference
 java.lang.Object retreiveReference(Message message)
          Look for reference in the message.
 java.lang.Object updateReference(Message message)
          Update message's reference with created one.
 void updateReference(Message message, java.lang.Object reference)
          Update message reference with the one supplied.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

retreiveReference

public java.lang.Object retreiveReference(Message message)
Description copied from interface: ReferenceBuilder
Look for reference in the message. Please note that usually channel will update reference if there is no one in message. This method should return null in cases when reference is set to the value that indicate absence of refrence (e.g. 0 (zero) for integer).

Specified by:
retreiveReference in interface ReferenceBuilder
Parameters:
message - message to look for reference
Returns:
reference or null if no reference in the message

updateReference

public void updateReference(Message message,
                            java.lang.Object reference)
Description copied from interface: ReferenceBuilder
Update message reference with the one supplied. Wether the reference will be overriden (if exists) is implementation specific

Specified by:
updateReference in interface ReferenceBuilder
Parameters:
message - message to update reference in
reference - new reference

updateReference

public java.lang.Object updateReference(Message message)
Description copied from interface: ReferenceBuilder
Update message's reference with created one. Wether the reference will be overriden (if exists) is implementation specific. In any case the reference returned should be the one message has after this method completed.

Specified by:
updateReference in interface ReferenceBuilder
Parameters:
message - message to update reference in
Returns:
message's reference

createReference

public abstract java.lang.Object createReference()
Description copied from interface: ReferenceBuilder
Create next reference

Specified by:
createReference in interface ReferenceBuilder
Returns:
reference

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.