Visit Platform at http://www.platform.com

Platform Symphony 4.1 Java API Reference

com.platform.symphony.soam
Class SessionOpenAttributes

java.lang.Object
  extended by com.platform.symphony.soam.SessionOpenAttributes

public final class SessionOpenAttributes
extends java.lang.Object

Container for all attributes that may be required when opening a session.

See Also:
Connection.openSession(SessionOpenAttributes)

Constructor Summary
SessionOpenAttributes()
          Default constructor.
 
Method Summary
 void setSessionCallback(SessionCallback callback)
          Sets the session callback.
 void setSessionFlags(long flags)
          Sets the session flags.
 void setSessionId(java.lang.String id)
          Sets the id of the session to open.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SessionOpenAttributes

public SessionOpenAttributes()
Default constructor. Constructs a SessionOpenAttributes object with default settings.

Method Detail

setSessionId

public void setSessionId(java.lang.String id)
                  throws SoamException
Sets the id of the session to open.

Parameters:
id - The session id.
Throws:
SoamException

setSessionFlags

public void setSessionFlags(long flags)
                     throws SoamException
Sets the session flags. The session flags are used to inform the API of any extended behavior to associate with the session. When not specified the default flag will be Session.SYNC. See the com.platform.symphony.soam.Session object for explanation of flags and their usage.

Parameters:
flags - The session flags.
Throws:
SoamException
See Also:
Session

setSessionCallback

public void setSessionCallback(SessionCallback callback)
                        throws SoamException
Sets the session callback. This method allows you to specify a SessionCallback object, which is a handler that will allow you to process your session's task results asynchronously. The session callback should only be provided when you have set the appropriate session flags to indicate that you will be receiving task results asynchronously. Default value is null - no session callback.

Parameters:
callback - The session callback.
Throws:
SoamException

Version 4.1
Date Modified: -DREL_DATE=Nov 03 2008
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2008 Platform Computing Corporation. All rights reserved.