Class ReadOnlyReason


  • @API(type=EXTENDABLE,
         src=PUBLIC)
    public class ReadOnlyReason
    extends java.lang.Object
    An object describing the cause for which an editor is read-only.
    Since:
    19.1
    • Constructor Summary

      Constructors 
      Constructor Description
      ReadOnlyReason​(java.lang.String message)
      Constructor.
      ReadOnlyReason​(java.lang.String message, java.lang.String code)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCode()  
      java.lang.String getMessage()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ReadOnlyReason

        public ReadOnlyReason​(java.lang.String message,
                              java.lang.String code)
        Constructor.
        Parameters:
        message - The message that explains why the editor is read-only.
        code - The code of the cause for which the editor is read-only. It will be only accessible through the API.
      • ReadOnlyReason

        public ReadOnlyReason​(java.lang.String message)
        Constructor.
        Parameters:
        message - The message that explains why the editor is read-only.
    • Method Detail

      • getMessage

        public java.lang.String getMessage()
        Returns:
        The message that explains why the editor is read-only.
      • getCode

        public java.lang.String getCode()
        Returns:
        The code of the cause for which the editor is read-only. It will be only accessible through the API.