Interface CheckinHandler

  • All Known Implementing Classes:
    CheckInTask, DefaultCheckinHandler

    public interface CheckinHandler
    CheckinHandler facilitates application callbacks during the check-in of a DomainFile.
    • Method Detail

      • getComment

        java.lang.String getComment()
                             throws CancelledException
        Returns the check-in comment.
        Returns:
        the check-in comment
        Throws:
        CancelledException - thrown if user cancels the check-in
      • keepCheckedOut

        boolean keepCheckedOut()
                        throws CancelledException
        Returns true if check-out state should be retained.
        Returns:
        true if check-out state should be retained
        Throws:
        CancelledException - thrown if user cancels the check-in
      • createKeepFile

        boolean createKeepFile()
                        throws CancelledException
        Returns true if the system should create a keep file copy of the user's check-in file.
        Throws:
        CancelledException - thrown if user cancels the check-in