Uses of Class
com.saperion.ngc.model.document.DocumentId

Packages that use DocumentId

Package	Description
com.saperion.ngc.dialogs	Package for client dialog classes.
com.saperion.ngc.dialogs.onedrive.dialog
com.saperion.ngc.dialogs.onedrive.model
com.saperion.ngc.dialogs.sharebase.dialog
com.saperion.ngc.events	Package for all ZK events.
com.saperion.ngc.events.iform	Package for iform events.
com.saperion.ngc.events.navigation	Package for all navigation events.
com.saperion.ngc.events.resultset	Package for all resultset events.
com.saperion.ngc.iform	Package for main iForm components.
com.saperion.ngc.iform.image	Package for iForm image elements.
com.saperion.ngc.mail	Package for mailing.
com.saperion.ngc.model	Package for model classes.
com.saperion.ngc.model.document	Package for document model classes.
com.saperion.ngc.model.navigation	Package for navigation model classes.
com.saperion.ngc.model.resultset	Package for resultset model classes.
com.saperion.ngc.portal.builder.weblink	Package for portal classes.
com.saperion.ngc.resultset	Package for resultset component classes.
com.saperion.ngc.sapviewer	Package for standalone SAP viewer.
com.saperion.ngc.scripthelper	Package for Server-Script utility/helper classes.
com.saperion.ngc.scripthelper.internal	Package for internal classes of Server-Script utility/helper classes.
com.saperion.ngc.servlet	Package for streaming servlet.
com.saperion.ngc.util	Package for client utility classes.
com.saperion.ngc.viewer	Package for viewer component classes.
com.saperion.ngc.viewer.hylandviewer
com.saperion.ngc.viewer.pdfjs	Package for PDFJS-viewer component classes.
com.saperion.ngc.viewer.simple	Package for simple viewer component classes.
com.saperion.ngc.viewer.virtualviewer	Package for virtual viewer component classes.
com.saperion.ngc.viewer.virtualviewer.html5	Package for virtual viewer HTML5 component classes.

Uses of DocumentId in com.saperion.ngc.dialogs

Methods in com.saperion.ngc.dialogs that return DocumentId

Modifier and Type	Method	Description
DocumentId	EditStructureDialog.getDocumentId()
DocumentId	RevisionHistoryDialog.RevisionBean.getDocumentId()

Methods in com.saperion.ngc.dialogs with parameters of type DocumentId

Modifier and Type	Method	Description
static RevisionHistoryDialog.RevisionListModel	RevisionHistoryDialog.RevisionListModel.create(ResultSetPresenter resultPresenter, ResultSetViewImpl view, DocumentId docId, java.lang.String maskName)	Factory method.
void	EditStructureDialog.setDocumentId(DocumentId documentId)
static void	EditStructureDialog.show(DocumentId documentId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentPages, BaseWindow parent, org.zkoss.zk.ui.event.EventListener eventListener, boolean commentEnabled, java.lang.String defaultComment)	Shows the EditStructureDialog.
static void	RevisionHistoryDialog.show(ResultSetPresenter resultPresenter, ResultSetViewImpl view, DocumentId docId, java.lang.String maskName)	Shows the revision history.

Constructors in com.saperion.ngc.dialogs with parameters of type DocumentId

