Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.protocol
Interface ReferenceBuilder

All Known Implementing Classes:
AbstractReferenceBuilder, IntReferenceBuilder, TServerReferenceBuilder

public interface ReferenceBuilder


Method Summary
 java.lang.Object createReference()
          Creates next reference.
 java.lang.Object retreiveReference(Message message)
          Looks for reference in the message.
 java.lang.Object updateReference(Message message)
          Updates message's reference with created one.
 void updateReference(Message message, java.lang.Object reference)
          Updates message reference with the one supplied.
 

Method Detail

retreiveReference

java.lang.Object retreiveReference(Message message)
Looks 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 reference (e.g. 0 (zero) for integer).

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

createReference

java.lang.Object createReference()
Creates next reference.

Returns:
reference

updateReference

void updateReference(Message message,
                     java.lang.Object reference)
Updates message reference with the one supplied. Whether the reference will be overridden (if exists) is implementation specific.

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

updateReference

java.lang.Object updateReference(Message message)
Updates message's reference with created one. Whether the reference will be overridden (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

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.