com.filenet.wcm.toolkit.server.util
Class WindowID

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.WindowID
All Implemented Interfaces:
java.io.Serializable

public class WindowID
extends java.lang.Object
implements java.io.Serializable

Window ID with encoded flags is in the format: _part!part!part!part:uniqueID

See Also:
Serialized Form

Field Summary
protected  boolean compatibilityMode
           
protected static java.util.Hashtable flagMap
           
protected  long flags
           
protected static long maxFlag
           
protected static long nextFlag
           
static java.lang.String NO_EXPIRE_FLAG
           
protected static long noExpireFlag
           
static java.lang.String POPUP_FLAG
           
protected static long popupFlag
           
protected  java.lang.String prevId
           
protected  java.lang.String windowId
           
 
Constructor Summary
WindowID(java.lang.String value)
           
 
Method Summary
protected  java.lang.Object clone()
           
static WindowID createFlaggedWindowID(java.lang.String value)
           
protected  void deserialize(java.lang.String value)
           
protected  boolean deserializePrevId(java.lang.String idPart)
           
 boolean equals(java.lang.Object o)
           
 boolean getFlag(java.lang.String partKey)
          Get the flag value true or false for whether or not it is set in the window ID.
static java.lang.String getIdPart(java.lang.String windowId)
           
 java.lang.String getPrevId()
          Gets the previous encoded window ID as a String.
 int hashCode()
           
 boolean idEquals(java.lang.String id)
          Compare the specified id to the un-encoded version of the window ID (i.e.
 boolean isMainWindow()
           
protected  java.lang.String serialize(boolean rootOnly)
           
 void setFlag(java.lang.String partKey, boolean value)
          Set a flag specified by the key.
 void setPrevId(java.lang.String value)
          Specify the previous window ID to this WindowID object.
 java.lang.String toString()
           
 java.lang.String toString(boolean rootOnly)
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

POPUP_FLAG

public static final java.lang.String POPUP_FLAG
See Also:
Constant Field Values

NO_EXPIRE_FLAG

public static final java.lang.String NO_EXPIRE_FLAG
See Also:
Constant Field Values

popupFlag

protected static final long popupFlag
See Also:
Constant Field Values

noExpireFlag

protected static final long noExpireFlag
See Also:
Constant Field Values

nextFlag

protected static long nextFlag

maxFlag

protected static long maxFlag

flagMap

protected static java.util.Hashtable flagMap

windowId

protected java.lang.String windowId

prevId

protected java.lang.String prevId

flags

protected long flags

compatibilityMode

protected boolean compatibilityMode
Constructor Detail

WindowID

public WindowID(java.lang.String value)
Method Detail

createFlaggedWindowID

public static WindowID createFlaggedWindowID(java.lang.String value)

equals

public boolean equals(java.lang.Object o)

deserializePrevId

protected boolean deserializePrevId(java.lang.String idPart)

deserialize

protected void deserialize(java.lang.String value)

serialize

protected java.lang.String serialize(boolean rootOnly)

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException
Throws:
java.lang.CloneNotSupportedException

hashCode

public int hashCode()

toString

public java.lang.String toString()

toString

public java.lang.String toString(boolean rootOnly)

isMainWindow

public boolean isMainWindow()

getFlag

public boolean getFlag(java.lang.String partKey)
Get the flag value true or false for whether or not it is set in the window ID.

Parameters:
partKey -
Returns:

setFlag

public void setFlag(java.lang.String partKey,
                    boolean value)
             throws WcmException
Set a flag specified by the key. If there is no flag matching the key that is sent, a WcmException is thrown.

Parameters:
partKey -
value -
Throws:
WcmException

idEquals

public boolean idEquals(java.lang.String id)
Compare the specified id to the un-encoded version of the window ID (i.e. for _1.12345, the test would be against 12345.

Parameters:
id -
Returns:

getPrevId

public java.lang.String getPrevId()
Gets the previous encoded window ID as a String. Returns null if the current windowId is a popup and there is no prevId defined, null is returned. If the current windowId is not a popup, and there is no prevId, the value WcmController.MAIN_WINDOW is returned.

Returns:

setPrevId

public void setPrevId(java.lang.String value)
Specify the previous window ID to this WindowID object.

Parameters:
value -

getIdPart

public static java.lang.String getIdPart(java.lang.String windowId)
Parameters:
windowId -


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.