Uses of Class
com.saperion.ngc.model.document.DocumentId
Packages that use DocumentId
Package
Description
Package for client dialog classes.
Package for all ZK events.
Package for iform events.
Package for all navigation events.
Package for all resultset events.
Package for main iForm components.
Package for iForm image elements.
Package for mailing.
Package for model classes.
Package for document model classes.
Package for navigation model classes.
Package for resultset model classes.
Package for portal classes.
Package for resultset component classes.
Package for standalone SAP viewer.
Package for Server-Script utility/helper classes.
Package for internal classes of Server-Script utility/helper classes.
Package for streaming servlet.
Package for client utility classes.
Package for viewer component classes.
Package for PDFJS-viewer component classes.
Package for simple viewer component classes.
Package for virtual viewer component classes.
Package for virtual viewer HTML5 component classes.
-
Uses of DocumentId in com.saperion.ngc.dialogs
Methods in com.saperion.ngc.dialogs that return DocumentIdModifier and TypeMethodDescriptionEditStructureDialog.getDocumentId()
RevisionHistoryDialog.RevisionBean.getDocumentId()
Methods in com.saperion.ngc.dialogs with parameters of type DocumentIdModifier and TypeMethodDescriptionRevisionHistoryDialog.RevisionListModel.create
(ResultSetPresenter resultPresenter, ResultSetViewImpl view, DocumentId docId, String maskName) Factory method.void
EditStructureDialog.setDocumentId
(DocumentId documentId) static void
EditStructureDialog.show
(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentPages, BaseWindow parent, org.zkoss.zk.ui.event.EventListener eventListener, boolean commentEnabled, String defaultComment) Shows the EditStructureDialog.static void
RevisionHistoryDialog.show
(ResultSetPresenter resultPresenter, ResultSetViewImpl view, DocumentId docId, String maskName) Shows the revision history.Constructors in com.saperion.ngc.dialogs with parameters of type DocumentIdModifierConstructorDescriptionRevisionBean
(DocumentVersionInfo info, DocumentId docId, String aMaskName, boolean userAllowedToView) Creates a new RevisionBean.RevisionListModel
(List<String> versionIds, ResultSetPresenter resultPresenter, DocumentId documentId, String maskName, ResultSetViewImpl resultView, boolean historyAllowed) Constructor. -
Uses of DocumentId in com.saperion.ngc.dialogs.onedrive.dialog
Methods in com.saperion.ngc.dialogs.onedrive.dialog with parameters of type DocumentIdModifier and TypeMethodDescriptionstatic void
OneDriveLoginDialog.show
(DocumentId documentId, org.zkoss.zk.ui.event.EventListener listener, BaseWindow parent) Shows OneDrive Login Dialog if user is not logged and wants to perform any operations related to a Saperion document in OneDrive. -
Uses of DocumentId in com.saperion.ngc.dialogs.onedrive.model
Methods in com.saperion.ngc.dialogs.onedrive.model that return DocumentIdMethods in com.saperion.ngc.dialogs.onedrive.model with parameters of type DocumentId -
Uses of DocumentId in com.saperion.ngc.events
Methods in com.saperion.ngc.events that return DocumentIdModifier and TypeMethodDescriptionArchiverSuccessEvent.getDocumentId()
final DocumentId
CheckDataBean.getDocumentId()
DisplayPopupEvent.getDocumentId()
final DocumentId
ShareBaseCheckDataBean.getDocumentId()
final DocumentId
WorkflowDisplayCommentEvent.getTaskId()
Methods in com.saperion.ngc.events that return types with arguments of type DocumentIdModifier and TypeMethodDescriptionfinal List<DocumentId>
WorkflowActionEvent.getTaskIds()
final List<DocumentId>
WorkflowCommentEvent.getTaskIds()
Methods in com.saperion.ngc.events with parameters of type DocumentIdModifier and TypeMethodDescriptionvoid
BaseWindow.postDisplayPopupEvent
(DocumentId docId, boolean withCtrl, boolean editMode) void
BaseWindow.postDisplayPopupEvent
(DocumentId docId, boolean currentRevision, boolean withCtrl, boolean editMode) void
EventChildHandler.postDisplayPopupEvent
(DocumentId docId, boolean withCtrl, boolean editMode) void
EventChildHandler.postDisplayPopupEvent
(DocumentId docId, boolean currentRevision, boolean withCtrl, boolean editMode) void
EventChildHandlerImpl.postDisplayPopupEvent
(DocumentId docId, boolean withCtrl, boolean editMode) void
EventChildHandlerImpl.postDisplayPopupEvent
(DocumentId docId, boolean currentRevision, boolean withCtrl, boolean editMode) void
BaseWindow.postDisplayResultItemEvent
(int maskRights, DocumentId selectedDocId) void
BaseWindow.postDisplayResultItemEvent
(DocumentId selectedDocId) CallsEventChildHandler.postDisplayResultItemEvent(int, DocumentId)
with all rights enabled.void
EventChildHandler.postDisplayResultItemEvent
(int maskRights, DocumentId selectedDocId) void
EventChildHandler.postDisplayResultItemEvent
(DocumentId selectedDocId) CallsEventChildHandler.postDisplayResultItemEvent(int, DocumentId)
with all rights enabled.void
EventChildHandlerImpl.postDisplayResultItemEvent
(int maskRights, DocumentId selectedDocId) void
EventChildHandlerImpl.postDisplayResultItemEvent
(DocumentId selectedDocId) CallsEventChildHandler.postDisplayResultItemEvent(int, DocumentId)
with all rights enabled.void
BaseWindow.postDocumentCheckEvent
(CheckDataBean.CheckType checkout, DocumentId id) Checkin / checkout selected document.void
EventChildHandler.postDocumentCheckEvent
(CheckDataBean.CheckType checkout, DocumentId id) Checkin / checkout selected document.void
EventChildHandlerImpl.postDocumentCheckEvent
(CheckDataBean.CheckType checkout, DocumentId id) Checkin / checkout selected document.void
BaseWindow.postDocumentCheckWithShareBaseEvent
(ShareBaseCheckDataBean.ShareBaseCheckType checkType, DocumentId id, boolean isShareBaseLoggedIn) Checkin / checkout selected document from/to ShareBase.void
EventChildHandler.postDocumentCheckWithShareBaseEvent
(ShareBaseCheckDataBean.ShareBaseCheckType checkType, DocumentId id, boolean isShareBaseLoggedIn) Checkin / checkout selected document from/to ShareBase.void
EventChildHandlerImpl.postDocumentCheckWithShareBaseEvent
(ShareBaseCheckDataBean.ShareBaseCheckType checkType, DocumentId id, boolean isShareBaseLoggedIn) Checkin / checkout selected document from/to ShareBase.void
BaseWindow.postDocumentReleaseEvent
(DocumentId id) Release selected document.void
EventChildHandler.postDocumentReleaseEvent
(DocumentId id) Release selected document.void
EventChildHandlerImpl.postDocumentReleaseEvent
(DocumentId id) Release selected document.void
BaseWindow.postEditContentEvent
(EditContentEvent.EditContentAction action, DocumentId documentId) Post edit content event.void
EventChildHandler.postEditContentEvent
(EditContentEvent.EditContentAction action, DocumentId documentId) Post edit content event.void
EventChildHandlerImpl.postEditContentEvent
(EditContentEvent.EditContentAction action, DocumentId documentId) Post edit content event.void
BaseWindow.postEditStructureEvent
(DocumentId documentId) Posts an edit structure event.void
EventChildHandler.postEditStructureEvent
(DocumentId documentId) Posts an edit structure event.void
EventChildHandlerImpl.postEditStructureEvent
(DocumentId documentId) Posts an edit structure event.void
BaseWindow.postExternalStorageUploadEvent
(DocumentId documentId, com.saperion.externalstorage.client.ExternalStorageClient client, com.saperion.externalstorage.ExternalStorageType storageType) void
EventChildHandler.postExternalStorageUploadEvent
(DocumentId documentId, com.saperion.externalstorage.client.ExternalStorageClient client, com.saperion.externalstorage.ExternalStorageType storageType) Post a External Storage Upload eventvoid
EventChildHandlerImpl.postExternalStorageUploadEvent
(DocumentId documentId, com.saperion.externalstorage.client.ExternalStorageClient client, com.saperion.externalstorage.ExternalStorageType storageType) void
BaseWindow.postSetLitigationHoldEvent
(DocumentId documentId, boolean activate) void
EventChildHandler.postSetLitigationHoldEvent
(DocumentId documentId, boolean activate) Post a litigation hold value change eventvoid
EventChildHandlerImpl.postSetLitigationHoldEvent
(DocumentId documentId, boolean activate) void
BaseWindow.postShareBaseLoginEvent
(DocumentId documentId) void
EventChildHandler.postShareBaseLoginEvent
(DocumentId documentId) Post a ShareBase Login eventvoid
EventChildHandlerImpl.postShareBaseLoginEvent
(DocumentId documentId) void
BaseWindow.postWorkflowDisplayCommentEvent
(DocumentId task) void
EventChildHandler.postWorkflowDisplayCommentEvent
(DocumentId task) void
EventChildHandlerImpl.postWorkflowDisplayCommentEvent
(DocumentId task) Method parameters in com.saperion.ngc.events with type arguments of type DocumentIdModifier and TypeMethodDescriptionvoid
BaseWindow.postChangeDocumentSecurityEvent
(Set<DocumentId> documentIds, Set<String> acls) Posts a ChangeDocumentSecurityEvent.void
EventChildHandler.postChangeDocumentSecurityEvent
(Set<DocumentId> documentIds, Set<String> acls) Posts a ChangeDocumentSecurityEvent.void
EventChildHandlerImpl.postChangeDocumentSecurityEvent
(Set<DocumentId> documentIs, Set<String> acls) Posts a ChangeDocumentSecurityEvent.void
BaseWindow.postDocumentFilingEvent
(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, String folderName) Posts a DocumentFilingEvent.void
BaseWindow.postDocumentFilingEvent
(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, Set<FolderId> folderSysRowIds) Posts a DocumentFilingEvent.void
EventChildHandler.postDocumentFilingEvent
(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, String folderName) Posts a DocumentFilingEvent.void
EventChildHandler.postDocumentFilingEvent
(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, Set<FolderId> folderSysRowIds) Posts a DocumentFilingEvent.void
EventChildHandlerImpl.postDocumentFilingEvent
(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, String folderName) Posts a DocumentFilingEvent.void
EventChildHandlerImpl.postDocumentFilingEvent
(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, Set<FolderId> folderSysRowIds) Posts a DocumentFilingEvent.void
BaseWindow.postWorkflowActionEvent
(List<DocumentId> tasks, com.saperion.intf.wf.CommandInfo info, List<String> actors, String commentString, Date actionDate) void
EventChildHandler.postWorkflowActionEvent
(List<DocumentId> task, com.saperion.intf.wf.CommandInfo info, List<String> actor, String commentString, Date actionDate) void
EventChildHandlerImpl.postWorkflowActionEvent
(List<DocumentId> tasks, com.saperion.intf.wf.CommandInfo info, List<String> actors, String commentString, Date actionDate) void
BaseWindow.postWorkflowCommentEvent
(List<DocumentId> tasks) void
EventChildHandler.postWorkflowCommentEvent
(List<DocumentId> tasks) void
EventChildHandlerImpl.postWorkflowCommentEvent
(List<DocumentId> tasks) Constructors in com.saperion.ngc.events with parameters of type DocumentIdModifierConstructorDescriptionArchiverSuccessEvent
(org.zkoss.zk.ui.Component target, List<FieldResultBean> fieldValues, DocumentId documentId) CheckDataBean
(CheckDataBean.CheckType type, DocumentId id) Constructor.DisplayPopupEvent
(org.zkoss.zk.ui.Component target, DocumentId id, boolean isWithCtrl, boolean editMode) Constructor.DisplayPopupEvent
(org.zkoss.zk.ui.Component target, DocumentId id, boolean currentRevision, boolean isWithCtrl, boolean editMode) Constructor.Constructor.WorkflowDisplayCommentEvent
(org.zkoss.zk.ui.Component target, DocumentId taskId) Constructor.Constructor parameters in com.saperion.ngc.events with type arguments of type DocumentIdModifierConstructorDescriptionWorkflowActionEvent
(org.zkoss.zk.ui.Component target, List<DocumentId> taskIds, com.saperion.intf.wf.CommandInfo commandInfo, List<String> nextUsers, String comment, Date date) Constructor.WorkflowCommentEvent
(org.zkoss.zk.ui.Component target, List<DocumentId> taskIds) Constructor. -
Uses of DocumentId in com.saperion.ngc.events.iform
Methods in com.saperion.ngc.events.iform that return DocumentIdModifier and TypeMethodDescriptionDocumentAddedEvent.getDocumentId()
Gets the document id.RevisionCreatedEvent.getDocumentId()
Constructors in com.saperion.ngc.events.iform with parameters of type DocumentIdModifierConstructorDescriptionDocumentAddedEvent
(org.zkoss.zk.ui.Component target, DocumentId id, List<FieldResultBean> fields) Constructor.RevisionCreatedEvent
(org.zkoss.zk.ui.Component target, DocumentId docId, List<FieldResultBean> fields, boolean lookupRevision) Constructor. -
Uses of DocumentId in com.saperion.ngc.events.resultset
Methods in com.saperion.ngc.events.resultset that return DocumentIdModifier and TypeMethodDescriptionDisplayResultItemEvent.getDocumentId()
EditContentEvent.getDocumentId()
EditStructureEvent.getDocumentId()
ExternalStorageUploadEvent.getDocumentId()
OneDriveLoginEvent.getDocumentId()
ShareBaseLoginEvent.getDocumentId()
DocumentCheckEvent.getId()
DocumentCheckWithShareBaseEvent.getId()
DocumentReleaseEvent.getId()
LitigationHoldEvent.getId()
Methods in com.saperion.ngc.events.resultset that return types with arguments of type DocumentIdConstructors in com.saperion.ngc.events.resultset with parameters of type DocumentIdModifierConstructorDescriptionDisplayResultItemEvent
(org.zkoss.zk.ui.Component target, int maskRights, DocumentId documentId) Constructor.DisplayResultItemEvent
(org.zkoss.zk.ui.Component target, int maskRights, DocumentId documentId, boolean currentRevision) Constructor.DisplayResultItemEvent
(org.zkoss.zk.ui.Component target, DocumentId documentId) Constructor.DisplayResultItemEvent
(org.zkoss.zk.ui.Component target, DocumentId documentId, boolean currentRevision) Constructor.DocumentCheckEvent
(org.zkoss.zk.ui.Component target, CheckDataBean.CheckType checkType, DocumentId id) Constructor.DocumentCheckWithShareBaseEvent
(org.zkoss.zk.ui.Component target, ShareBaseCheckDataBean.ShareBaseCheckType checkType, DocumentId id) DocumentReleaseEvent
(org.zkoss.zk.ui.Component target, DocumentId id) Constructor.EditContentEvent
(org.zkoss.zk.ui.Component target, EditContentEvent.EditContentAction editAction, DocumentId documentId) Constructor.EditStructureEvent
(org.zkoss.zk.ui.Component target, DocumentId documentId) ExternalStorageUploadEvent
(org.zkoss.zk.ui.Component target, DocumentId documentId, com.saperion.externalstorage.client.ExternalStorageClient client, com.saperion.externalstorage.ExternalStorageType storageType) LitigationHoldEvent
(org.zkoss.zk.ui.Component target, DocumentId id, boolean activate) Constructor.OneDriveLoginEvent
(org.zkoss.zk.ui.Component target, DocumentId documentId) ShareBaseLoginEvent
(org.zkoss.zk.ui.Component target, DocumentId documentId) Constructor parameters in com.saperion.ngc.events.resultset with type arguments of type DocumentIdModifierConstructorDescriptionChangeDocumentSecurityEvent
(org.zkoss.zk.ui.Component target, Set<DocumentId> documentIds, Set<String> aclNames) Creates a new ChangeDocumentSecurity event. -
Uses of DocumentId in com.saperion.ngc.iform
Methods in com.saperion.ngc.iform that return DocumentIdModifier and TypeMethodDescriptionIntelligentFormPresenter.addDocument
(List<FieldResultBean> properties, String comment, FolderUploadInfos infos, String ddcName) Adds a new document to the archive.IndexMaskDocument.getDocumentId()
Returns the ID of the document if the document was already archived.Methods in com.saperion.ngc.iform with parameters of type DocumentIdModifier and TypeMethodDescriptionIntelligentFormPresenter.getArchiveMetaInfo
(DocumentId id, boolean currentRevision) Retrieves the meta information of the document from the archive.IntelligentFormPresenter.getDocProperties
(DocumentId id) Reads the properties for the given document. -
Uses of DocumentId in com.saperion.ngc.iform.image
Methods in com.saperion.ngc.iform.image with parameters of type DocumentIdModifier and TypeMethodDescriptionvoid
FormEditableImage.showImageById
(DocumentId documentId) Shows the thumbnail associated to the specified document. -
Uses of DocumentId in com.saperion.ngc.mail
Methods in com.saperion.ngc.mail with parameters of type DocumentIdModifier and TypeMethodDescriptionstatic String
MailUtil.createDocumentZipLink
(DocumentId documentId, jakarta.servlet.http.HttpServletRequest request, String filename, String baseUrl, long timeout, String tenant) Creates a weblink to all files of the given document as ZIP.MailUtil.getElementInfos
(DocumentId documentId) Gets a list of information for the elements of the given document.MailUtil.getSourceFormats
(DocumentId documentId) Returns a map with theSourceFormat
s of the elements of the document identified by the specified ID. -
Uses of DocumentId in com.saperion.ngc.model
Methods in com.saperion.ngc.model that return DocumentIdModifier and TypeMethodDescriptionSettingsClassicConnectorService.fixRevId
(DocumentId id, boolean force) Fix the revision id, if it's empty.SettingsService.fixRevId
(DocumentId id, boolean force) Fix the revision id, if it's empty.Methods in com.saperion.ngc.model with parameters of type DocumentIdModifier and TypeMethodDescriptionSettingsClassicConnectorService.fixRevId
(DocumentId id, boolean force) Fix the revision id, if it's empty.SettingsService.fixRevId
(DocumentId id, boolean force) Fix the revision id, if it's empty. -
Uses of DocumentId in com.saperion.ngc.model.document
Methods in com.saperion.ngc.model.document that return DocumentIdModifier and TypeMethodDescriptionfinal DocumentId
DocClassicConnectorService.addDocument
(List<FieldResultBean> properties, com.saperion.rmi.SaContentStream[] content, String comment, String ddcName, String acls) Adds a new document to the archive.DocClassicConnectorService.addDocument
(List<FieldResultBean> properties, com.saperion.rmi.SaContentStream[] content, String comment, String ddcName, String acls, Map<String, DocumentVariable> variables) Adds a new document to the archive.DocClassicConnectorService.addDocument
(Map<String, Object> properties, com.saperion.bean.ContentStream[] content, String comment, String ddcName, String acls, Map<String, DocumentVariable> variables) Adds a new document to the archive.final DocumentId
DocClassicConnectorService.addDocument
(Properties properties, com.saperion.rmi.SaContentStream[] content, String comment, String ddcName, String acls) Deprecated.DocumentService.addDocument
(List<FieldResultBean> properties, com.saperion.rmi.SaContentStream[] content, String comment, String ddcName, String acls) Adds a new document to the archive.DocumentService.addDocument
(List<FieldResultBean> properties, com.saperion.rmi.SaContentStream[] content, String comment, String ddcName, String acls, Map<String, DocumentVariable> variables) Adds a new document to the archive.DocumentService.addDocument
(Map<String, Object> properties, com.saperion.bean.ContentStream[] content, String comment, String ddcName, String acls, Map<String, DocumentVariable> variables) Adds a new document to the archive.DocumentService.addDocument
(Properties properties, com.saperion.rmi.SaContentStream[] content, String comment, String ddcName, String acls) Deprecated.final DocumentId
DocClassicConnectorService.createLookupItem
(List<FieldResultBean> properties, String ddcName) Create a new lookup entry.DocumentService.createLookupItem
(List<FieldResultBean> properties, String ddcName) Create a new lookup entry.static DocumentId
DocumentId.fromString
(String idAsString) Creates a new DocumentId based on the specified string.DocClassicConnectorService.updateDocument
(DocumentId docId, DataToUpdate data, UpdateSettings settings) Updates the document identfied by docId using the specified data and settings.DocumentService.updateDocument
(DocumentId docId, DataToUpdate data, UpdateSettings settings) Updates the document identfied by docId using the specified data and settings.Methods in com.saperion.ngc.model.document that return types with arguments of type DocumentIdModifier and TypeMethodDescriptionDocClassicConnectorService.getSessionLocks()
Returns a set of document IDs that are locked by this session.DocumentService.getSessionLocks()
Returns a set of document IDs that are locked by this session.Methods in com.saperion.ngc.model.document with parameters of type DocumentIdModifier and TypeMethodDescriptionvoid
DocClassicConnectorService.checkoutDocument
(DocumentId id) Checkout a document.void
DocClassicConnectorService.checkoutDocument
(DocumentId id, boolean withShareBase, int[] shareBaseDocIds) Checkout a document.void
DocumentService.checkoutDocument
(DocumentId id) Checkout a document.void
DocumentService.checkoutDocument
(DocumentId id, boolean withShareBase, int[] shareBaseDocIds) Checkout a document.final boolean
DocClassicConnectorService.deleteDocument
(DocumentId id) Delete a document.boolean
DocClassicConnectorService.deleteDocument
(DocumentId id, boolean finalDelete) Delete a document.boolean
DocumentService.deleteDocument
(DocumentId id) Delete a document.boolean
DocumentService.deleteDocument
(DocumentId id, boolean finalDelete) Delete a document.void
DocClassicConnectorService.discardCheckout
(DocumentId id) Discards checkout of a document.void
DocumentService.discardCheckout
(DocumentId id) Discards checkout of a document.DocClassicConnectorService.getAccessData
(DocumentId id) Retrieves the access data for the specified document.DocumentService.getAccessData
(DocumentId id) Retrieves the access data for the specified document.DocClassicConnectorService.getAcl
(DocumentId docId) Deprecated.useDocClassicConnectorService.getAclNames(DocumentId)
instead.DocumentService.getAcl
(DocumentId id) Deprecated.useDocumentService.getAclNames(DocumentId)
instead.DocClassicConnectorService.getAclNames
(DocumentId id) DocumentService.getAclNames
(DocumentId id) Retrieves the ACLs for the specified document or lookup entry.org.zkoss.image.Image
DocClassicConnectorService.getActualImage
(DocumentId id) Reads the actual document image from backend.org.zkoss.image.Image
DocumentService.getActualImage
(DocumentId id) Reads the actual document image from backend.DocClassicConnectorService.getArchiveMetaInfo
(DocumentId documentId, boolean currentRevision) Retrieves the meta information of a document that is stored on the archive.DocClassicConnectorService.getArchiveMetaInfo
(DocumentId documentId, boolean currentRevision, boolean previewMode) Retrieves the meta information of a document that is stored on the archive.DocumentService.getArchiveMetaInfo
(DocumentId documentId, boolean currentRevision) Retrieves the meta information of a document that is stored on the archive.DocumentService.getArchiveMetaInfo
(DocumentId documentId, boolean currentRevision, boolean previewMode) Retrieves the meta information of a document that is stored on the archive.DocClassicConnectorService.getDocumentInfo
(DocumentId id) Reads the document properties.DocClassicConnectorService.getDocumentInfo
(DocumentId id, boolean isDeleted) Reads the document properties.DocumentService.getDocumentInfo
(DocumentId id) Reads the document properties.DocumentService.getDocumentInfo
(DocumentId id, boolean isDeleted) Reads the document properties.com.saperion.intf.SaPropertyValue[]
DocClassicConnectorService.getDocumentMetadataFromArchive
(DocumentId id, boolean currentRevision) Returns the metadata of the document as read from the archive.com.saperion.intf.SaPropertyValue[]
DocumentService.getDocumentMetadataFromArchive
(DocumentId id, boolean currentRevision) Returns the metadata of the document as read from the archive.DocClassicConnectorService.getDocumentVersionIds
(DocumentId id) Returns a list of all version IDs for the specified document.DocumentService.getDocumentVersionIds
(DocumentId id) Returns a list of all version IDs for the specified document.DocClassicConnectorService.getDocumentVersions
(DocumentId id) Retrieves information about a document's versions.DocumentService.getDocumentVersions
(DocumentId id) Retrieves information about a document's versions.DocClassicConnectorService.getImageInfo
(DocumentId id) Reads the document image informations from backend.DocumentService.getImageInfo
(DocumentId id) Reads the document image informations from backend.DocClassicConnectorService.getLockData
(DocumentId id) Returns the lock data for the specified document.DocClassicConnectorService.getLockData
(DocumentId id, boolean isDeleted) Returns the lock data for the specified document.DocumentService.getLockData
(DocumentId id) Returns the lock data for the specified document.DocumentService.getLockData
(DocumentId id, boolean isDeleted) Returns the lock data for the specified document.DocClassicConnectorService.getLookupEntryAccessData
(DocumentId id) DocumentService.getLookupEntryAccessData
(DocumentId id) Retrieves the access data for the specified lookup table entry.List<com.saperion.connector.renditions.Rendition>
DocClassicConnectorService.getRenderedDocument
(DocumentId documentId, com.saperion.connector.formats.TargetFormat format, boolean currentRevision) Renders the specified document to the target format.List<com.saperion.connector.renditions.Rendition>
DocumentService.getRenderedDocument
(DocumentId documentId, com.saperion.connector.formats.TargetFormat format, boolean currentRevision) Renders the specified document to the target format.DocClassicConnectorService.getRevisionInfo
(DocumentId id) Reads the properties of the specified revision.DocumentService.getRevisionInfo
(DocumentId id) Reads the properties of the specified revision.DocClassicConnectorService.getThumbnail
(DocumentId id, int height, int width, boolean color) Retrieves a thumbnail for the specified document or null if no thumbnail is available.DocumentService.getThumbnail
(DocumentId id, int height, int width, boolean color) Retrieves a thumbnail for the specified document or null if no thumbnail is available.boolean
DocClassicConnectorService.hasBlackmarkers
(DocumentId docId) Checks for blackmarkers.boolean
DocumentService.hasBlackmarkers
(DocumentId docId) Checks for blackmarkers.final boolean
DocClassicConnectorService.lockDocument
(DocumentId id, DocumentService.AuditEvent event) Lock document.boolean
DocumentService.lockDocument
(DocumentId id, DocumentService.AuditEvent event) Lock document.void
DocClassicConnectorService.releaseDocument
(DocumentId id, String comment) Release a document.void
DocumentService.releaseDocument
(DocumentId id, String comment) Release a document.final void
DocClassicConnectorService.removeIXOSAnno
(DocumentId docId) Remove the IXOS annotation from content list.void
DocumentService.removeIXOSAnno
(DocumentId docId) Remove the IXOS annotation from content list.void
DocClassicConnectorService.setAcl
(DocumentId docId, String acl, String comment) Deprecated.void
DocumentService.setAcl
(DocumentId id, String acl, String comment) Deprecated.void
DocClassicConnectorService.setAclNames
(DocumentId id, List<String> acls, String comment) void
DocumentService.setAclNames
(DocumentId id, List<String> acls, String comment) Sets the ACL for the specified document or lookup table entry.void
DocClassicConnectorService.setDocumentRead
(DocumentId id) Sets the specified document's state to 'read' without creating a new revision.void
DocumentService.setDocumentRead
(DocumentId id) Sets the specified document's state to 'read' without creating a new revision.void
DocClassicConnectorService.setDocumentUnread
(DocumentId id) Sets the specified document's state to 'unread' without creating a new revision.void
DocumentService.setDocumentUnread
(DocumentId id) Sets the specified document's state to 'unread' without creating a new revision.final boolean
DocClassicConnectorService.unlockDocument
(DocumentId id) Unlock document.boolean
DocumentService.unlockDocument
(DocumentId id) Unlock document.DocClassicConnectorService.updateDocument
(DocumentId docId, DataToUpdate data, UpdateSettings settings) Updates the document identfied by docId using the specified data and settings.final com.saperion.intf.SaSaveInfo
DocClassicConnectorService.updateDocument
(List<FieldResultBean> properties, com.saperion.bean.ContentStream[] content, String comment, DocumentId docId, boolean checkin, boolean lookup, int selectedImage) Deprecated.final com.saperion.intf.SaSaveInfo
DocClassicConnectorService.updateDocument
(Properties properties, com.saperion.bean.ContentStream[] content, String comment, DocumentId docId, boolean checkin, boolean lookup, int selectedImage) Deprecated.DocumentService.updateDocument
(DocumentId docId, DataToUpdate data, UpdateSettings settings) Updates the document identfied by docId using the specified data and settings.com.saperion.intf.SaSaveInfo
DocumentService.updateDocument
(List<FieldResultBean> properties, com.saperion.bean.ContentStream[] content, String comment, DocumentId docId, boolean checkin, boolean lookup, int selectedImage) Deprecated.com.saperion.intf.SaSaveInfo
DocumentService.updateDocument
(Properties properties, com.saperion.bean.ContentStream[] content, String comment, DocumentId docId, boolean checkin, boolean lookup, int selectedImage) Deprecated.Method parameters in com.saperion.ngc.model.document with type arguments of type DocumentIdModifier and TypeMethodDescriptionDocumentId.convertToObjectIdList
(Collection<DocumentId> list) Converts to a list of object id's.DocumentId.convertToRevisionIdList
(Collection<DocumentId> list) /**Converts to a list of revision id's. -
Uses of DocumentId in com.saperion.ngc.model.resultset
Methods in com.saperion.ngc.model.resultset that return DocumentIdModifier and TypeMethodDescriptionResultProperties.getAttachmentId()
Returns a DocumentId containing the ID of the attachment of a task represented by this result.ResultProperties.getDocumentId()
Returns a new DocumentId containing the object ID of the document represented by this result.Methods in com.saperion.ngc.model.resultset with parameters of type DocumentIdModifier and TypeMethodDescriptionQueryClassicConnectorService.getResultForId
(DocumentId id) Returns the ResultProperties contained in the result list of the last search with the specified id.QueryService.getResultForId
(DocumentId id) Returns the ResultProperties contained in the result list of the last search with the specified id.QueryClassicConnectorService.getResultPropertiesForRevision
(DocumentId id) Returns the ResultProperties contained in the result list of the last search with the specified revisionId.QueryService.getResultPropertiesForRevision
(DocumentId id) Returns the ResultProperties contained in the result list of the last search with the specified revisionId. -
Uses of DocumentId in com.saperion.ngc.portal.builder.weblink
Methods in com.saperion.ngc.portal.builder.weblink with parameters of type DocumentIdModifier and TypeMethodDescriptionstatic ElementBuilder
WeblinkHandler.with
(DocumentId documentId, jakarta.servlet.http.HttpServletRequest request) Static Weblink constructor used by SAP Viewer. -
Uses of DocumentId in com.saperion.ngc.resultset
Methods in com.saperion.ngc.resultset that return DocumentIdModifier and TypeMethodDescriptionResultSetPresenter.fixVersion
(DocumentId documentId) Fill value for revision ID in document ID if not set.DraggableListItem.getAttachmentId()
ResultListItem.getAttachmentId()
If this is a workflow-item, this method returns the ID of the attached document.DraggableListItem.getDocumentId()
ResultListItem.getDocumentId()
Returns the ID that identifies the document represented by this ResultListItem.Methods in com.saperion.ngc.resultset that return types with arguments of type DocumentIdModifier and TypeMethodDescriptionResultSetView.getSelectedIds()
Returns the IDs of the selected documents.ResultSetViewImpl.getSelectedIds()
Returns the IDs of the selected documents.Methods in com.saperion.ngc.resultset with parameters of type DocumentIdModifier and TypeMethodDescriptionItemAnalyzer.analyzeItem
(ResultProperties props, DocumentId docId) Analyze the item.boolean
ResultSetPresenter.doDeleteDocument
(DocumentId id) Delete document.boolean
ResultSetPresenter.doDeleteDocument
(DocumentId id, boolean finalDelete) Delete document.void
ResultSetPresenter.editStructure
(DocumentId documentId) Shows the dialog to edit a document's structure.void
ResultSetPresenter.externalStorageUpload
(DocumentId documentId, com.saperion.externalstorage.client.ExternalStorageClient client, com.saperion.externalstorage.ExternalStorageType storageType) Upload a saperion document to ShareBaseResultSetPresenter.fixVersion
(DocumentId documentId) Fill value for revision ID in document ID if not set.ResultSetPresenter.getAclNames
(DocumentId documentId) Returns the ACLs of a document.ResultSetPresenter.getDocProperties
(DocumentId id) Reads the properties for the given document.ResultSetPresenter.getDocProperties
(DocumentId id, boolean isDeleted) Reads the properties for the given document.ResultSetPresenter.getDocumentFolders
(DocumentId documentId) Retrieves the folders that contain the specified document.ResultSetPresenter.getDocumentInfoFromArchive
(DocumentId id, boolean currentRevision) ResultSetPresenter.getDocumentPages
(DocumentId id, boolean currentRevision) Returns the amount of pages for the specified document.ResultSetPresenter.getDocumentVersionIDs
(DocumentId id) Returns the version IDs for the specified document.ResultSetPresenter.getDocumentVersions
(DocumentId id) Retrieves the version information for a document.ResultSetViewImpl.getDocumentVersions
(DocumentId id) static com.saperion.ngc.resultset.ResultSetEventListenerFactory.EditStructureEventListener
ResultSetEventListenerFactory.getEditStructureEventListener
(ResultSetView resultSetView, ResultSetPresenter presenter, boolean commentDialogEnabled, String defaultComment, DocumentId documentId, Integer originalPageCnt) static com.saperion.ngc.resultset.ResultSetEventListenerFactory.ExternalStorageStructureElementUploadEventListener
ResultSetEventListenerFactory.getExternalStorageStructureUploadEventListener
(DocumentViewImpl documentView, DocumentViewPresenter presenter, DocumentId documentId, com.saperion.externalstorage.client.ExternalStorageClient client, com.saperion.externalstorage.ExternalStorageType storageType, int elementNo) static com.saperion.ngc.resultset.ResultSetEventListenerFactory.ExternalStorageUploadEventListener
ResultSetEventListenerFactory.getExternalStorageUploadEventListener
(ResultSetView resultSetView, ResultSetPresenter presenter, DocumentId documentId, com.saperion.externalstorage.client.ExternalStorageClient client, com.saperion.externalstorage.ExternalStorageType storageType) static com.saperion.ngc.resultset.ResultSetEventListenerFactory.OneDriveLoginEventListener
ResultSetEventListenerFactory.getOneDriveLoginEventListener
(ResultSetView resultSetView, ResultSetPresenter presenter, DocumentId documentId) static com.saperion.ngc.resultset.ResultSetEventListenerFactory.ShareBaseLoginEventListener
ResultSetEventListenerFactory.getShareBaseLoginEventListener
(ResultSetView resultSetView, ResultSetPresenter presenter, DocumentId documentId) static com.saperion.ngc.resultset.ResultSetEventListenerFactory.ShareBaseStructureElementLoginEventListener
ResultSetEventListenerFactory.getShareBaseStructureElementLoginEventListener
(DocumentViewImpl documentView, DocumentViewPresenter presenter, DocumentId documentId, int elementNo) boolean
ResultSetPresenter.isAllowedToViewHistory
(DocumentId docId) boolean
ResultSetPresenter.isLockedForEditing
(DocumentId id) Checks if the document with the specified ID is locked for editing in this result set.void
ResultSetPresenter.oneDriveLogin
(DocumentId documentId) Opens OneDrive login dialogvoid
ResultSetPresenter.removeFromFolder
(DocumentId documentId, Set<FolderId> folderIDs) Removes the documents from the specified folder.void
ResultSetPresenter.setlitigationhold
(DocumentId documentId, boolean activate) Sets the specified document's litigationhold to 'read'.void
ResultSetPresenter.shareBaseLogin
(DocumentId documentId) Opens ShareBase login dialogcom.saperion.externalstorage.library.Document
ResultSetPresenter.uploadDocToExternalStorage
(DocumentId documentId, String selectedFolderID, com.saperion.externalstorage.client.ExternalStorageClient externalStorageClient, com.saperion.externalstorage.ExternalStorageType storageType) Constructor parameters in com.saperion.ngc.resultset with type arguments of type DocumentIdModifierConstructorDescriptionSelectNextUserDialogEventListener
(com.saperion.intf.wf.CommandInfo commandInfo, String comment, Date date, List<DocumentId> taskIds, boolean multi) -
Uses of DocumentId in com.saperion.ngc.sapviewer
Methods in com.saperion.ngc.sapviewer with parameters of type DocumentIdModifier and TypeMethodDescriptionstatic String
SAPViewerMailUrl.getAppletMailingURL
(jakarta.servlet.http.HttpServletRequest request, DocumentId docId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> elements, String text, String subject) Creates a mailing URL.static String
SAPViewerMailUrl.getAppletUrlMailingURL
(jakarta.servlet.http.HttpServletRequest request, DocumentId docId, String mailText, String subject) Creates a url mailing URL.static String
SAPViewerMailUrl.getMailToLink
(jakarta.servlet.http.HttpServletRequest request, DocumentId docId) Creates SapWebViewer Mailto link. -
Uses of DocumentId in com.saperion.ngc.scripthelper
Methods in com.saperion.ngc.scripthelper with parameters of type DocumentIdModifier and TypeMethodDescriptionstatic IntelligentFormPopupWindow
FormPopupHelper.openEditForm
(String formName, DocumentId docId) Opens a form popup window in index mode for editing existing documents with the given form.static IntelligentFormPopupWindow
FormPopupHelper.openEditForm
(String formName, DocumentId docId, String popupTitle) Opens a form popup window in index mode for editing existing documents with the given form. -
Uses of DocumentId in com.saperion.ngc.scripthelper.internal
Methods in com.saperion.ngc.scripthelper.internal that return DocumentIdModifier and TypeMethodDescriptionFormPopupHelperContext.getDocumentId()
Gets the document id (of the document to edit).Methods in com.saperion.ngc.scripthelper.internal with parameters of type DocumentIdModifier and TypeMethodDescriptionvoid
FormPopupHelperContext.setDocumentId
(DocumentId id) Sets the document id. -
Uses of DocumentId in com.saperion.ngc.servlet
Methods in com.saperion.ngc.servlet with parameters of type DocumentIdModifier and TypeMethodDescriptionstatic String
ServletUrl.constructTimelineUrl
(DocumentId documentId, jakarta.servlet.http.HttpServletRequest request) Constructs the url to retrieve revision infos for timeline components. -
Uses of DocumentId in com.saperion.ngc.util
Methods in com.saperion.ngc.util with parameters of type DocumentIdModifier and TypeMethodDescriptionstatic void
MessageboxProvider.showDocumentCannotBeEditedMessage
(ResultSetView view, DocumentId id) Shows the 'this document cannot be edited' message box with a choice for the user.static com.lexmark.saperion.lookup.LookupEntryReferenceType
ReferenceTypes.toLookupEntryReference
(DocumentId documentId) Creates a new reference to the lookup table entry identified by the specified ID. -
Uses of DocumentId in com.saperion.ngc.viewer
Methods in com.saperion.ngc.viewer that return DocumentIdModifier and TypeMethodDescriptionOpenDocumentBean.getDocumentId()
Gets the document id.RememberDocumentBean.getDocumentId()
Gets the document id.SapDocumentViewImpl.getLastDocId()
Methods in com.saperion.ngc.viewer with parameters of type DocumentIdModifier and TypeMethodDescriptionvoid
StructureList.addStructureItem
(DocumentId documentId, DocumentArchiveMetaInfo.ElementArchiveMetaInfo info, boolean canDownload) Adds the structure item.protected boolean
AbstractDocumentView.canDownload
(DocumentId documentId) Checks if the user is allowed to download the document.boolean
DocumentViewPresenter.canDownload
(int maskRights, DocumentId documentId) Checks if downloading an item is allowed in this mask.boolean
DocumentViewPresenter.canEditDocument
(DocumentId id) Checks if the document can be edited.protected boolean
AbstractDocumentView.canView
(DocumentId documentId) Checks if the user is allowed to display the document.boolean
DocumentViewPresenter.canView
(DocumentId documentId) Checks if the document can be opened in viewer.void
ViewerComponent.displayDocument
(String documentUrl, String annotationUrl, DocumentArchiveMetaInfo.ElementArchiveMetaInfo pageMetaInfo, DocumentId documentId) Displays a document.void
DocumentViewPresenter.downloadSingle
(DocumentId docId, String filename, int element) Triggers the download of a single document.protected void
AbstractDocumentView.fillStructureView
(List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> infos, DocumentId documentId) Fills the structure list with available documents to show in the viewer component.DocumentViewPresenter.getArchiveMetaInfo
(DocumentId documentId, boolean currentRevision, boolean previewMode) Gets the archive meta info.DocumentViewPresenter.getContentListForLink
(DocumentId id, DocumentArchiveMetaInfo linkMetaInfo) Returns a list ofContent
of a linked document.DocumentViewPresenter.getDocumentInfo
(DocumentId id) Returns the database meta-info of the document with the specified ID.long
DocumentViewPresenter.getElementSize
(DocumentId id, int element) Determines the size of the element.DocumentViewPresenter.getElementSizes
(DocumentId id, List<Integer> elementsWithoutSize) Determines the sizes of the list of elements.protected InputStream
AbstractDocumentView.getPageListStream
(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements) DocumentViewPresenter.getStream
(DocumentId id, int element) Gets the document's content as stream.boolean
DocumentViewPresenter.hasAclAnnotationsInEveryDocument
(List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> elements, DocumentId documentId) Checks for ACL in all sub-structure elements in a documentprotected void
AbstractDocumentView.makeViewerBean
(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, boolean currentRevision) Creates a new viewer control-bean or updates the existing one.abstract void
AbstractDocumentView.openDocument
(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element) Opens the specified url and displays the document.void
DocumentView.openDocument
(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element) Opens the specified url and displays the document.void
DocumentView.openDocument
(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element, boolean currentRevision) Opens the specified url and displays the document.final void
DocumentViewImpl.openDocument
(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element) Opens the specified url and displays the document.void
DocumentViewImpl.openDocument
(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element, boolean currentRevision) Opens the specified url and displays the document.final void
SapDocumentViewImpl.openDocument
(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element) Opens the specified url and displays the document.void
SapDocumentViewImpl.openDocument
(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element, boolean currentRevision) Opens the specified url and displays the document.void
DocumentViewImpl.openPopup
(DisplayPopupEvent orig, DocumentId id) openPopup Open a PopUp of Document Viewer.void
DocumentViewImpl.openPopup
(DisplayPopupEvent orig, DocumentId id, boolean currentRevision) openPopup Open a PopUp of Document Viewer.void
OpenDocumentBean.setDocumentId
(DocumentId id) Sets the document id.com.saperion.externalstorage.library.Document
DocumentViewPresenter.uploadDocElementToExternalStorage
(DocumentId documentId, String selectedFolderID, com.saperion.externalstorage.client.ExternalStorageClient externalStorageClient, com.saperion.externalstorage.ExternalStorageType storageType, int elementNo) void
DocumentViewPresenter.writeNotes
(DocumentId documentId, String text) Writes the text to the notes element or creates a new one.Constructors in com.saperion.ngc.viewer with parameters of type DocumentIdModifierConstructorDescriptionOpenDocumentBean
(DocumentId documentId, boolean currentRevision, boolean editMode, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> elementList, InputStream pageStream) Instantiates a new open document bean.RememberDocumentBean
(DocumentId docId, int elementNr, DocumentArchiveMetaInfo.ElementArchiveMetaInfo metaInfo, long size, boolean sizeIgnored) Creates a new DocumentHelper Object that holds information about a document like its docId. -
Uses of DocumentId in com.saperion.ngc.viewer.hylandviewer
Methods in com.saperion.ngc.viewer.hylandviewer with parameters of type DocumentIdModifier and TypeMethodDescriptionvoid
HylandViewerImpl.displayDocument
(String documentUrl, String annotationUrl, DocumentArchiveMetaInfo.ElementArchiveMetaInfo pageMetaInfo, DocumentId documentId) -
Uses of DocumentId in com.saperion.ngc.viewer.pdfjs
Methods in com.saperion.ngc.viewer.pdfjs with parameters of type DocumentIdModifier and TypeMethodDescriptionvoid
PdfjsViewerImpl.displayDocument
(String documentUrl, String annotationsUrl, DocumentArchiveMetaInfo.ElementArchiveMetaInfo elementinfo, DocumentId documentId) Displays a document. -
Uses of DocumentId in com.saperion.ngc.viewer.simple
Methods in com.saperion.ngc.viewer.simple with parameters of type DocumentIdModifier and TypeMethodDescriptionvoid
MediaViewerImpl.displayDocument
(String documentUrl, String annotationsUrl, DocumentArchiveMetaInfo.ElementArchiveMetaInfo elementinfo, DocumentId documentId) Displays a document.void
SimpleViewerImpl.displayDocument
(String documentUrl, String annotationsUrl, DocumentArchiveMetaInfo.ElementArchiveMetaInfo elementinfo, DocumentId documentId) Displays a document. -
Uses of DocumentId in com.saperion.ngc.viewer.virtualviewer
Methods in com.saperion.ngc.viewer.virtualviewer that return DocumentIdModifier and TypeMethodDescriptionstatic DocumentId
VirtualViewerUtil.getReleasedHdoc
(DocumentId documentId, OpenDocumentBean openDocumentBean, DocumentService docService) Gets the released hdoc.Methods in com.saperion.ngc.viewer.virtualviewer with parameters of type DocumentIdModifier and TypeMethodDescriptionVirtualViewerIdGenerator.generateJsonId
(DocumentId id) Generates a JSON-string to be used as ID.static DocumentId
VirtualViewerUtil.getReleasedHdoc
(DocumentId documentId, OpenDocumentBean openDocumentBean, DocumentService docService) Gets the released hdoc. -
Uses of DocumentId in com.saperion.ngc.viewer.virtualviewer.html5
Methods in com.saperion.ngc.viewer.virtualviewer.html5 with parameters of type DocumentIdModifier and TypeMethodDescriptionvoid
VirtualViewerHTML5.displayDocument
(String documentUrl, String annotationUrl, DocumentArchiveMetaInfo.ElementArchiveMetaInfo pageMetaInfo, DocumentId documentId)
DocClassicConnectorService.addDocument(Map, ContentStream[], String, String, String, Map)
instead