Novell exteNd Director 5.0 API: Interface EbiContext

Overview

Package

Class

Tree

Deprecated

Index

Help

Novell exteNd
Director 5.0 API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sssw.wf.api
Interface EbiContext

All Superinterfaces:: EbiContext, EbiRequestContext

public interface EbiContext
extends EbiRequestContext

The interface representing the context object that is passed around during workflow execution.

Method Summary

org.w3c.dom.Document getInstancePayload()
          Return a document that represents the current xPage instanceData

org.w3c.dom.Document getPageDocument()
          Return a document that represents the current xPage

String getTargetURL()
          Return a String that represents the current xPage submit URL

com.sssw.wf.api.EbiWorkitem getWorkitem()
          Return Workitem.

void setInstancePayload(org.w3c.dom.Document page)
          Stores the Document that represents the current xPage instanceData

void setPageDocument(org.w3c.dom.Document page)
          Stores the Document that represents the current xPage.

void setTargetURL(String targetURL)
          Stores the String that represents the current xPage submit URL

void setWorkitem(com.sssw.wf.api.EbiWorkitem workitem)
          Set Workitem.

Methods implemented from interface com.sssw.fw.api.EbiRequestContext

getContentType, getCookieValue, getResponsePhrase, getResponseStatus, getServletContext, getURI, hasQueryString, setContentType, setCookieValue, setRequestResponse, setResponsePhrase, setResponseStatus, setServletContext, setURI

Methods implemented from interface com.sssw.fw.api.EbiContext

cloneCopy, getAttributeNames, getBrowserInfo, getContextName, getEbiRequest, getEbiResponse, getEbiSession, getEbiSession, getEbiWhiteboard, getEJBContext, getException, getLocale, getPrincipal, getTemporaryData, getTemporaryValue, getValue, getValue, getValueNames, hasSession, hasValue, isNewSession, removeAllValues, removeValue, setEbiRequest, setEbiResponse, setEbiSession, setEJBContext, setException, setTemporaryValue, setValue

Method Detail

setWorkitem

public void setWorkitem(com.sssw.wf.api.EbiWorkitem workitem)

Set Workitem.

getWorkitem

public com.sssw.wf.api.EbiWorkitem getWorkitem()

Return Workitem.

getPageDocument

public org.w3c.dom.Document getPageDocument()

Return a document that represents the current xPage

Parameters:: A - String that identifies the document to retrieve
Returns:: A Document that represents the xPage being processed.

setPageDocument

public void setPageDocument(org.w3c.dom.Document page)

Stores the Document that represents the current xPage.

Parameters:: A - String that identifies the document to be stored.; A - Document that represents the xPage being processed.

getInstancePayload

public org.w3c.dom.Document getInstancePayload()

Return a document that represents the current xPage instanceData

Returns:: A Document that represents the instanceData of the xPage being processed.

setInstancePayload

public void setInstancePayload(org.w3c.dom.Document page)

Stores the Document that represents the current xPage instanceData

Parameters:: A - String that identifies the document to be stored.; A - Document that represents the instanceData of the xPage being processed.

getTargetURL

public String getTargetURL()

Return a String that represents the current xPage submit URL

Returns:: A String that represents the submit URL of the xPage being processed.

setTargetURL

public void setTargetURL(String targetURL)

Stores the String that represents the current xPage submit URL

Parameters:: A - String that identifies the String to be stored.; A - String that represents the submit URL of the xPage being processed.