Interface DomainFolderChangeListener

All Known Implementing Classes:
DomainFolderChangesDisplayPlugin, DomainFolderListenerAdapter, ProjectIndexService

public interface DomainFolderChangeListener
Methods for notifications when changes are made to a domain folder or a domain file.
  • Method Details

    • domainFolderAdded

      default void domainFolderAdded(DomainFolder folder)
      Notification that a folder is added to parent.
      Parameters:
      folder - domain folder which was just added.
    • domainFileAdded

      default void domainFileAdded(DomainFile file)
      Notification that a file is added to parent folder. You can get the parent from the file.
      Parameters:
      file - domain file which was just added.
    • domainFolderRemoved

      default void domainFolderRemoved(DomainFolder parent, String name)
      Notification that a domain folder is removed.
      Parameters:
      parent - domain folder which contained the folder that was just removed.
      name - the name of the folder that was removed.
    • domainFileRemoved

      default void domainFileRemoved(DomainFolder parent, String name, String fileID)
      Notification that a file was removed
      Parameters:
      parent - domain folder which contained the file that was just removed.
      name - the name of the file that was removed.
      fileID - file ID or null
    • domainFolderRenamed

      default void domainFolderRenamed(DomainFolder folder, String oldName)
      Notify listeners when a domain folder is renamed.

      NOTE: Only a single event will be sent for the specific folder renamed and not its children. If the listener cares about the impact of this event on the folder's children it will need to process accordingly.

      Parameters:
      folder - folder that was renamed
      oldName - old name of folder
    • domainFileRenamed

      default void domainFileRenamed(DomainFile file, String oldName)
      Notification that the domain file was renamed.
      Parameters:
      file - file that was renamed
      oldName - old name of the file
    • domainFolderMoved

      default void domainFolderMoved(DomainFolder folder, DomainFolder oldParent)
      Notification that the domain folder was moved.

      NOTE: Only a single event will be sent for the specific folder moved and not its children. If the listener cares about the impact of this event on the folder's children it will need to process accordingly.

      Parameters:
      folder - the folder (after move)
      oldParent - original parent folder
    • domainFileMoved

      default void domainFileMoved(DomainFile file, DomainFolder oldParent, String oldName)
      Notification that the domain file was moved.
      Parameters:
      file - the file (after move)
      oldParent - original parent folder
      oldName - file name prior to move
    • domainFolderSetActive

      default void domainFolderSetActive(DomainFolder folder)
      Notification that the setActive() method on the folder was called.
      Parameters:
      folder - folder which was activated/visited
    • domainFileStatusChanged

      default void domainFileStatusChanged(DomainFile file, boolean fileIDset)
      Notification that the status for a domain file has changed.
      Parameters:
      file - file whose status has changed.
      fileIDset - if true indicates that the previously missing fileID has been established for the specified file.
    • domainFileObjectOpenedForUpdate

      default void domainFileObjectOpenedForUpdate(DomainFile file, DomainObject object)
      Notification that a domain file has been opened for update.
      Parameters:
      file - domain file
      object - domain object open for update
    • domainFileObjectClosed

      default void domainFileObjectClosed(DomainFile file, DomainObject object)
      Notification that a domain file previously open for update is in the process of closing.
      Parameters:
      file - domain file
      object - domain object which was open for update