com.ptc.windchill.enterprise.search.client
Class WebSearchFrameModelHandler

java.lang.Object
  com.ptc.core.ca.co.client.element.CoElementHandler
      com.ptc.windchill.enterprise.search.client.WebSearchFrameModelHandler

All Implemented Interfaces:

CoModelHandler

public class WebSearchFrameModelHandler

extends CoElementHandler

implements CoModelHandler

Supported API: false

Extendable: false

Field Summary

private static String	CLASSNAME
private static String	DCA_FRAME_ALIAS
private static String	DCA_FRAME_ID
private boolean	isSameFrame
private static String	RESOURCE

Fields inherited from class com.ptc.core.ca.co.client.element.CoElementHandler

Constructor Summary

WebSearchFrameModelHandler()

Method Summary

private String	getFrameAlias(CoFrame frame) Returns the alias of the current DCA frame Supported API: false
private String	getFrameId(CoFrame frame) Returns the frameId of the current DCA frame Supported API: false
private void	setSavedSearchParameters(Map savedSearchMap, CoEnvData envData) Sets the DCA context so the search is executed in the same context as it was saved in.
private void	storeFrameAlias(CoFrame frame, String frameAlias, javax.servlet.http.HttpSession jspSessionData) Stores the frame's alias attribute in the servlet containers session.
private void	storeFrameId(CoFrame frame, String frameId, javax.servlet.http.HttpSession jspSessionData) Stores the frame's frameId attribute in the servlet containers session.
void	updateModel(CoElement element, CoEnvData envData) Indicates whether some other object is "equal to" this one.

Methods inherited from class com.ptc.core.ca.co.client.element.CoElementHandler

equals, getClassName, hashCode, setClassName

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

DCA_FRAME_ALIAS

private static final String DCA_FRAME_ALIAS

See Also:

Constant Field Values

DCA_FRAME_ID

private static final String DCA_FRAME_ID

See Also:

Constant Field Values

isSameFrame

private boolean isSameFrame

Constructor Detail

WebSearchFrameModelHandler

public WebSearchFrameModelHandler()

Method Detail

updateModel

public void updateModel(CoElement element,
                        CoEnvData envData)
                 throws WTException

Indicates whether some other object is "equal to" this one.

Supported API: false

Specified by:

updateModel in interface CoModelHandler

Parameters:

element -

envData -

Throws:

WTException

setSavedSearchParameters

private void setSavedSearchParameters(Map savedSearchMap,
                                      CoEnvData envData)

Sets the DCA context so the search is executed in the same context as it was saved in. For example, it sets the type of object that was being searched for, the container that was being searched in, and the type of search page it was saved in.

Supported API: false

Parameters:

savedSearchMap -

envData -

getFrameAlias

private String getFrameAlias(CoFrame frame)

Returns the alias of the current DCA frame

Supported API: false

Parameters:

frame -

getFrameId

private String getFrameId(CoFrame frame)

Returns the frameId of the current DCA frame

Supported API: false

Parameters:

frame -

storeFrameAlias

private void storeFrameAlias(CoFrame frame,
                             String frameAlias,
                             javax.servlet.http.HttpSession jspSessionData)

Stores the frame's alias attribute in the servlet containers session. Helps out in checking to see if the browser's refresh" or "back" button has been clicked.

Supported API: false

Parameters:

frame -

frameAlias -

jspSessionData -

storeFrameId

private void storeFrameId(CoFrame frame,
                          String frameId,
                          javax.servlet.http.HttpSession jspSessionData)

Stores the frame's frameId attribute in the servlet containers session. If the IFRAME which the DCA page resides in is refreshed because of a browser "refresh" or "back" button execution, then the stored frameID will be used to maintain DCA page context.

Supported API: false

Parameters:

frame -

frameId -

jspSessionData -