Constructor	Description
RevisionBean(DocumentVersionInfo info, DocumentId docId, java.lang.String aMaskName, boolean userAllowedToView)	Creates a new RevisionBean.
RevisionListModel(java.util.List<java.lang.String> versionIds, ResultSetPresenter resultPresenter, DocumentId documentId, java.lang.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 DocumentId

Modifier and Type	Method	Description
static 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 DocumentId

Modifier and Type	Method	Description
DocumentId	OneDriveLoginResult.getDocumentId()

Methods in com.saperion.ngc.dialogs.onedrive.model with parameters of type DocumentId

Modifier and Type	Method	Description
void	OneDriveLoginResult.setDocumentId(DocumentId documentId)

Uses of DocumentId in com.saperion.ngc.dialogs.sharebase.dialog

Methods in com.saperion.ngc.dialogs.sharebase.dialog that return DocumentId

Modifier and Type	Method	Description
DocumentId	ShareBaseLoginDialog.ShareBaseLoginResult.getDocumentId()

Methods in com.saperion.ngc.dialogs.sharebase.dialog with parameters of type DocumentId

Modifier and Type	Method	Description
void	ShareBaseLoginDialog.ShareBaseLoginResult.setDocumentId(DocumentId documentId)
static void	ExternalStorageUploadDialog.show(DocumentId documentId, org.zkoss.zk.ui.event.EventListener eventListener, BaseWindow parent, com.saperion.externalstorage.client.ExternalStorageClient client, com.saperion.externalstorage.ExternalStorageType storageType)	Shows the External Storage Upload dialog
static void	ShareBaseLoginDialog.show(DocumentId documentId, org.zkoss.zk.ui.event.EventListener listener, BaseWindow parent)	Shows ShareBase Login Dialog if user is not logged and performing wants to perform ShareBase operations related to a Saperion document

Uses of DocumentId in com.saperion.ngc.events

Methods in com.saperion.ngc.events that return DocumentId

Modifier and Type	Method	Description
DocumentId	ArchiverSuccessEvent.getDocumentId()
DocumentId	CheckDataBean.getDocumentId()
DocumentId	DisplayPopupEvent.getDocumentId()
DocumentId	ShareBaseCheckDataBean.getDocumentId()
DocumentId	WorkflowDisplayCommentEvent.getTaskId()

Methods in com.saperion.ngc.events that return types with arguments of type DocumentId

Modifier and Type	Method	Description
java.util.List<DocumentId>	WorkflowActionEvent.getTaskIds()
java.util.List<DocumentId>	WorkflowCommentEvent.getTaskIds()

Methods in com.saperion.ngc.events with parameters of type DocumentId

Modifier and Type	Method	Description
void	BaseWindow.postDisplayPopupEvent(DocumentId docId, boolean withCtrl, boolean editMode)
void	BaseWindow.postDisplayPopupEvent(DocumentId docId, boolean currentRevision, boolean withCtrl, boolean editMode)
void	BaseWindow.postDisplayPopupEvent(DocumentId docId, boolean withCtrl, boolean editMode, ResultSetViewImpl view)
void	EventChildHandler.postDisplayPopupEvent(DocumentId docId, boolean withCtrl, boolean editMode)
void	EventChildHandler.postDisplayPopupEvent(DocumentId docId, boolean currentRevision, boolean withCtrl, boolean editMode)
void	EventChildHandler.postDisplayPopupEvent(DocumentId docId, boolean withCtrl, boolean editMode, ResultSetViewImpl view)
void	EventChildHandlerImpl.postDisplayPopupEvent(DocumentId docId, boolean withCtrl, boolean editMode)
void	EventChildHandlerImpl.postDisplayPopupEvent(DocumentId docId, boolean currentRevision, boolean withCtrl, boolean editMode)
void	EventChildHandlerImpl.postDisplayPopupEvent(DocumentId docId, boolean withCtrl, boolean editMode, ResultSetViewImpl view)
void	BaseWindow.postDisplayResultItemEvent(int maskRights, DocumentId selectedDocId)
void	BaseWindow.postDisplayResultItemEvent(DocumentId selectedDocId)	Calls EventChildHandler.postDisplayResultItemEvent(int, DocumentId) with all rights enabled.
void	EventChildHandler.postDisplayResultItemEvent(int maskRights, DocumentId selectedDocId)
void	EventChildHandler.postDisplayResultItemEvent(DocumentId selectedDocId)	Calls EventChildHandler.postDisplayResultItemEvent(int, DocumentId) with all rights enabled.
void	EventChildHandlerImpl.postDisplayResultItemEvent(int maskRights, DocumentId selectedDocId)
void	EventChildHandlerImpl.postDisplayResultItemEvent(DocumentId selectedDocId)	Calls EventChildHandler.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 event
void	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 event
void	EventChildHandlerImpl.postSetLitigationHoldEvent(DocumentId documentId, boolean activate)
void	BaseWindow.postShareBaseLoginEvent(DocumentId documentId)
void	EventChildHandler.postShareBaseLoginEvent(DocumentId documentId)	Post a ShareBase Login event
void	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 DocumentId

Modifier and Type	Method	Description
void	BaseWindow.postChangeDocumentSecurityEvent(java.util.Set<DocumentId> documentIds, java.util.Set<java.lang.String> acls)	Posts a ChangeDocumentSecurityEvent.
void	EventChildHandler.postChangeDocumentSecurityEvent(java.util.Set<DocumentId> documentIds, java.util.Set<java.lang.String> acls)	Posts a ChangeDocumentSecurityEvent.
void	EventChildHandlerImpl.postChangeDocumentSecurityEvent(java.util.Set<DocumentId> documentIs, java.util.Set<java.lang.String> acls)	Posts a ChangeDocumentSecurityEvent.
void	BaseWindow.postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, java.util.Set<DocumentId> documentIDs, java.lang.String folderName)	Posts a DocumentFilingEvent.
void	BaseWindow.postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, java.util.Set<DocumentId> documentIDs, java.util.Set<FolderId> folderSysRowIds)	Posts a DocumentFilingEvent.
void	EventChildHandler.postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, java.util.Set<DocumentId> documentIDs, java.lang.String folderName)	Posts a DocumentFilingEvent.
void	EventChildHandler.postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, java.util.Set<DocumentId> documentIDs, java.util.Set<FolderId> folderSysRowIds)	Posts a DocumentFilingEvent.
void	EventChildHandlerImpl.postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, java.util.Set<DocumentId> documentIDs, java.lang.String folderName)	Posts a DocumentFilingEvent.
void	EventChildHandlerImpl.postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, java.util.Set<DocumentId> documentIDs, java.util.Set<FolderId> folderSysRowIds)	Posts a DocumentFilingEvent.
void	BaseWindow.postWorkflowActionEvent(java.util.List<DocumentId> tasks, com.saperion.intf.wf.CommandInfo info, java.util.List<java.lang.String> actors, java.lang.String commentString, java.util.Date actionDate)
void	EventChildHandler.postWorkflowActionEvent(java.util.List<DocumentId> task, com.saperion.intf.wf.CommandInfo info, java.util.List<java.lang.String> actor, java.lang.String commentString, java.util.Date actionDate)
void	EventChildHandlerImpl.postWorkflowActionEvent(java.util.List<DocumentId> tasks, com.saperion.intf.wf.CommandInfo info, java.util.List<java.lang.String> actors, java.lang.String commentString, java.util.Date actionDate)
void	BaseWindow.postWorkflowCommentEvent(java.util.List<DocumentId> tasks)
void	EventChildHandler.postWorkflowCommentEvent(java.util.List<DocumentId> tasks)
void	EventChildHandlerImpl.postWorkflowCommentEvent(java.util.List<DocumentId> tasks)

