Package com.saperion.ngc.events

Interface EventChildHandler

All Superinterfaces:
EventChild, LogEventChildHandler, Serializable
All Known Subinterfaces:
DocumentView, IntelligentFormView, MainTabView, NavigationView, ResultSetView
All Known Implementing Classes:
AbstractDocumentView, AbstractStructureDialog, BaseWindow, CheckinDialog, DocumentViewImpl, EditStructureDialog, EventChildHandlerImpl, ExternalStorageCreateDocDialog, ExternalStorageDashBoardDialog, ExternalStorageUploadDialog, ExternalStorageUploadStatusDialog, HylandViewerImpl, IntelligentFormPopupWindow, IntelligentFormViewImpl, LogViewImpl, MainTabViewImpl, MediaViewerImpl, NavigationViewImpl, NewFolderDialog, OneDriveLoginDialog, OneDriveLogInErrorDialog, OneDriveLogInSuccessDialog, OneDriveLogOutErrorDialog, OneDriveManageShareDialog, OneDriveNewShareDialog, PdfjsViewerImpl, ResultSetViewImpl, RevisionHistoryDialog, SapDocumentViewImpl, SelectFolderClassDialog, ShareBaseCheckInDialog, ShareBaseCheckoutShareDialog, ShareBaseDuplicateDocumentUploadErrorDialog, ShareBaseLoginDialog, ShareBaseLogInErrorDialog, ShareBaseManageShareDialog, ShareBaseNewShareDialog, SimpleViewerImpl, UserSelectionDialog, VirtualViewerHTML5, WeblinkHandler
public interface EventChildHandler extends LogEventChildHandler
This interface defines common methods to post events for webclient-components.

  • Method Details

    • postWorkflowActionEvent

      void postWorkflowActionEvent(List<DocumentId> task, com.saperion.intf.wf.CommandInfo info, List<String> actor, String commentString, Date actionDate)
      Parameters:
      task - Task info
      info - Command info
      actor - Actor
      commentString - Comment
      actionDate - Action date

    • postWorkflowCommentEvent

      void postWorkflowCommentEvent(List<DocumentId> tasks)
      Parameters:
      tasks - Task info

    • postWorkflowDisplayCommentEvent

      void postWorkflowDisplayCommentEvent(DocumentId task)
      Parameters:
      task - Task info

    • postDisplayPopupEvent

      void postDisplayPopupEvent(DocumentId docId, boolean withCtrl, boolean editMode)
      Parameters:
      docId - Document id
      withCtrl - With CTRL
      editMode - edit mode

    • postDisplayPopupEvent

      void postDisplayPopupEvent(DocumentId docId, boolean currentRevision, boolean withCtrl, boolean editMode)
      Parameters:
      docId - Document id
      withCtrl - With CTRL
      currentRevision - currentRevision
      editMode - edit mode

    • postDisplayPopupEvent

      void postDisplayPopupEvent(DocumentId docId, boolean withCtrl, boolean editMode, ResultSetViewImpl view)
      Parameters:
      docId - Document id
      withCtrl - With CTRL
      editMode - edit mode
      view - ResultSetViewImpl

    • postDisplayResultItemEvent

      void postDisplayResultItemEvent(int maskRights, DocumentId selectedDocId)
      Parameters:
      maskRights - rights enabled in the mask
      selectedDocId - selected item's id

    • postDisplayResultItemEvent

      void postDisplayResultItemEvent(DocumentId selectedDocId)
      Calls postDisplayResultItemEvent(int, DocumentId) with all rights enabled.
      Parameters:
      selectedDocId - selected item's ID

    • postIndexResultItemEvent

      void postIndexResultItemEvent(ResultProperties properties, String componentId)
      Parameters:
      properties - Properties
      componentId - id of the component firing this event

    • postLockDocumentEvent

      void postLockDocumentEvent(boolean lock)
      Parameters:
      lock - Lock

    • postLaunchWorkflowEvent

      void postLaunchWorkflowEvent(List<String> documentIds, String workflowName, String commentString, List<com.saperion.intf.wf.WorkflowMember> users)
      Parameters:
      documentIds - Document id's
      workflowName - Workflow name
      commentString - Comment string
      users - Users

    • postNewSelectedEvent

      void postNewSelectedEvent(NewSelectedEvent.NewEventOrigin origin, String maskName, String ddcName, FormMode mode)
      New event.
      Parameters:
      origin - event origin
      maskName - Mask name
      ddcName - DDC name
      mode - Form mode

    • postEditItemSelectedEvent

      void postEditItemSelectedEvent(EditItemSelectedEvent.EditItemEventOrigin origin, String maskName, String ddcName, ResultProperties properties)
      Edit item event.
      Parameters:
      origin - event origin
      maskName - Mask name
      ddcName - DDC name
      properties - Properties

    • postEditSelectedEvent

      void postEditSelectedEvent(EditSelectedEvent.EditEventOrigin origin)
      Edit event.
      Parameters:
      origin - event origin

    • postEditSelectedEvent

      void postEditSelectedEvent(EditSelectedEvent.EditEventOrigin origin, boolean readonly)
      Edit event.
      Parameters:
      origin - event origin
      readonly - if true index data will be shown but cannot be edited

    • postEditSelectedEvent

      void postEditSelectedEvent(EditSelectedEvent.EditEventOrigin origin, String mask, ResultProperties properties)
      Edit event.
      Parameters:
      origin - event origin
      mask - name of the mask to use
      properties - properties of the document to edit

    • postCancelSelectedEvent

      void postCancelSelectedEvent(com.saperion.ngc.iform.xml.SaveActionType action)
      Cancel event.
      Parameters:
      action - save action

    • postResultFieldEvent

      void postResultFieldEvent(ResultFieldEventBean bean)
      Parameters:
      bean - Result field bean

    • postSaveDocumentEvent

      void postSaveDocumentEvent(ResultFieldEventBean bean)
      Parameters:
      bean - Result field bean

    • postSaveDocumentEvent

      void postSaveDocumentEvent(ResultFieldEventBean bean, Set<String> acls, String comment, Map<String,DocumentVariable> variables)
      Parameters:
      bean - Result field bean
      acls - ACLs to use when saving (comma-separated string)
      comment - the comment for the new revisionw
      variables - the variables to add to the document

    • postDeleteSelectedEvent

      void postDeleteSelectedEvent()
      Delete selected.

    • postUnDeleteSelectedEvent

      void postUnDeleteSelectedEvent()
      Undelete selected.

    • postDocumentCheckEvent

      void postDocumentCheckEvent(CheckDataBean.CheckType checkout, DocumentId id)
      Checkin / checkout selected document.
      Parameters:
      checkout - Checkout / checkin type
      id - Document id

    • postDocumentCheckWithShareBaseEvent

      void postDocumentCheckWithShareBaseEvent(ShareBaseCheckDataBean.ShareBaseCheckType checkType, DocumentId id, boolean isShareBaseLoggedIn)
      Checkin / checkout selected document from/to ShareBase.
      Parameters:
      checkType - type of check event; available events are checkout, checkin and discard
      id - Saperion document id
      isShareBaseLoggedIn - true if user is already logged in sharebase else request for login

    • postDocumentReleaseEvent

      void postDocumentReleaseEvent(DocumentId id)
      Release selected document.
      Parameters:
      id - Document id to release

    • postFormButtonEvent

      void postFormButtonEvent(ButtonInfo info)
      Parameters:
      info - Button info

    • postDownloadResultItemEvent

      void postDownloadResultItemEvent(List<ResultProperties> items)
      Parameters:
      items - items to download

    • postSendMailResultItemEvent

      void postSendMailResultItemEvent(MailSendType mailSendType, ResultProperties item, MailContentType mailContentType)
      Parameters:
      mailSendType - mail send type
      item - item to send per mail
      mailContentType - mail content type

    • postStartWorkflowEvent

      void postStartWorkflowEvent(List<String> documentIds)
      Parameters:
      documentIds - Document IDs

    • postNavigationFormEvent

      void postNavigationFormEvent(MaskInfoBean infoBean, boolean close)
      Parameters:
      infoBean - Mask info bean
      close - Close tab

    • postNavigationFormEvent

      void postNavigationFormEvent(MaskInfoBean infoBean, FolderSearchInfos infos, boolean close)
      Parameters:
      infoBean - Mask info bean
      infos - folder search infos (to search within a folder)
      close - Close tab

    • postNavigationFolderEvent

      void postNavigationFolderEvent(FolderNode node, boolean close)
      Parameters:
      node - Navigation folder node
      close - Close tab

    • postNavigationWebpartEvent

      void postNavigationWebpartEvent(String adress, String name, boolean close)
      Parameters:
      adress - Webpart adress
      name - Name
      close - Close tab

    • postSelectTreeItemEvent

      void postSelectTreeItemEvent(FolderId folderId, SelectTreeItemEvent.Destination type)
      Parameters:
      folderId - folderId or null, if not needed
      type - Destination type

    • postFieldChangeEvent

      void postFieldChangeEvent(ResultProperty property)
      Parameters:
      property - Property

    • postLogonEvent

      void postLogonEvent(LogonEvent.LogonResult result, String userName)
      Parameters:
      result - Logon result
      userName - User name

    • postLogonEvent

      void postLogonEvent(LogonEvent.LogonResult result, String userName, boolean bIsSSOUser)
      Parameters:
      result - Logon result
      userName - User name
      bIsSSOUser - indicate SSOUser

    • postResetGuiEvent

      void postResetGuiEvent()
      Post reset GUI event.

    • postEditContentEvent

      void postEditContentEvent(EditContentEvent.EditContentAction action, DocumentId documentId)
      Post edit content event.
      Parameters:
      action - edit action
      documentId - document id

    • postAddToFavoritesEvent

      void postAddToFavoritesEvent(FavoriteQueryInformation favoriteQueryInformation)
      Posts an add to favorites event.
      Parameters:
      favoriteQueryInformation - FavoriteQueryInformation

    • postQueryFavoriteEvent

      void postQueryFavoriteEvent(com.saperion.ngc.favorites.xml.Favorites favorites, boolean close)
      Posts an on query favorite event.
      Parameters:
      favorites - Favorites
      close - Close tab

    • postDocumentFilingEvent

      void postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, Set<FolderId> folderSysRowIds)
      Posts a DocumentFilingEvent.
      Parameters:
      action - action to perform
      documentIDs - document IDs
      folderSysRowIds - folder sysrowids

    • postDocumentFilingEvent

      void postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, String folderName)
      Posts a DocumentFilingEvent.
      Parameters:
      action - action to perform.
      documentIDs - document IDs
      folderName - name for new folder

    • postChangeDocumentSecurityEvent

      void postChangeDocumentSecurityEvent(Set<DocumentId> documentIds, Set<String> acls)
      Posts a ChangeDocumentSecurityEvent.
      Parameters:
      documentIds - document ids
      acls - set of acl names

    • postChangeFolderSecurityEvent

      void postChangeFolderSecurityEvent(FolderId folderId, Set<String> aclNames)
      Posts a ChangeFolderSecurityEvent.
      Parameters:
      folderId - folder id
      aclNames - set of ACL names

    • postAddLinkEvent

      void postAddLinkEvent(String name, NavigationNode parent, FolderId destination)
      Post a AddLinkEvent.
      Parameters:
      name - Name
      parent - Parent
      destination - Destination

    • postRefreshEvent

      void postRefreshEvent()
      Posts a refresh event.

    • postUploadDocumentEvent

      void postUploadDocumentEvent(FolderUploadInfos uploadInfos)
      Posts an upload document event.
      Parameters:
      uploadInfos - infos about the upload operation

    • postUploadeExternalStorageDocumentEvent

      void postUploadeExternalStorageDocumentEvent(FolderUploadInfos uploadInfos, com.saperion.externalstorage.ExternalStorageType storageType)
      Posts an upload Sharebase document event.
      Parameters:
      uploadInfos - infos about the Sharebase upload operation
      storageType - External Storage type

    • postUploadSuccessEvent

      void postUploadSuccessEvent(FolderId folderId)
      Posts an upload success event.
      Parameters:
      folderId - id of the folder the document was filed in

    • postOpenMaskEvent

      void postOpenMaskEvent(String formName, String sysRowId)
      Post open mask event.
      Parameters:
      formName - Form name
      sysRowId - SysRowId for selection

    • postFileActionEvent

      void postFileActionEvent(Map<FolderId,String> folders, FileActionEvent.FileAction action, FolderId fileParent)
      Posts a file action event.
      Parameters:
      folders - map with ids and class names of the selected folders
      action - file item action
      fileParent - id of the parent node for the file

    • postFileActionEvent

      void postFileActionEvent(Map<FolderId,String> folders, Map<FolderId,String> masks, FileActionEvent.FileAction action, FolderId fileParent)
      Posts a file action event.
      Parameters:
      folders - map with ids and class names of the selected folders
      masks - map with ids and query mask names of the selected folders. Query mask names will override the query masks set in the classes.
      action - file item action
      fileParent - id of the parent node for the file

    • postTabSelectedEvent

      void postTabSelectedEvent(FolderId folderId, MainTabView.MTVTabType tabType, IntelligentFormView formView)
      Posts a tab selected event.
      Parameters:
      folderId - folder id
      tabType - tab type
      formView - The intelligent form contained in the selected tab.

    • postPrintDocumentEvent

      void postPrintDocumentEvent(List<ResultProperties> rows)
      Posts a print-document-event.
      Parameters:
      rows - rows selected for printing

    • postEditStructureEvent

      void postEditStructureEvent(DocumentId documentId)
      Posts an edit structure event.
      Parameters:
      documentId - ID of the document to edit

    • postExternalStorageUploadEvent

      void postExternalStorageUploadEvent(DocumentId documentId, com.saperion.externalstorage.client.ExternalStorageClient client, com.saperion.externalstorage.ExternalStorageType storageType)
      Post a External Storage Upload event
      Parameters:
      documentId -

    • postShareBaseLoginEvent

      void postShareBaseLoginEvent(DocumentId documentId)
      Post a ShareBase Login event
      Parameters:
      documentId -

    • postExternalStorageUploadStatusEvent

      void postExternalStorageUploadStatusEvent(Boolean uploadStatus, com.saperion.externalstorage.library.Document uploadedDocument, com.saperion.externalstorage.client.ExternalStorageClient externalStorageClient, com.saperion.externalstorage.ExternalStorageType storageType)
      Post a External Storage Upload status event

    • postProlongRetentionEvent

      void postProlongRetentionEvent(ResultProperties row, Date retentionDate)
      Post a prolong retention event

    • postReduceDispositionEvent

      void postReduceDispositionEvent(ResultProperties row, Date dispositionDate)
      Post a reduce disposition event

    • postSetLitigationHoldEvent

      void postSetLitigationHoldEvent(DocumentId documentId, boolean activate)
      Post a litigation hold value change event