Package com.arbortext.epic.cms

Interface CMSSessionFileEvent

All Superinterfaces:

Event

All Known Implementing Classes:

CMSSessionFileEventImpl

public interface CMSSessionFileEvent
extends Event

The CMSSessionFileEvent interface provides specific contextual information associated with the CMSSessionFileEvent extension. These event types notify programmers of events related to managing non-textual document objects in the repository.

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.
String	getFolderLogicalId()	Parent folder for the CMS object.
String	getLocalPath()	Full path to a resource (file or HTTP) accessible from the client.
String	getLogicalId()	LogicalId for the object being accessed.
String	getNotation()	An adapter-specific format specification.
String	getObjectName()	Name of a repository object.
String	getResult()	The logical ID of an object created in the repository.
void	initCMSSessionFileEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, String logicalIdArg, String localPathArg, String notationArg, String objectNameArg, String folderLogicalIdArg)	Initializes the value of an CMSSessionFileEvent created through the CMSSessionFileEvent 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	setFolderLogicalId(String folderLogicalId)	Parent folder for the CMS object.
void	setLocalPath(String localPath)	Full path to a resource (file or HTTP) accessible from the client.
void	setResult(String result)	The logical ID of an object created in the repository.

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

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

Method Details

getLogicalId

String getLogicalId()

LogicalId for the object being accessed.

getLocalPath

String getLocalPath()

Full path to a resource (file or HTTP) accessible from the client.

setLocalPath

void setLocalPath(String localPath)

Full path to a resource (file or HTTP) accessible from the client.

getNotation

String getNotation()

An adapter-specific format specification.

getObjectName

String getObjectName()

Name of a repository object.

getFolderLogicalId

String getFolderLogicalId()

Parent folder for the CMS object.

setFolderLogicalId

void setFolderLogicalId(String folderLogicalId)

Parent folder for the CMS object.

getResult

String getResult()

The logical ID of an object created in the repository.

setResult

void setResult(String result)

The logical ID of an object created in the repository.

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.

initCMSSessionFileEvent

void initCMSSessionFileEvent(String typeArg,
 boolean canBubbleArg,
 boolean cancelableArg,
 String logicalIdArg,
 String localPathArg,
 String notationArg,
 String objectNameArg,
 String folderLogicalIdArg)

Initializes the value of an CMSSessionFileEvent created through the CMSSessionFileEvent interface. This method should only be called before the CMSSessionFileEvent 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.

logicalIdArg - Represents the logicalId of the object being accessed.

localPathArg - Represents a full path to a resource (file or HTTP) accessible from the client.

notationArg - Represents an adapter-specific format specification.

objectNameArg - Name of the repository object.

folderLogicalIdArg - Represents the parent folder for the new object.