Package com.arbortext.epic.cms

Interface CMSSessionBurstDocumentEvent

All Superinterfaces:
Event
All Known Implementing Classes:
CMSSessionBurstDocumentEventImpl
public interface CMSSessionBurstDocumentEvent extends Event
The CMSSessionBurstDocumentEvent interface provides specific contextual information associated with the CMSSessionBurstDocument extension. These event types notify programmers of events related to document bursting and the resultant objects created in the repository.
Since:
Arbortext 5.4

  • Method Details

    • getCanOverride

      boolean getCanOverride()
      If true, for the CMSSessionBurstDocument event, the event handler can override the values in the topLevelName and folderLogicalId properties.

    • getTopLevelName

      String getTopLevelName()
      Name of the top-level object which will result from bursting the document. This may be null or empty which means the name will be auto-generated according to the bursting rules for this adapter. For the CMSSessionBurstDocument event, the event handler can override this value if canOverride is true.

    • setTopLevelName

      void setTopLevelName(String topLevelName)
      Name of the top-level object which will result from bursting the document. This may be null or empty which means the name will be auto-generated according to the bursting rules for this adapter. For the CMSSessionBurstDocument event, the event handler can override this value if canOverride is true.

    • getFolderLogicalId

      String getFolderLogicalId()
      Parent folder for the CMS object.

    • setFolderLogicalId

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

    • getDocument

      Document getDocument()
      For the CMSSessionBurstDocument event, this is the document that will be burst. For the CMSSessionPostBurstDocument event, this is the document that was burst.

    • getFlags

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

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

    • initCMSSessionBurstDocumentEvent

      void initCMSSessionBurstDocumentEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, boolean canOverrideArg, String topLevelNameArg, String folderLogicalIdArg, Document documentArg, int flagsArg)
      Initializes the value of an CMSSessionBurstDocumentEvent created through the CMSSessionBurstDocumentEvent interface. This method should only be called before the CMSSessionBurstDocumentEvent 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.
      canOverrideArg - If true, then, for the CMSSessionBurstDocument event, the event handler can override the values in the topLevelName and folderLogicalId properties.
      topLevelNameArg - Name of the repository object.
      folderLogicalIdArg - Represents the parent folder for the new object.
      documentArg - Represents a full path to a resource (file or HTTP) accessible from the client.
      flagsArg - Represents an adapter-specific format specification.