Package com.arbortext.epic.cms

Interface CMSSessionCreateEvent

All Superinterfaces:
Event
All Known Implementing Classes:
CMSSessionCreateEventImpl
public interface CMSSessionCreateEvent extends Event
The CMSSessionCreateEvent interface provides specific contextual information associated with the CMSSessionCreateEvent extension. These event types notify programmers of events related to creating new CMS objects in the repository.
Since:
Arbortext 5.4

  • Method Details

    • getName

      String getName()
      Name of the object being created.

    • setName

      void setName(String name)
      Name of the object being created.

    • getObjType

      String getObjType()
      Adapter-specific object type string.

    • setObjType

      void setObjType(String objType)
      Adapter-specific object type string.

    • getFolderLogicalId

      String getFolderLogicalId()
      Parent folder for the new object.

    • setFolderLogicalId

      void setFolderLogicalId(String folderLogicalId)
      Parent folder for the new object.

    • getFlags

      int getFlags()
      Creation options. Same as the flags parameter of the CMSSession.createNewObject.

    • getStart

      Node getStart()
      DOM start Node associated with the event.

    • getEnd

      Node getEnd()
      DOM end Node associated with the event.

    • getVersion

      String getVersion()
      The object's version number. The value is represented using CMS-specific syntax.

    • getResult

      CMSObject getResult()
      The CMS object created.

    • setResult

      void setResult(CMSObject result)
      The CMS object created.

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

    • initCMSSessionCreateEvent

      void initCMSSessionCreateEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, String nameArg, String objTypeArg, String folderLogicalIdArg, int flagsArg, Node startArg, Node endArg, String versionArg, CMSObject resultArg)
      Initializes the value of an CMSSessionCreateEvent created through the CMSSessionCreateEvent interface. This method should only be called before the CMSSessionCreateEvent 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.
      nameArg - Represents the name of the object being created.
      objTypeArg - Represents an adapter-specific object type string.
      folderLogicalIdArg - Represents the parent folder for the new object.
      flagsArg - Same as the flags parameter of the CMSSession.createNewObject method.
      startArg - First DOM Node in the object's content.
      endArg - Last DOM Node in the object's content.
      versionArg - The object's version number. The value is represented using CMS-specific syntax.
      resultArg - The created CMS object.