Package com.arbortext.epic.cms

Interface CMSObjectEvent

All Superinterfaces:
Event
All Known Implementing Classes:
CMSObjectEventImpl
public interface CMSObjectEvent extends Event
The CMSObjectEvent interface provides specific contextual information associated with the CMSObjectEvent extension. These event types notify programmers of important CMS object operations.
Since:
Arbortext 5.4

  • Method Details

    • getEnd

      Node getEnd()
      Specifies an event-dependent DOM end Node associated with the event.

    • 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.

    • getFlags

      int getFlags()
      Provides an event-dependent bitmask of information.

    • getResult

      CMSObject getResult()
      Represents the event-dependent result of an event.

    • setResult

      void setResult(CMSObject result)
      Represents the event-dependent result of an event.

    • getStart

      Node getStart()
      Specifies an event-dependent DOM start Node associated with the event.

    • initCMSObjectEvent

      void initCMSObjectEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, Node endArg, int flagsArg, CMSObject resultArg, Node startArg)
      Initializes the value of an CMSObjectEvent created through the CMSObjectEvent interface. This method should only be called before the CMSObjectEvent 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.
      endArg - Specifies an event-dependent DOM end Node associated with the event.
      flagsArg - Provides an event-dependent bitmask of information.
      resultArg - Represents the event-dependent result of an event.
      startArg - Specifies an event-dependent DOM start Node associated with the event.