EditingSessionOpenVetoException (Oxygen XML API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - ro.sync.ecss.extensions.api.webapp.access.EditingSessionOpenVetoException

All Implemented Interfaces:

java.io.Serializable
```
@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public class EditingSessionOpenVetoException
extends java.lang.Exception
```
Exception to be thrown when the plugin decides that the editing session should not be started.

Since:

17

See Also:

Serialized Form

- Constructor Summary
  
  Constructors
  Constructor Description
  
  EditingSessionOpenVetoException(java.lang.String htmlMessage)
  Constructor.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  java.lang.String getHtmlMessage()
  - Methods inherited from class java.lang.Throwable
    addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EditingSessionOpenVetoException
```
public EditingSessionOpenVetoException(java.lang.String htmlMessage)
```
    Constructor.
    
    Parameters:
    
    htmlMessage - The HTML formatted message that will be presented to the user as the reason for the editing session opening was aborted.
- Method Detail
  - getHtmlMessage
```
public java.lang.String getHtmlMessage()
```
    Returns:
    
    The HTML formatted message that will be presented to the user as the reason for the editing session opening was aborted.