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
This interface defines common methods to post events for webclient-components.
-
Field Summary
Fields inherited from interface com.saperion.ngc.events.EventChild
ALL_EVENTS, ON_ADD_LINK, ON_ADD_LOOKUP, ON_ADD_TO_FAVORITES, ON_AFTER_QUERY, ON_BUTTON, ON_BUTTON_QUERY, ON_CANCEL, ON_CANCEL_AND, ON_CANCEL_EDIT, ON_CHANGE_DOCUMENT_SECURITY, ON_CHANGE_FOLDER_SECURITY, ON_CLEAR, ON_DELETE_SELECTED, ON_DISPLAY_POPUP, ON_DISPLAY_RESULTITEM, ON_DISPLAY_TEMPORARY_DOCUMENT, ON_DOCUMENT_ADDED, ON_DOCUMENT_CHECK, ON_DOCUMENT_FILING, ON_DOCUMENT_LOCKED, ON_DOCUMENT_PROLONG_RETENTION, ON_DOCUMENT_REDUCE_DISPOSITION, ON_DOCUMENT_RELEASE, ON_DOWNLOAD_RESULTITEM, ON_EDIT_CONTENT, ON_EDIT_FOLDER, ON_EDIT_ITEM, ON_EDIT_ITEM_SELECTED, ON_EDIT_LOOKUP, ON_EDIT_SELECTED, ON_EDIT_STRUCTURE, ON_EXPORT, ON_EXTERNAL_STORAGE_UPLOAD, ON_EXTERNAL_STORAGE_UPLOAD_STATUS, ON_FAST_ACCESS_DRAG_OVER, ON_FIELD_CHANGE, ON_FILE_ACTION, ON_FILE_PREVIEW, ON_FILE_SEARCH, ON_FORM_CREATED, ON_FORM_RENDER_ERROR, ON_FORWARD, ON_IGNORE, ON_INDEX, ON_INDEX_CLEAR, ON_INDEX_RESULTITEM, ON_ITEM_DOUBLECLICK, ON_LAUNCH_WORKFLOW, ON_LOG, ON_LOGON, ON_MACRO, ON_NAVIGATION, ON_NAVIGATION_FOLDER, ON_NAVIGATION_FORM, ON_NAVIGATION_WEBPART, ON_NEW_ITEM, ON_NEW_SELECTED, ON_OK, ON_ONEDRIVE_LOGIN, ON_OPEN_INDEX_MASK, ON_OPEN_MASK, ON_OPEN_QUERY_MASK, ON_PASSWORD_EXPIRED, ON_PRINT_DOCUMENTS, ON_QUERY, ON_QUERY_FAVORITE, ON_REFRESH, ON_REFRESH_FOLDER, ON_RESET_GUI, ON_REVISION_CREATED, ON_SAVE_AND, ON_SAVE_DOC, ON_SAVE_FOLDER, ON_SCROLL_NODE, ON_SELECT_TREE_ITEM, ON_SELECTDDC, ON_SEND_MAIL_RESULTITEM, ON_SET_LITIGATION_HOLD, ON_SHAREBASE_DOCUMENT_CHECK, ON_SHAREBASE_LOGIN, ON_START_WORKFLOW, ON_TAB_SELECTED, ON_UNDELETE_SELECTED, ON_UPLOAD_DOCUMENT, ON_UPLOAD_EXTERNAL_STORAGE_DOCUMENT, ON_UPLOAD_SUCCESS, ON_VARIABLES_AVAILABLE, ON_WF, ON_WF_COMMENT_DIALOG_CANCEL, ON_WF_COMMENT_DIALOG_OK, ON_WFCOMMENTS, ON_WFDELEGATE, ON_WFFORWARD, ON_WFFORWARD1, ON_WFFORWARD2, ON_WFFORWARD3, ON_WFFORWARD4, ON_WFFORWARD5, ON_WFHISTORY, ON_WFPUTBACK, ON_WFREMINDER, ON_WFTAKE, ON_WORKFLOW_ACTION, ON_WORKFLOW_COMMENT, ON_WORKFLOW_DISPLAY_COMMENT
-
Method Summary
Modifier and TypeMethodDescriptionvoid
postAddLinkEvent
(String name, NavigationNode parent, FolderId destination) Post a AddLinkEvent.void
postAddToFavoritesEvent
(FavoriteQueryInformation favoriteQueryInformation) Posts an add to favorites event.void
postCancelSelectedEvent
(com.saperion.ngc.iform.xml.SaveActionType action) Cancel event.void
postChangeDocumentSecurityEvent
(Set<DocumentId> documentIds, Set<String> acls) Posts a ChangeDocumentSecurityEvent.void
postChangeFolderSecurityEvent
(FolderId folderId, Set<String> aclNames) Posts a ChangeFolderSecurityEvent.void
Delete selected.void
postDisplayPopupEvent
(DocumentId docId, boolean withCtrl, boolean editMode) void
postDisplayPopupEvent
(DocumentId docId, boolean currentRevision, boolean withCtrl, boolean editMode) void
postDisplayResultItemEvent
(int maskRights, DocumentId selectedDocId) void
postDisplayResultItemEvent
(DocumentId selectedDocId) CallspostDisplayResultItemEvent(int, DocumentId)
with all rights enabled.void
postDocumentCheckEvent
(CheckDataBean.CheckType checkout, DocumentId id) Checkin / checkout selected document.void
postDocumentCheckWithShareBaseEvent
(ShareBaseCheckDataBean.ShareBaseCheckType checkType, DocumentId id, boolean isShareBaseLoggedIn) Checkin / checkout selected document from/to ShareBase.void
postDocumentFilingEvent
(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, String folderName) Posts a DocumentFilingEvent.void
postDocumentFilingEvent
(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, Set<FolderId> folderSysRowIds) Posts a DocumentFilingEvent.void
Release selected document.void
void
postEditContentEvent
(EditContentEvent.EditContentAction action, DocumentId documentId) Post edit content event.void
postEditItemSelectedEvent
(EditItemSelectedEvent.EditItemEventOrigin origin, String maskName, String ddcName, ResultProperties properties) Edit item event.void
Edit event.void
postEditSelectedEvent
(EditSelectedEvent.EditEventOrigin origin, boolean readonly) Edit event.void
postEditSelectedEvent
(EditSelectedEvent.EditEventOrigin origin, String mask, ResultProperties properties) Edit event.void
postEditStructureEvent
(DocumentId documentId) Posts an edit structure event.void
postExternalStorageUploadEvent
(DocumentId documentId, com.saperion.externalstorage.client.ExternalStorageClient client, com.saperion.externalstorage.ExternalStorageType storageType) Post a External Storage Upload eventvoid
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 eventvoid
postFieldChangeEvent
(ResultProperty property) void
postFileActionEvent
(Map<FolderId, String> folders, FileActionEvent.FileAction action, FolderId fileParent) Posts a file action event.void
postFileActionEvent
(Map<FolderId, String> folders, Map<FolderId, String> masks, FileActionEvent.FileAction action, FolderId fileParent) Posts a file action event.void
void
postIndexResultItemEvent
(ResultProperties properties, String componentId) void
postLaunchWorkflowEvent
(List<String> documentIds, String workflowName, String commentString, List<com.saperion.intf.wf.WorkflowMember> users) void
postLockDocumentEvent
(boolean lock) void
postLogonEvent
(LogonEvent.LogonResult result, String userName) void
postLogonEvent
(LogonEvent.LogonResult result, String userName, boolean bIsSSOUser) void
postNavigationFolderEvent
(FolderNode node, boolean close) void
postNavigationFormEvent
(MaskInfoBean infoBean, boolean close) void
postNavigationFormEvent
(MaskInfoBean infoBean, FolderSearchInfos infos, boolean close) void
postNavigationWebpartEvent
(String adress, String name, boolean close) void
postNewSelectedEvent
(NewSelectedEvent.NewEventOrigin origin, String maskName, String ddcName, FormMode mode) New event.void
postOpenMaskEvent
(String formName, String sysRowId) Post open mask event.void
Posts a print-document-event.void
postProlongRetentionEvent
(ResultProperties row, Date retentionDate) Post a prolong retention eventvoid
postQueryFavoriteEvent
(com.saperion.ngc.favorites.xml.Favorites favorites, boolean close) Posts an on query favorite event.void
postReduceDispositionEvent
(ResultProperties row, Date dispositionDate) Post a reduce disposition eventvoid
Posts a refresh event.void
Post reset GUI event.void
void
void
postSaveDocumentEvent
(ResultFieldEventBean bean, Set<String> acls, String comment, Map<String, DocumentVariable> variables) void
postSelectTreeItemEvent
(FolderId folderId, SelectTreeItemEvent.Destination type) void
postSendMailResultItemEvent
(MailSendType mailSendType, ResultProperties item, MailContentType mailContentType) void
postSetLitigationHoldEvent
(DocumentId documentId, boolean activate) Post a litigation hold value change eventvoid
postShareBaseLoginEvent
(DocumentId documentId) Post a ShareBase Login eventvoid
postStartWorkflowEvent
(List<String> documentIds) void
postTabSelectedEvent
(FolderId folderId, MainTabView.MTVTabType tabType, IntelligentFormView formView) Posts a tab selected event.void
Undelete selected.void
postUploadDocumentEvent
(FolderUploadInfos uploadInfos) Posts an upload document event.void
postUploadeExternalStorageDocumentEvent
(FolderUploadInfos uploadInfos, com.saperion.externalstorage.ExternalStorageType storageType) Posts an upload Sharebase document event.void
postUploadSuccessEvent
(FolderId folderId) Posts an upload success event.void
postWorkflowActionEvent
(List<DocumentId> task, com.saperion.intf.wf.CommandInfo info, List<String> actor, String commentString, Date actionDate) void
postWorkflowCommentEvent
(List<DocumentId> tasks) void
Methods inherited from interface com.saperion.ngc.events.EventChild
getEventtarget, setEventtarget
Methods inherited from interface com.saperion.ngc.events.LogEventChildHandler
postErrorLogEvent, postErrorLogEvent, postInfoLogEvent, postInfoLogEvent, postWarningLogEvent, postWarningLogEvent
-
Method Details
-
postWorkflowActionEvent
void postWorkflowActionEvent(List<DocumentId> task, com.saperion.intf.wf.CommandInfo info, List<String> actor, String commentString, Date actionDate) - Parameters:
task
- Task infoinfo
- Command infoactor
- ActorcommentString
- CommentactionDate
- Action date
-
postWorkflowCommentEvent
- Parameters:
tasks
- Task info
-
postWorkflowDisplayCommentEvent
- Parameters:
task
- Task info
-
postDisplayPopupEvent
- Parameters:
docId
- Document idwithCtrl
- With CTRLeditMode
- edit mode
-
postDisplayPopupEvent
void postDisplayPopupEvent(DocumentId docId, boolean currentRevision, boolean withCtrl, boolean editMode) - Parameters:
docId
- Document idwithCtrl
- With CTRLcurrentRevision
- currentRevisioneditMode
- edit mode
-
postDisplayResultItemEvent
- Parameters:
maskRights
- rights enabled in the maskselectedDocId
- selected item's id
-
postDisplayResultItemEvent
CallspostDisplayResultItemEvent(int, DocumentId)
with all rights enabled.- Parameters:
selectedDocId
- selected item's ID
-
postIndexResultItemEvent
- Parameters:
properties
- PropertiescomponentId
- 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'sworkflowName
- Workflow namecommentString
- Comment stringusers
- Users
-
postNewSelectedEvent
void postNewSelectedEvent(NewSelectedEvent.NewEventOrigin origin, String maskName, String ddcName, FormMode mode) New event.- Parameters:
origin
- event originmaskName
- Mask nameddcName
- DDC namemode
- Form mode
-
postEditItemSelectedEvent
void postEditItemSelectedEvent(EditItemSelectedEvent.EditItemEventOrigin origin, String maskName, String ddcName, ResultProperties properties) Edit item event.- Parameters:
origin
- event originmaskName
- Mask nameddcName
- DDC nameproperties
- Properties
-
postEditSelectedEvent
Edit event.- Parameters:
origin
- event origin
-
postEditSelectedEvent
Edit event.- Parameters:
origin
- event originreadonly
- 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 originmask
- name of the mask to useproperties
- properties of the document to edit
-
postCancelSelectedEvent
void postCancelSelectedEvent(com.saperion.ngc.iform.xml.SaveActionType action) Cancel event.- Parameters:
action
- save action
-
postResultFieldEvent
- Parameters:
bean
- Result field bean
-
postSaveDocumentEvent
- Parameters:
bean
- Result field bean
-
postSaveDocumentEvent
void postSaveDocumentEvent(ResultFieldEventBean bean, Set<String> acls, String comment, Map<String, DocumentVariable> variables) - Parameters:
bean
- Result field beanacls
- ACLs to use when saving (comma-separated string)comment
- the comment for the new revisionwvariables
- the variables to add to the document
-
postDeleteSelectedEvent
void postDeleteSelectedEvent()Delete selected. -
postUnDeleteSelectedEvent
void postUnDeleteSelectedEvent()Undelete selected. -
postDocumentCheckEvent
Checkin / checkout selected document.- Parameters:
checkout
- Checkout / checkin typeid
- Document id
-
postDocumentReleaseEvent
Release selected document.- Parameters:
id
- Document id to release
-
postFormButtonEvent
- Parameters:
info
- Button info
-
postDownloadResultItemEvent
- Parameters:
items
- items to download
-
postSendMailResultItemEvent
void postSendMailResultItemEvent(MailSendType mailSendType, ResultProperties item, MailContentType mailContentType) - Parameters:
mailSendType
- mail send typeitem
- item to send per mailmailContentType
- mail content type
-
postStartWorkflowEvent
- Parameters:
documentIds
- Document IDs
-
postFieldChangeEvent
- Parameters:
property
- Property
-
postLogonEvent
- Parameters:
result
- Logon resultuserName
- User name
-
postLogonEvent
- Parameters:
result
- Logon resultuserName
- User namebIsSSOUser
- indicate SSOUser
-
postResetGuiEvent
void postResetGuiEvent()Post reset GUI event. -
postEditContentEvent
Post edit content event.- Parameters:
action
- edit actiondocumentId
- document id
-
postAddToFavoritesEvent
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
-
postChangeDocumentSecurityEvent
Posts a ChangeDocumentSecurityEvent.- Parameters:
documentIds
- document idsacls
- set of acl names
-
postChangeFolderSecurityEvent
Posts a ChangeFolderSecurityEvent.- Parameters:
folderId
- folder idaclNames
- set of ACL names
-
postRefreshEvent
void postRefreshEvent()Posts a refresh event. -
postUploadSuccessEvent
Posts an upload success event.- Parameters:
folderId
- id of the folder the document was filed in
-
postOpenMaskEvent
Post open mask event.- Parameters:
formName
- Form namesysRowId
- 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 foldersaction
- file item actionfileParent
- 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 foldersmasks
- 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 actionfileParent
- 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 idtabType
- tab typeformView
- The intelligent form contained in the selected tab.
-
postPrintDocumentEvent
Posts a print-document-event.- Parameters:
rows
- rows selected for printing
-
postEditStructureEvent
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
-
-
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
Post a prolong retention event -
postReduceDispositionEvent
Post a reduce disposition event -
postSetLitigationHoldEvent
Post a litigation hold value change event
-