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, IntelligentFormPopupWindow, IntelligentFormViewImpl, LogViewImpl, MainTabViewImpl, MediaViewerImpl, NavigationViewImpl, NewFolderDialog, PdfjsViewerImpl, ResultSetViewImpl, RevisionHistoryDialog, SapDocumentViewImpl, SelectFolderClassDialog, SimpleViewerImpl, UserSelectionDialog, VirtualViewerHTML5, WeblinkHandler

public interface EventChildHandler
extends LogEventChildHandler

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_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_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_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_START_WORKFLOW, ON_TAB_SELECTED, ON_UNDELETE_SELECTED, ON_UPLOAD_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

Method Summary

Modifier and Type	Method and Description
void	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	postDeleteSelectedEvent() Delete selected.
void	postDisplayPopupEvent(DocumentId docId, boolean withCtrl, boolean editMode)
void	postDisplayPopupEvent(DocumentId docId, boolean currentRevision, boolean withCtrl, boolean editMode)
void	postDisplayResultItemEvent(DocumentId selectedDocId) Calls postDisplayResultItemEvent(int, DocumentId) with all rights enabled.
void	postDisplayResultItemEvent(int maskRights, DocumentId selectedDocId)
void	postDocumentCheckEvent(CheckDataBean.CheckType checkout, DocumentId id) Checkin / checkout selected document.
void	postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, Set<FolderId> folderSysRowIds) Posts a DocumentFilingEvent.
void	postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, String folderName) Posts a DocumentFilingEvent.
void	postDocumentReleaseEvent(DocumentId id) Release selected document.
void	postDownloadResultItemEvent(List<ResultProperties> items)
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	postEditSelectedEvent(EditSelectedEvent.EditEventOrigin origin) 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	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	postFormButtonEvent(ButtonInfo info)
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	postPrintDocumentEvent(List<ResultProperties> rows) Posts a print-document-event.
void	postQueryFavoriteEvent(com.saperion.ngc.favorites.xml.Favorites favorites, boolean close) Posts an on query favorite event.
void	postRefreshEvent() Posts a refresh event.
void	postResetGuiEvent() Post reset GUI event.
void	postResultFieldEvent(ResultFieldEventBean bean)
void	postSaveDocumentEvent(ResultFieldEventBean bean)
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	postStartWorkflowEvent(List<String> documentIds)
void	postTabSelectedEvent(FolderId folderId, MainTabView.MTVTabType tabType, IntelligentFormView formView) Posts a tab selected event.
void	postUnDeleteSelectedEvent() Undelete selected.
void	postUploadDocumentEvent(FolderUploadInfos uploadInfos) Posts an upload 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)

Methods inherited from interface com.saperion.ngc.events.LogEventChildHandler

postErrorLogEvent, postErrorLogEvent, postInfoLogEvent, postInfoLogEvent, postWarningLogEvent, postWarningLogEvent

Methods inherited from interface com.saperion.ngc.events.EventChild

getEventtarget, setEventtarget

Method Detail

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

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

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

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

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