Package com.microstrategy.webapi.acm

Class ACMSessionId.ConfigSessionId

java.lang.Object

com.microstrategy.webapi.acm.ACMSessionId

com.microstrategy.webapi.acm.ACMSessionId.ConfigSessionId

All Implemented Interfaces:

IDSSXMLSessionId, IDSSXMLSessionId.IConfigSessionId, java.lang.Comparable<ACMSessionId>

Enclosing class:

ACMSessionId

public static class ACMSessionId.ConfigSessionId
extends ACMSessionId
implements IDSSXMLSessionId.IConfigSessionId

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.webapi.acm.ACMSessionId

ACMSessionId.ConfigSessionId, ACMSessionId.MasterSessionId, ACMSessionId.ProjectSessionId

Nested classes/interfaces inherited from interface com.microstrategy.webapi.IDSSXMLSessionId

IDSSXMLSessionId.Factory, IDSSXMLSessionId.IConfigSessionId, IDSSXMLSessionId.IMasterSessionId, IDSSXMLSessionId.IProjectSessionId, IDSSXMLSessionId.TYPE

Constructor Summary

Constructors

Constructor	Description
ConfigSessionId(IDSSXMLSessionIdParser iSessionIdParser)
ConfigSessionId(java.lang.String iAugmentedSessionId)

Method Summary

Modifier and Type	Method	Description
IDSSXMLSessionId.IConfigSessionId	castConfigSessionId()	castConfigSessionId returns the IConfigSessionId already cast.
IDSSXMLSessionId.IMasterSessionId	castMasterSessionId()	castMasterSessionId returns the IMasterSessionId already cast.
IDSSXMLSessionId.IProjectSessionId	castProjectSessionId()	castProjectSessionId returns the IPsid already cast.
ACMSessionId.ConfigSessionId	Clone()	Clone will create a new copy of the IDSSXMLSessionId.

Methods inherited from class com.microstrategy.webapi.acm.ACMSessionId

addLocale, addMessageId, addProjectId, addRetVal, addSSProjectId, compareTo, equals, getAugmentedSessionId, getIServerNodeName, getLocale, getMessageId, getObscuredAugmentedSessionId, getPort, getProjectId, getRetVal, getSessionId, getSSProjectId, getType, hashCode, hasLocale, hasMessageId, hasProjectId, hasRetVal, hasSSProjectId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.webapi.IDSSXMLSessionId

addLocale, addMessageId, addProjectId, addRetVal, addSSProjectId, getAugmentedSessionId, getIServerNodeName, getLocale, getMessageId, getObscuredAugmentedSessionId, getPort, getProjectId, getRetVal, getSessionId, getSSProjectId, getType, hasLocale, hasMessageId, hasProjectId, hasRetVal, hasSSProjectId

Constructor Detail

ConfigSessionId

public ConfigSessionId(java.lang.String iAugmentedSessionId)
                throws MSTRWebAPIException

Throws:

MSTRWebAPIException

ConfigSessionId

public ConfigSessionId(IDSSXMLSessionIdParser iSessionIdParser)
                throws MSTRWebAPIException

Throws:

MSTRWebAPIException

Method Detail

castMasterSessionId

public IDSSXMLSessionId.IMasterSessionId castMasterSessionId()
                                                      throws MSTRWebAPIException

Description copied from interface: IDSSXMLSessionId

castMasterSessionId returns the IMasterSessionId already cast. If this object is not a MasterSessionId it will throw MSTRWebAPIException. To avoid the throw use getType to find out what type it is before casting

Specified by:

castMasterSessionId in interface IDSSXMLSessionId

Returns:

the cast Master Session Id

Throws:

MSTRWebAPIException - when it is not a Master Session Id

castConfigSessionId

public IDSSXMLSessionId.IConfigSessionId castConfigSessionId()
                                                      throws MSTRWebAPIException

Description copied from interface: IDSSXMLSessionId

castConfigSessionId returns the IConfigSessionId already cast. If this object is not a ConfigSessionId it will throw MSTRWebAPIException. To avoid the throw use getType to find out what type it is before casting

Specified by:

castConfigSessionId in interface IDSSXMLSessionId

Specified by:

castConfigSessionId in class ACMSessionId

Returns:

the cast Configuration Session Id

Throws:

MSTRWebAPIException - when it is not a Configuration Session Id

castProjectSessionId

public IDSSXMLSessionId.IProjectSessionId castProjectSessionId()
                                                        throws MSTRWebAPIException

Description copied from interface: IDSSXMLSessionId

castProjectSessionId returns the IPsid already cast. If this object is not a ProjectSessionId it will throw MSTRWebAPIException. To avoid the throw use getType to find out what type it is before casting

Specified by:

castProjectSessionId in interface IDSSXMLSessionId

Specified by:

castProjectSessionId in class ACMSessionId

Returns:

the cast Project Session Id

Throws:

MSTRWebAPIException - when it is not a Project Session Id

Clone

public ACMSessionId.ConfigSessionId Clone()
                                   throws MSTRWebAPIException

Description copied from interface: IDSSXMLSessionId

Clone will create a new copy of the IDSSXMLSessionId. This is good because the ConfigSessionIds and ProjectSessionIds are held inside a number of maps and will be accessed on different threads. To avoid locking, it is good to create a Clone that you can use temporarily

Specified by:

Clone in interface IDSSXMLSessionId

Specified by:

Clone in interface IDSSXMLSessionId.IConfigSessionId

Specified by:

Clone in class ACMSessionId

Returns:

the cloned Session Id

Throws:

MSTRWebAPIException