Package com.arbortext.epic.cms

Interface CMSSessionConstructEvent

All Superinterfaces:

Event

All Known Implementing Classes:

CMSSessionConstructEventImpl

public interface CMSSessionConstructEvent
extends Event

The CMSSessionConstructEvent interface provides specific contextual information associated with the CMSSessionConstructEvent extension. These event types notify programmers of operations that construct in-memory representations of repository objects.

Since:

Arbortext 5.4

Field Summary

Fields inherited from interface org.w3c.dom.events.Event

AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE

Method Summary

Modifier and Type	Method	Description
short	getErrorCode()	Used when the event handler wants to cancel the operation or throw an error exception.
String	getErrorMessage()	Used when the event handler wants to throw an error exception and additionally provide a human-readable error message.
CMSObject	getResult()	The constructed CMS object.
void	initCMSSessionConstructEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, CMSObject resultArg)	Initializes the value of an CMSSessionConstructEvent created through the CMSSessionConstructEvent interface.
void	setErrorCode(short errorCode)	Used when the event handler wants to cancel the operation or throw an error exception.
void	setErrorMessage(String errorMessage)	Used when the event handler wants to throw an error exception and additionally provide a human-readable error message.
void	setResult(CMSObject result)	The constructed CMS object.

Methods inherited from interface org.w3c.dom.events.Event

getBubbles, getCancelable, getCurrentTarget, getEventPhase, getTarget, getTimeStamp, getType, initEvent, preventDefault, stopPropagation

Method Details

getResult

CMSObject getResult()

The constructed CMS object.

setResult

void setResult(CMSObject result)

The constructed CMS object.

getErrorCode

short getErrorCode()

Used when the event handler wants to cancel the operation or throw an error exception. This can hold any defined CMSExceptionCode value. To cancel the operation, call preventDefault() and store a value of OPERATION_CANCELED_ERR into errorCode. To cause an error exception, call preventDefault(), store any other defined CMSExceptionCode value into errorCode, and optionally store a message into errorMessage.

setErrorCode

void setErrorCode(short errorCode)

Used when the event handler wants to cancel the operation or throw an error exception. This can hold any defined CMSExceptionCode value. To cancel the operation, call preventDefault() and store a value of OPERATION_CANCELED_ERR into errorCode. To cause an error exception, call preventDefault(), store any other defined CMSExceptionCode value into errorCode, and optionally store a message into errorMessage.

getErrorMessage

String getErrorMessage()

Used when the event handler wants to throw an error exception and additionally provide a human-readable error message. To do this, call preventDefault(), store the appropriate value into errorCode, and store a message into errorMessage.

setErrorMessage

void setErrorMessage(String errorMessage)

Used when the event handler wants to throw an error exception and additionally provide a human-readable error message. To do this, call preventDefault(), store the appropriate value into errorCode, and store a message into errorMessage.

initCMSSessionConstructEvent

void initCMSSessionConstructEvent(String typeArg,
 boolean canBubbleArg,
 boolean cancelableArg,
 CMSObject resultArg)

Initializes the value of an CMSSessionConstructEvent created through the CMSSessionConstructEvent interface. This method should only be called before the CMSSessionConstructEvent has been dispatched using the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times, the final invocation takes precedence.

Parameters:

typeArg - Specifies the event type.

canBubbleArg - Specifies whether or not the event can bubble.

cancelableArg - Specifies whether or not the event's default action can be prevented.

resultArg - Represents the constructed CMS object.