Constructors in com.saperion.ngc.events with parameters of type DocumentId

Constructor	Description
ArchiverSuccessEvent(org.zkoss.zk.ui.Component target, java.util.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.
DisplayPopupEvent(org.zkoss.zk.ui.Component target, DocumentId id, boolean isWithCtrl, boolean editMode, ResultSetViewImpl resultSetView)	Constructor.
ShareBaseCheckDataBean(ShareBaseCheckDataBean.ShareBaseCheckType type, DocumentId id)	Constructor.
WorkflowDisplayCommentEvent(org.zkoss.zk.ui.Component target, DocumentId taskId)	Constructor.

Constructor parameters in com.saperion.ngc.events with type arguments of type DocumentId

Constructor	Description
WorkflowActionEvent(org.zkoss.zk.ui.Component target, java.util.List<DocumentId> taskIds, com.saperion.intf.wf.CommandInfo commandInfo, java.util.List<java.lang.String> nextUsers, java.lang.String comment, java.util.Date date)	Constructor.
WorkflowCommentEvent(org.zkoss.zk.ui.Component target, java.util.List<DocumentId> taskIds)	Constructor.

Uses of DocumentId in com.saperion.ngc.events.iform

Methods in com.saperion.ngc.events.iform that return DocumentId

Modifier and Type	Method	Description
DocumentId	DocumentAddedEvent.getDocumentId()	Gets the document id.
DocumentId	RevisionCreatedEvent.getDocumentId()

Constructors in com.saperion.ngc.events.iform with parameters of type DocumentId

Constructor	Description
DocumentAddedEvent(org.zkoss.zk.ui.Component target, DocumentId id, java.util.List<FieldResultBean> fields)	Constructor.
RevisionCreatedEvent(org.zkoss.zk.ui.Component target, DocumentId docId, java.util.List<FieldResultBean> fields, boolean lookupRevision)	Constructor.

Uses of DocumentId in com.saperion.ngc.events.navigation

Methods in com.saperion.ngc.events.navigation that return types with arguments of type DocumentId

Modifier and Type	Method	Description
java.util.Set<DocumentId>	DocumentFilingEvent.getDocumentIDs()

Constructor parameters in com.saperion.ngc.events.navigation with type arguments of type DocumentId

Constructor	Description
DocumentFilingEvent(org.zkoss.zk.ui.Component target, DocumentFilingEvent.DocumentFilingAction filingAction, java.util.Set<DocumentId> documentIDs, java.lang.String folderName)	Creates a new DocumentFilingEvent for ADD_TO_NEW_FOLDER action.
DocumentFilingEvent(org.zkoss.zk.ui.Component target, DocumentFilingEvent.DocumentFilingAction filingAction, java.util.Set<DocumentId> documentIDs, java.util.Set<FolderId> folderIds)	Creates a new DocumentFilingEvent for actions ADD_TO_FOLDER and REMOVE_FROM_FOLDER.

Uses of DocumentId in com.saperion.ngc.events.resultset

Methods in com.saperion.ngc.events.resultset that return DocumentId

Modifier and Type	Method	Description
DocumentId	DisplayResultItemEvent.getDocumentId()
DocumentId	EditContentEvent.getDocumentId()
DocumentId	EditStructureEvent.getDocumentId()
DocumentId	ExternalStorageUploadEvent.getDocumentId()
DocumentId	OneDriveLoginEvent.getDocumentId()
DocumentId	ShareBaseLoginEvent.getDocumentId()
DocumentId	DocumentCheckEvent.getId()
DocumentId	DocumentCheckWithShareBaseEvent.getId()
DocumentId	DocumentReleaseEvent.getId()
DocumentId	LitigationHoldEvent.getId()

Methods in com.saperion.ngc.events.resultset that return types with arguments of type DocumentId

Modifier and Type	Method	Description
java.util.Set<DocumentId>	ChangeDocumentSecurityEvent.getDocumentIds()

Constructors in com.saperion.ngc.events.resultset with parameters of type DocumentId

Constructor	Description
DisplayResultItemEvent(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 DocumentId

Constructor	Description
ChangeDocumentSecurityEvent(org.zkoss.zk.ui.Component target, java.util.Set<DocumentId> documentIds, java.util.Set<java.lang.String> aclNames)	Creates a new ChangeDocumentSecurity event.

Uses of DocumentId in com.saperion.ngc.iform

Methods in com.saperion.ngc.iform that return DocumentId

Modifier and Type	Method	Description
DocumentId	IntelligentFormPresenter.addDocument(java.util.List<FieldResultBean> properties, java.lang.String comment, FolderUploadInfos infos, java.lang.String ddcName)	Adds a new document to the archive.
DocumentId	IndexMaskDocument.getDocumentId()	Returns the ID of the document if the document was already archived.

Methods in com.saperion.ngc.iform with parameters of type DocumentId

Modifier and Type	Method	Description
DocumentArchiveMetaInfo	IntelligentFormPresenter.getArchiveMetaInfo(DocumentId id, boolean currentRevision)	Retrieves the meta information of the document from the archive.
ResultProperties	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 DocumentId

Modifier and Type	Method	Description
void	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 DocumentId

Modifier and Type	Method	Description
static java.lang.String	MailUtil.createDocumentZipLink(DocumentId documentId, javax.servlet.http.HttpServletRequest request, java.lang.String filename, java.lang.String baseUrl, long timeout, java.lang.String tenant)	Creates a weblink to all files of the given document as ZIP.
static java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo>	MailUtil.getElementInfos(DocumentId documentId)	Gets a list of information for the elements of the given document.
static java.util.Map<com.saperion.connector.formats.SourceFormat,java.lang.Integer>	MailUtil.getSourceFormats(DocumentId documentId)	Returns a map with the SourceFormats 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 DocumentId

Modifier and Type	Method	Description
DocumentId	SettingsClassicConnectorService.fixRevId(DocumentId id, boolean force)	Fix the revision id, if it's empty.
DocumentId	SettingsService.fixRevId(DocumentId id, boolean force)	Fix the revision id, if it's empty.

Methods in com.saperion.ngc.model with parameters of type DocumentId

Modifier and Type	Method	Description
DocumentId	SettingsClassicConnectorService.fixRevId(DocumentId id, boolean force)	Fix the revision id, if it's empty.
DocumentId	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 DocumentId

Modifier and Type	Method	Description
DocumentId	DocClassicConnectorService.addDocument(java.util.List<FieldResultBean> properties, com.saperion.rmi.SaContentStream[] content, java.lang.String comment, java.lang.String ddcName, java.lang.String acls)	Adds a new document to the archive.
DocumentId	DocClassicConnectorService.addDocument(java.util.List<FieldResultBean> properties, com.saperion.rmi.SaContentStream[] content, java.lang.String comment, java.lang.String ddcName, java.lang.String acls, java.util.Map<java.lang.String,DocumentVariable> variables)	Adds a new document to the archive.
DocumentId	DocClassicConnectorService.addDocument(java.util.Map<java.lang.String,java.lang.Object> properties, com.saperion.bean.ContentStream[] content, java.lang.String comment, java.lang.String ddcName, java.lang.String acls, java.util.Map<java.lang.String,DocumentVariable> variables)	Adds a new document to the archive.
DocumentId	DocClassicConnectorService.addDocument(java.util.Properties properties, com.saperion.rmi.SaContentStream[] content, java.lang.String comment, java.lang.String ddcName, java.lang.String acls)	Deprecated. use DocClassicConnectorService.addDocument(Map, ContentStream[], String, String, String, Map) instead
DocumentId	DocumentService.addDocument(java.util.List<FieldResultBean> properties, com.saperion.rmi.SaContentStream[] content, java.lang.String comment, java.lang.String ddcName, java.lang.String acls)	Adds a new document to the archive.
DocumentId	DocumentService.addDocument(java.util.List<FieldResultBean> properties, com.saperion.rmi.SaContentStream[] content, java.lang.String comment, java.lang.String ddcName, java.lang.String acls, java.util.Map<java.lang.String,DocumentVariable> variables)	Adds a new document to the archive.
DocumentId	DocumentService.addDocument(java.util.Map<java.lang.String,java.lang.Object> properties, com.saperion.bean.ContentStream[] content, java.lang.String comment, java.lang.String ddcName, java.lang.String acls, java.util.Map<java.lang.String,DocumentVariable> variables)	Adds a new document to the archive.
DocumentId	DocumentService.addDocument(java.util.Properties properties, com.saperion.rmi.SaContentStream[] content, java.lang.String comment, java.lang.String ddcName, java.lang.String acls)	Deprecated. use DocumentService.addDocument(Map, ContentStream[], String, String, String, Map) instead
DocumentId	DocClassicConnectorService.createLookupItem(java.util.List<FieldResultBean> properties, java.lang.String ddcName)	Create a new lookup entry.
DocumentId	DocumentService.createLookupItem(java.util.List<FieldResultBean> properties, java.lang.String ddcName)	Create a new lookup entry.
static DocumentId	DocumentId.fromString(java.lang.String idAsString)	Creates a new DocumentId based on the specified string.
DocumentId	DocClassicConnectorService.updateDocument(DocumentId docId, DataToUpdate data, UpdateSettings settings)	Updates the document identfied by docId using the specified data and settings.
DocumentId	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 DocumentId

Modifier and Type	Method	Description
java.util.Set<DocumentId>	DocClassicConnectorService.getSessionLocks()	Returns a set of document IDs that are locked by this session.
java.util.Set<DocumentId>	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 DocumentId

Modifier and Type	Method	Description
void	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.
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.
ResultAccessData	DocClassicConnectorService.getAccessData(DocumentId id)	Retrieves the access data for the specified document.
ResultAccessData	DocumentService.getAccessData(DocumentId id)	Retrieves the access data for the specified document.
java.lang.String	DocClassicConnectorService.getAcl(DocumentId docId)	Deprecated. use DocClassicConnectorService.getAclNames(DocumentId) instead.
java.lang.String	DocumentService.getAcl(DocumentId id)	Deprecated. use DocumentService.getAclNames(DocumentId) instead.
java.util.List<java.lang.String>	DocClassicConnectorService.getAclNames(DocumentId id)
java.util.List<java.lang.String>	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.
DocumentArchiveMetaInfo	DocClassicConnectorService.getArchiveMetaInfo(DocumentId documentId, boolean currentRevision)	Retrieves the meta information of a document that is stored on the archive.
DocumentArchiveMetaInfo	DocClassicConnectorService.getArchiveMetaInfo(DocumentId documentId, boolean currentRevision, boolean previewMode)	Retrieves the meta information of a document that is stored on the archive.
DocumentArchiveMetaInfo	DocumentService.getArchiveMetaInfo(DocumentId documentId, boolean currentRevision)	Retrieves the meta information of a document that is stored on the archive.
DocumentArchiveMetaInfo	DocumentService.getArchiveMetaInfo(DocumentId documentId, boolean currentRevision, boolean previewMode)	Retrieves the meta information of a document that is stored on the archive.
ResultProperties	DocClassicConnectorService.getDocumentInfo(DocumentId id)	Reads the document properties.
ResultProperties	DocClassicConnectorService.getDocumentInfo(DocumentId id, boolean isDeleted)	Reads the document properties.
ResultProperties	DocumentService.getDocumentInfo(DocumentId id)	Reads the document properties.
ResultProperties	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.
java.util.List<java.lang.String>	DocClassicConnectorService.getDocumentVersionIds(DocumentId id)	Returns a list of all version IDs for the specified document.
java.util.List<java.lang.String>	DocumentService.getDocumentVersionIds(DocumentId id)	Returns a list of all version IDs for the specified document.
java.util.List<DocumentVersionInfo>	DocClassicConnectorService.getDocumentVersions(DocumentId id)	Retrieves information about a document's versions.
java.util.List<DocumentVersionInfo>	DocumentService.getDocumentVersions(DocumentId id)	Retrieves information about a document's versions.
DocumentImageInfo	DocClassicConnectorService.getImageInfo(DocumentId id)	Reads the document image informations from backend.
DocumentImageInfo	DocumentService.getImageInfo(DocumentId id)	Reads the document image informations from backend.
ResultLockData	DocClassicConnectorService.getLockData(DocumentId id)	Returns the lock data for the specified document.
ResultLockData	DocClassicConnectorService.getLockData(DocumentId id, boolean isDeleted)	Returns the lock data for the specified document.
ResultLockData	DocumentService.getLockData(DocumentId id)	Returns the lock data for the specified document.
ResultLockData	DocumentService.getLockData(DocumentId id, boolean isDeleted)	Returns the lock data for the specified document.
ResultAccessData	DocClassicConnectorService.getLookupEntryAccessData(DocumentId id)
ResultAccessData	DocumentService.getLookupEntryAccessData(DocumentId id)	Retrieves the access data for the specified lookup table entry.
java.io.InputStream	DocClassicConnectorService.getPageListStream(DocumentId documentId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements)
java.io.InputStream	DocumentService.getPageListStream(DocumentId documentId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements)
java.util.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.
java.util.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.
ResultProperties	DocClassicConnectorService.getRevisionInfo(DocumentId id)	Reads the properties of the specified revision.
ResultProperties	DocumentService.getRevisionInfo(DocumentId id)	Reads the properties of the specified revision.
java.awt.image.BufferedImage	DocClassicConnectorService.getThumbnail(DocumentId id, int height, int width, boolean color)	Retrieves a thumbnail for the specified document or null if no thumbnail is available.
java.awt.image.BufferedImage	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.
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, java.lang.String comment)	Release a document.
void	DocumentService.releaseDocument(DocumentId id, java.lang.String comment)	Release a document.
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, java.lang.String acl, java.lang.String comment)	Deprecated. use DocClassicConnectorService.setAclNames(DocumentId, List, String) instead.
void	DocumentService.setAcl(DocumentId id, java.lang.String acl, java.lang.String comment)	Deprecated. use DocumentService.setAclNames(DocumentId, List, String) instead.
void	DocClassicConnectorService.setAclNames(DocumentId id, java.util.List<java.lang.String> acls, java.lang.String comment)
void	DocumentService.setAclNames(DocumentId id, java.util.List<java.lang.String> acls, java.lang.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.
boolean	DocClassicConnectorService.unlockDocument(DocumentId id)	Unlock document.
boolean	DocumentService.unlockDocument(DocumentId id)	Unlock document.
DocumentId	DocClassicConnectorService.updateDocument(DocumentId docId, DataToUpdate data, UpdateSettings settings)	Updates the document identfied by docId using the specified data and settings.
com.saperion.intf.SaSaveInfo	DocClassicConnectorService.updateDocument(java.util.List<FieldResultBean> properties, com.saperion.bean.ContentStream[] content, java.lang.String comment, DocumentId docId, boolean checkin, boolean lookup, int selectedImage)	Deprecated. Use DocClassicConnectorService.updateDocument(DocumentId, DataToUpdate, UpdateSettings) instead
com.saperion.intf.SaSaveInfo	DocClassicConnectorService.updateDocument(java.util.Properties properties, com.saperion.bean.ContentStream[] content, java.lang.String comment, DocumentId docId, boolean checkin, boolean lookup, int selectedImage)	Deprecated. Use DocClassicConnectorService.updateDocument(DocumentId, DataToUpdate, UpdateSettings) instead
DocumentId	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(java.util.List<FieldResultBean> properties, com.saperion.bean.ContentStream[] content, java.lang.String comment, DocumentId docId, boolean checkin, boolean lookup, int selectedImage)	Deprecated. use DocumentService.updateDocument(DocumentId, DataToUpdate, UpdateSettings) instead
com.saperion.intf.SaSaveInfo	DocumentService.updateDocument(java.util.Properties properties, com.saperion.bean.ContentStream[] content, java.lang.String comment, DocumentId docId, boolean checkin, boolean lookup, int selectedImage)	Deprecated. use DocumentService.updateDocument(DocumentId, DataToUpdate, UpdateSettings) instead

Method parameters in com.saperion.ngc.model.document with type arguments of type DocumentId

Modifier and Type	Method	Description
static java.util.List<java.lang.String>	DocumentId.convertToObjectIdList(java.util.Collection<DocumentId> list)	Converts to a list of object id's.
static java.util.List<java.lang.String>	DocumentId.convertToRevisionIdList(java.util.Collection<DocumentId> list)	/**Converts to a list of revision id's.

Uses of DocumentId in com.saperion.ngc.model.navigation

Methods in com.saperion.ngc.model.navigation with parameters of type DocumentId

Modifier and Type	Method	Description
long	NavigationClassicConnectorService.getDocumentFolderCount(DocumentId id)	Retrieves the count over all folders the document is contained in.
long	NavigationService.getDocumentFolderCount(DocumentId id)	Retrieves the count over all folders the document is contained in.
java.util.List<FolderId>	NavigationClassicConnectorService.getDocumentFolders(DocumentId id)	Retrieves the folders that contain the specified document.
java.util.List<FolderId>	NavigationService.getDocumentFolders(DocumentId id)	Retrieves the folders that contain the specified document.
void	NavigationClassicConnectorService.removeFromFolder(java.util.Set<FolderId> folderSysRowIds, DocumentId documentId)	Removes the specified document from a folder.
void	NavigationService.removeFromFolder(java.util.Set<FolderId> folderIds, DocumentId documentId)	Removes the specified document from a folder.

Uses of DocumentId in com.saperion.ngc.model.resultset

Methods in com.saperion.ngc.model.resultset that return DocumentId

Modifier and Type	Method	Description
DocumentId	ResultProperties.getAttachmentId()	Returns a DocumentId containing the ID of the attachment of a task represented by this result.
DocumentId	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 DocumentId

Modifier and Type	Method	Description
ResultProperties	QueryClassicConnectorService.getResultForId(DocumentId id)	Returns the ResultProperties contained in the result list of the last search with the specified id.
ResultProperties	QueryService.getResultForId(DocumentId id)	Returns the ResultProperties contained in the result list of the last search with the specified id.
ResultProperties	QueryClassicConnectorService.getResultPropertiesForRevision(DocumentId id)	Returns the ResultProperties contained in the result list of the last search with the specified revisionId.
ResultProperties	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 DocumentId

Modifier and Type	Method	Description
static ElementBuilder	WeblinkHandler.with(DocumentId documentId, javax.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 DocumentId

Modifier and Type	Method	Description
DocumentId	ResultSetPresenter.fixVersion(DocumentId documentId)	Fill value for revision ID in document ID if not set.
DocumentId	DraggableListItem.getAttachmentId()
DocumentId	ResultListItem.getAttachmentId()	If this is a workflow-item, this method returns the ID of the attached document.
DocumentId	DraggableListItem.getDocumentId()
DocumentId	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 DocumentId

Modifier and Type	Method	Description
java.util.List<DocumentId>	ResultSetView.getSelectedIds()	Returns the IDs of the selected documents.
java.util.List<DocumentId>	ResultSetViewImpl.getSelectedIds()	Returns the IDs of the selected documents.

Methods in com.saperion.ngc.resultset with parameters of type DocumentId

Modifier and Type	Method	Description
ItemAnalyzeResult	ItemAnalyzer.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 ShareBase
DocumentId	ResultSetPresenter.fixVersion(DocumentId documentId)	Fill value for revision ID in document ID if not set.
java.util.List<java.lang.String>	ResultSetPresenter.getAclNames(DocumentId documentId)	Returns the ACLs of a document.
ResultProperties	ResultSetPresenter.getDocProperties(DocumentId id)	Reads the properties for the given document.
ResultProperties	ResultSetPresenter.getDocProperties(DocumentId id, boolean isDeleted)	Reads the properties for the given document.
java.util.List<FolderId>	ResultSetPresenter.getDocumentFolders(DocumentId documentId)	Retrieves the folders that contain the specified document.
ResultProperties	ResultSetPresenter.getDocumentInfoFromArchive(DocumentId id, boolean currentRevision)
java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo>	ResultSetPresenter.getDocumentPages(DocumentId id, boolean currentRevision)	Returns the amount of pages for the specified document.
java.util.List<java.lang.String>	ResultSetPresenter.getDocumentVersionIDs(DocumentId id)	Returns the version IDs for the specified document.
java.util.List<DocumentVersionInfo>	ResultSetPresenter.getDocumentVersions(DocumentId id)	Retrieves the version information for a document.
java.util.List<DocumentVersionInfo>	ResultSetViewImpl.getDocumentVersions(DocumentId id)
static com.saperion.ngc.resultset.ResultSetEventListenerFactory.EditStructureEventListener	ResultSetEventListenerFactory.getEditStructureEventListener(ResultSetView resultSetView, ResultSetPresenter presenter, boolean commentDialogEnabled, java.lang.String defaultComment, DocumentId documentId, java.lang.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 dialog
void	ResultSetPresenter.removeFromFolder(DocumentId documentId, java.util.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 dialog
com.saperion.externalstorage.library.Document	ResultSetPresenter.uploadDocToExternalStorage(DocumentId documentId, java.lang.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 DocumentId

Constructor	Description
SelectNextUserDialogEventListener(com.saperion.intf.wf.CommandInfo commandInfo, java.lang.String comment, java.util.Date date, java.util.List<DocumentId> taskIds, boolean multi)

Uses of DocumentId in com.saperion.ngc.sapviewer

Methods in com.saperion.ngc.sapviewer with parameters of type DocumentId

Modifier and Type	Method	Description
static java.lang.String	SAPViewerMailUrl.getAppletMailingURL(javax.servlet.http.HttpServletRequest request, DocumentId docId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> elements, java.lang.String text, java.lang.String subject)	Creates a mailing URL.
static java.lang.String	SAPViewerMailUrl.getAppletUrlMailingURL(javax.servlet.http.HttpServletRequest request, DocumentId docId, java.lang.String mailText, java.lang.String subject)	Creates a url mailing URL.
static java.lang.String	SAPViewerMailUrl.getMailToLink(javax.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 DocumentId

Modifier and Type	Method	Description
static IntelligentFormPopupWindow	FormPopupHelper.openEditForm(java.lang.String formName, DocumentId docId)	Opens a form popup window in index mode for editing existing documents with the given form.
static IntelligentFormPopupWindow	FormPopupHelper.openEditForm(java.lang.String formName, DocumentId docId, java.lang.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 DocumentId

Modifier and Type	Method	Description
DocumentId	FormPopupHelperContext.getDocumentId()	Gets the document id (of the document to edit).

Methods in com.saperion.ngc.scripthelper.internal with parameters of type DocumentId

Modifier and Type	Method	Description
void	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 DocumentId

Modifier and Type	Method	Description
static java.lang.String	ServletUrl.constructTimelineUrl(DocumentId documentId, javax.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 DocumentId

Modifier and Type	Method	Description
static 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 DocumentId

Modifier and Type	Method	Description
DocumentId	OpenDocumentBean.getDocumentId()	Gets the document id.
DocumentId	RememberDocumentBean.getDocumentId()	Gets the document id.
DocumentId	SapDocumentViewImpl.getLastDocId()

Methods in com.saperion.ngc.viewer with parameters of type DocumentId

Modifier and Type	Method	Description
void	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(java.lang.String documentUrl, java.lang.String annotationUrl, DocumentArchiveMetaInfo.ElementArchiveMetaInfo pageMetaInfo, DocumentId documentId)	Displays a document.
void	DocumentViewPresenter.downloadSingle(DocumentId docId, java.lang.String filename, int element)	Triggers the download of a single document.
protected void	AbstractDocumentView.fillStructureView(java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> infos, DocumentId documentId)	Fills the structure list with available documents to show in the viewer component.
DocumentArchiveMetaInfo	DocumentViewPresenter.getArchiveMetaInfo(DocumentId documentId, boolean currentRevision, boolean previewMode)	Gets the archive meta info.
java.util.List<Content>	DocumentViewPresenter.getContentListForLink(DocumentId id, DocumentArchiveMetaInfo linkMetaInfo)	Returns a list of Content of a linked document.
ResultProperties	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.
java.util.Map<java.lang.Integer,java.lang.Long>	DocumentViewPresenter.getElementSizes(DocumentId id, java.util.List<java.lang.Integer> elementsWithoutSize)	Determines the sizes of the list of elements.
protected java.io.InputStream	AbstractDocumentView.getPageListStream(DocumentId documentId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements)
java.io.InputStream	DocumentViewPresenter.getStream(DocumentId id, int element)	Gets the document's content as stream.
boolean	DocumentViewPresenter.hasAclAnnotationsInEveryDocument(java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> elements, DocumentId documentId)	Checks for ACL in all sub-structure elements in a document
protected void	AbstractDocumentView.makeViewerBean(DocumentId documentId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, boolean currentRevision)	Creates a new viewer control-bean or updates the existing one.
abstract void	AbstractDocumentView.openDocument(DocumentId documentId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element)	Opens the specified url and displays the document.
void	DocumentView.openDocument(DocumentId documentId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element)	Opens the specified url and displays the document.
void	DocumentView.openDocument(DocumentId documentId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element, boolean currentRevision)	Opens the specified url and displays the document.
void	DocumentViewImpl.openDocument(DocumentId documentId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element)	Opens the specified url and displays the document.
void	DocumentViewImpl.openDocument(DocumentId documentId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element, boolean currentRevision)	Opens the specified url and displays the document.
void	SapDocumentViewImpl.openDocument(DocumentId documentId, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element)	Opens the specified url and displays the document.
void	SapDocumentViewImpl.openDocument(DocumentId documentId, java.util.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, java.lang.String selectedFolderID, com.saperion.externalstorage.client.ExternalStorageClient externalStorageClient, com.saperion.externalstorage.ExternalStorageType storageType, int elementNo)
void	DocumentViewPresenter.writeNotes(DocumentId documentId, java.lang.String text)	Writes the text to the notes element or creates a new one.

Constructors in com.saperion.ngc.viewer with parameters of type DocumentId

Constructor	Description
OpenDocumentBean(DocumentId documentId, boolean currentRevision, boolean editMode, ResultSetViewImpl view, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> elementList, java.io.InputStream pageStream)	Instantiates a new open document bean.
OpenDocumentBean(DocumentId documentId, boolean currentRevision, boolean editMode, java.util.List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> elementList, java.io.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 that return DocumentId

Modifier and Type	Method	Description
DocumentId	HylandViewerUtil.getUpdatedDocumentId(DocumentId docId)	Get the updated document id.

Methods in com.saperion.ngc.viewer.hylandviewer with parameters of type DocumentId

Modifier and Type	Method	Description
void	HylandViewerImpl.displayDocument(java.lang.String documentUrl, java.lang.String annotationUrl, DocumentArchiveMetaInfo.ElementArchiveMetaInfo pageMetaInfo, DocumentId documentId)
DocumentArchiveMetaInfo	HylandViewerUtil.getDocumentArchiveMetaInfo(DocumentId docId, boolean currentRevision)	Get the document archive meta information of a specific document.
OpenDocumentBean	HylandViewerUtil.getOpenDocumentBean(DocumentId docId, boolean currentRevision, boolean editMode)	Get a OpenDocumentBean for a specific document id.
DocumentId	HylandViewerUtil.getUpdatedDocumentId(DocumentId docId)	Get the updated document id.

Uses of DocumentId in com.saperion.ngc.viewer.pdfjs

Methods in com.saperion.ngc.viewer.pdfjs with parameters of type DocumentId

Modifier and Type	Method	Description
void	PdfjsViewerImpl.displayDocument(java.lang.String documentUrl, java.lang.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 DocumentId

Modifier and Type	Method	Description
void	MediaViewerImpl.displayDocument(java.lang.String documentUrl, java.lang.String annotationsUrl, DocumentArchiveMetaInfo.ElementArchiveMetaInfo elementinfo, DocumentId documentId)	Displays a document.
void	SimpleViewerImpl.displayDocument(java.lang.String documentUrl, java.lang.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 DocumentId

Modifier and Type	Method	Description
static DocumentId	VirtualViewerUtil.getReleasedHdoc(DocumentId documentId, OpenDocumentBean openDocumentBean, DocumentService docService)	Gets the released hdoc.

Methods in com.saperion.ngc.viewer.virtualviewer with parameters of type DocumentId

Modifier and Type	Method	Description
java.lang.String	VirtualViewerIdGenerator.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 DocumentId

Modifier and Type	Method	Description
void	VirtualViewerHTML5.displayDocument(java.lang.String documentUrl, java.lang.String annotationUrl, DocumentArchiveMetaInfo.ElementArchiveMetaInfo pageMetaInfo, DocumentId documentId)