Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.commons.protocol
Interface ReferenceBuilder

All Known Implementing Classes:
AbstractReferenceBuilder

public interface ReferenceBuilder


Method Summary
 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.
 

Method Detail

retreiveReference

public java.lang.Object retreiveReference(Message message)
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).

Parameters:
message - message to look for reference
Returns:
reference or null if no reference in the message

createReference

public java.lang.Object createReference()
Create next reference

Returns:
reference

updateReference

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

Parameters:
message - message to update reference in
reference - new reference

updateReference

public java.lang.Object updateReference(Message message)
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.

Parameters:
message - message to update reference in
Returns:
message's reference

Configuration Platform SDK 7.6 API Reference

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