Uses of Class
com.logicaldoc.gui.common.client.ServerException
Package
Description
GWT services implementations.
-
Uses of ServerException in com.logicaldoc.dropbox
Modifier and TypeMethodDescriptionboolean
DropboxServiceImpl.exportDocuments
(String targetPath, long[] folderIds, Long[] docIds) DropboxServiceImpl.finishAuthorization
(String authorizationCode) int
DropboxServiceImpl.importDocuments
(long targetFolder, String[] paths) boolean
DropboxServiceImpl.isConnected()
DropboxServiceImpl.startAuthorization()
-
Uses of ServerException in com.logicaldoc.gui.common.client
Modifier and TypeClassDescriptionclass
Thrown in case of invalid sessionclass
Thrown in case of invalid sessionclass
Exception used to inform the GUI about errors during the validation -
Uses of ServerException in com.logicaldoc.gui.common.client.services
Modifier and TypeMethodDescriptionvoid
SecurityService.addUserToGroup
(long groupId, long userId) Adds a user to a groupvoid
SecurityService.applyRights
(GUIMenu menu) Applies all security settings to menuvoid
SecurityService.changeStatus
(long userId, boolean enabled) Changes the status of a uservoid
SecurityService.cloneWorkTimes
(long srcUserId, long[] userIds, long[] groupIds) Clones a work time to a set of other usersvoid
SecurityService.deleteGroup
(long groupId) Deletes a given groupvoid
SecurityService.deleteMenu
(long menuId) Deletes a menu but only if is not a legacy menu (type not 0)void
SecurityService.deleteTrustedDevices
(String[] deviceIds) Deletes a set of trusted devices for the current uservoid
SecurityService.deleteUser
(long userId) Deletes a given userSecurityService.generatePassword()
Generates a password using the configured policies.InfoService.getCronDescription
(String expression, String locale) Retrieves the natural language description of a given cron expressionSecurityService.getGroup
(long groupId) Loads a given group from the databaseRetrieves the system informationsRetrieves the specified menuGUIMenu[]
Retrieves the accessible menus children of a given parentSecurityService.getUser
(long userId) Loads a given user from the databaseSecurityService.isTrustedDevice
(String device) Check if the saved device ID is trusted for the current uservoid
Kill the session with the given sidSecurityService.loadBlockedEntities()
Retrieves the list of actually blocked usernames and IPs detected as Brute Force AttackSecurityService.loadSettings()
Loads security settingsvoid
SecurityService.removeBlockedEntities
(long[] id) Removes blocked entries detected as Brute Force Attackvoid
SecurityService.removeFromGroup
(long groupId, long[] userIds) Removes users from a groupvoid
SecurityService.replicateUsersSettings
(long masterUserId, Long[] userIds, boolean gui, boolean groups) Replicates the settings of a given user to a selection of other usersvoid
SecurityService.resetAvatar
(long userId) Resets tha avatar to the default onevoid
SecurityService.saveAvatar
(long userId) Saves an uploaded image as the user's avatarCreates or updates a groupSecurityService.saveInterfaceSettings
(GUIUser user) Saves the interface settings onlySaves a menuvoid
Saves a set of menusSecurityService.saveProfile
(GUIUser user) Saves the profile data onlyboolean
SecurityService.saveSettings
(GUISecuritySettings settings) Saves security settingsCreates or updates a userGUIUser[]
SecurityService.searchUsers
(String username, String groupId) Searches for usersSecurityService.syncGeolocationDB
(String key) Downloads the most recent version of the Geolocation databaseSecurityService.trustDevice
(String label) Permanently trusts the current device for the current uservoid
SecurityService.updateDeviceLabel
(long deviceId, String label) Updates the label of a device -
Uses of ServerException in com.logicaldoc.gui.frontend.client.security.saml
Modifier and TypeMethodDescriptionSamlService.importResource
(String resourceName) Take the last uploaded file and imports it in the SAML settingsSamlService.loadSettings()
void
SamlService.saveSettings
(GUISamlSettings settings) -
Uses of ServerException in com.logicaldoc.gui.frontend.client.services
Modifier and TypeMethodDescriptionvoid
DocumentService.addBookmarks
(Long[] targetIds, int type) Adds new bookmarksDocumentService.addDocuments
(boolean importZip, String charset, boolean immediateIndexing, GUIDocument metadata) DocumentService.addDocuments
(String language, long folderId, boolean importZip, String charset, boolean immediateIndexing, Long templateId) Adds new documents previously uploadedvoid
ImpexService.addDocuments
(long archiveId, Long[] documentIds) Adds a set of documents(their current versions) to the given archivevoid
ImpexService.addFolder
(long archiveId, long folderId) Adds a a folder(the current version of the contained documents at any level)long
Adds a new document note on the given documentlong
Adds a new note on the workflow instancevoid
Adds a new tag in the list of available tagsvoid
StampService.addUsers
(long[] userIds, long stampId) Assigns users to stampvoid
WorkflowService.appendDocuments
(String taskId, Long[] docIds) Appends to the workflow of the given taskId the documents with the given doc idsvoid
AttributeSetService.applyAllToTemplates
(long setId, String attribute) Forces all the settings of an attribute to all those templates that use itvoid
FolderService.applyGridLayout
(long folderId) Replicates the folder's grid layout to all the subtreevoid
AttributeSetService.applyInitializationToTemplates
(long setId, String attribute) Forces the initialization of an attribute to all those templates that use itvoid
FolderService.applyMetadata
(long parentId) Applies all extended attributes to a sub-treevoid
FolderService.applyOCR
(long parentId) Applies all OCR settings to a sub-treevoid
FolderService.applyRights
(GUIFolder folder, boolean subfolders) Applies all security settings to foldervoid
StampService.applyStamp
(Long[] docIds, GUIStamp stamp) Applies a stamp to the given documentvoid
FolderService.applyStorage
(long parentId) Applies the storage setting to a sub-treevoid
FolderService.applyTags
(long parentId) Applies all tags to a sub-treevoid
FolderService.applyTemplate
(long folderId, long templateId, boolean inheritSecurity) Applies a template to a foldervoid
AutomationService.applyTriggersToTree
(long rootId) Applies the triggers on a root folder to all the subtreevoid
WorkflowService.applyTriggersToTree
(long folderId) Applies the triggers on a root folder to all the subtreevoid
AttributeSetService.applyValidationToTemplates
(long setId, String attribute) Forces the validation of an attribute to all those templates that use itvoid
DocumentService.archiveDocuments
(Long[] docIds, String comment) Archives a set of documentslong
DocumentService.archiveFolder
(long folderId, String comment) Archives the documents in a foldervoid
ReadingRequestService.askReadingConfirmation
(Long[] docIds, long[] userIds, long[] groupIds, boolean alertConfirmation, String comment) Asks some users to confirm the reading of a set of documentsDocuSignService.authorize
(GUIDocuSignSettings settings) Saves the settings into the database and returns the authorization URL the user must be redirected to.Saves the settings into the database and returns the authorization URL the user must be redirected to.DocumentService.bulkUpdate
(Long[] ids, GUIDocument vo, boolean ignoreEmptyFields) Applies to a selection of documents all the given datavoid
TenantService.changeAdminPassword
(String password, String tenantName) Changes the password of the administrator of the given tenantTenantService.changeSessionTenant
(long tenantId) Change session tenantvoid
EmailAccountService.changeStatus
(long id, boolean enabled) Changes an account enabled/disabled statusvoid
ImportFolderService.changeStatus
(long id, boolean enabled) Changes a importFolder enabled/disabled statusvoid
ReportService.changeStatus
(long id, boolean enabled) Changes a report enabled/disabled statusvoid
RetentionPoliciesService.changeStatus
(long id, boolean enabled) Changes a policy enabled/disabled statusvoid
StampService.changeStatus
(long stampId, boolean enabled) Changes a stamp enabled/disabled statusvoid
SyndicationService.changeStatus
(long id, boolean enabled) Changes a syndication enabled/disabled statusvoid
TwoFactorsAuthenticationService.changeTwoFactorsAuthentication
(long userId, String secondFactor, String key, String account, boolean notify) Changed the two factors authentication for a userSearchEngineService.check()
Checks the indexerDocumentService.checkin
(GUIDocument document, boolean major) Checks-in a new document versionPerforms the check-in of a Google Drives's document into the LogicalDOC repositoryPerforms the check-in of a Zoho's document into the LogicalDOC repositoryDocumentService.checkinContent
(long docId, String content) Checks-in a new document's text contentvoid
Checks out the documentThe given user take the ownership of the task.void
DocumentService.cleanUploadedFileFolder()
Cleans the uploaded files folderMakes a clone of an existing templatelong[]
FolderService.computeStats
(long folderId) Counts the docs and subfolders of a given parentUpdateService.confirmPatch
(String patchFileName) Confirms a patchvoid
ReadingRequestService.confirmReadings
(long[] readingIds, String version) Confirms the read completion of a given file versionvoid
SystemService.confirmUpdate()
Confirms the last updateUpdateService.confirmUpdate
(String updateFileName) Confirms an update packageConverts a document in a given formatvoid
FolderService.copyFolders
(long[] folderIds, long targetId, boolean foldersOnly, String securityOption, GUIFolder model) Copies a folder under a target folderint
WorkflowService.countAssignedTasks
(String username) Counts all the tasks assigned to the given userlong
DocumentService.countDocuments
(long[] folderIds, int status) Counts the documents in a given status contained the specified folder's treeslong
TemplateService.countDocuments
(long templateId) Counts the documents of a given templatelong
SearchEngineService.countEntries()
Counts the total number of entriesint
CalendarService.countUserEvents
(String username, Date end) Counts the number of events that start from now until a given dateCreates a new folderCreates a new Google DocumentCreates a new reportFolderService.createAlias
(long parentId, long foldRef) Creates a new folder aliasDocumentService.createDocument
(GUIDocument document, String content) Creates a new document with the given text contentString[]
DocumentService.createDownloadTicket
(long docId, int type, String suffix, Integer expireHours, Date expireDate, Integer maxDownloads, Integer maxViews) Creates a download ticketDocumentService.createWithContent
(GUIDocument vo, String content, boolean checkout) Creates a new empty documentvoid
DocumentService.deDuplicate
(Long folderId, boolean retainNewest) Convert duplicates with aliases, just one of the documents is maintainedvoid
AttributeSetService.delete
(long setId) Deletes a given setvoid
BarcodeService.delete
(long templateId) Deletes a given templatevoid
ContactService.delete
(long[] ids) Deletes a selection of contactsvoid
DashletService.delete
(long dashletId) void
Deletes a selection of documentsvoid
EmailAccountService.delete
(long id) Deletes a given accountvoid
FolderService.delete
(long[] folderIds) Deletes the folders and the subtreesvoid
FormService.delete
(long id) Deletes a formvoid
Deletes a document in Google Drivevoid
ImpexService.delete
(long archiveId) Deletes a specific archive by its identifiervoid
ImportFolderService.delete
(long id) Deletes a given import foldervoid
LDAPService.delete
(long serverId) Deletes the specified servervoid
MessageService.delete
(long[] ids) Deletes a list of Messagesvoid
ReadingRequestService.delete
(long readingId) Deletes a reading request.void
ReportService.delete
(long id) Deletes a given reportvoid
RetentionPoliciesService.delete
(long id) Deletes a given policyvoid
Deletes a templatevoid
Deletes a previously saved searchvoid
StampService.delete
(long id) Deletes a given stampvoid
SyndicationService.delete
(long id) Deletes a given syndicationvoid
Deletes an existing tagvoid
TemplateService.delete
(long templateId) Deletes a given templatevoid
TenantService.delete
(long tenantId) Deletes a specific tenant by its IDvoid
Deletes a given workflowvoid
Deletes a document in Zohovoid
ZonalOCRService.delete
(long templateId) Deletes a given templatevoid
DocumentService.deleteBookmarks
(long[] bookmarkIds) Deletes a set of bookmarksvoid
SignService.deleteCertificate()
Delete the certificate of the current uservoid
CalendarService.deleteEvent
(long eventId) Deletes an event.void
ImpexService.deleteFolder
(String folderName) Deletes a folder in impex/in foldervoid
DocumentService.deleteFromTrash
(Long[] ids) Deletes a selection of documents from trashvoid
FolderService.deleteFromTrash
(Long[] ids) Deletes a selection of folders from trashvoid
ImpexService.deleteIncremental
(long id) Deletes a given incremental configurationvoid
WorkflowService.deleteInstance
(String id) Deletes a given workflow instancevoid
WorkflowService.deleteInstances
(String[] ids) Deletes a given workflow instancesvoid
SignService.deleteKeystore
(long tenantId) Deletes the actual key storevoid
DocumentService.deleteLinks
(long[] ids) Deletes a selection of linksvoid
WorkflowService.deleteNote
(long noteId) Deletes a notevoid
DocumentService.deleteNotes
(long[] ids) Deletes a selection of document notesvoid
AttributeSetService.deleteOptions
(long setId, String attribute, String[] values) Delete a selection of optionsDocumentService.deleteRating
(long id) Deletes a votevoid
AutomationService.deleteRoutines
(long[] ids) void
SchemeService.deleteSequence
(long sequenceId) Deletes the given sequencevoid
AuditService.deleteSubscriptions
(long[] ids) Deletes a list of Subscriptionsvoid
MessageService.deleteTemplates
(long[] ids) Deletes a selection of templatesvoid
MessageService.deleteTemplates
(String name) Deletes the templates with the given namevoid
DocumentService.deleteTicket
(long ticketId) void
WorkflowService.deleteTrigger
(long id) Deletes a workflow triggervoid
AutomationService.deleteTriggers
(long[] ids) DocumentService.deleteVersions
(long[] ids) Deletes a selection of versionsImpexService.deleteVersions
(long archiveId, Long[] versionIds) Deletes a set of versions from the given archiveWorkflowService.deploy
(GUIWorkflow workflow) Deploys a given workflowboolean
SystemService.disableTask
(String taskName) Disables the taskvoid
DocumentService.disableTicket
(long ticketId) void
DocumentService.emptyTrash()
Clear the user's trashboolean
SystemService.enableTask
(String taskName) Enables the taskvoid
DocumentService.enableTicket
(long ticketId) TenantService.encodeBrandingImage()
Encodes the uploaded branding imagevoid
Ends a task invoking the transitionvoid
DocumentService.enforceFilesIntoFolderStorage
(long folderId) Enforces that all the files in the given tree are stored in the storage configured in the owning folder.void
AutomationService.execute
(GUIAutomationRoutine routine, Long[] docIds, Long folderId) Executes a routine or a given scriptvoid
ReportService.execute
(long id, GUIAttribute[] parameters) Processes a reportboolean
DropboxService.exportDocuments
(String targetPath, long[] folderIds, Long[] docIds) Exports documents and folders into DropboxString[]
GDriveService.exportDocuments
(Long[] ids) Exports a selection of documents from LogicalDOC into GoogleDocsboolean
ShareFileService.exportDocuments
(String targetFolder, Long[] folderIds, Long[] docIds) Exports documents and folders into ShareFilleboolean
ZohoService.exportDocuments
(String targetFolderId, long[] folderIds, Long[] docIds) Exports documents and folders into ZohoDocumentService.extractEmail
(long docId, String fileVersion) Extracts the email representation from a .eml or .msg fileCalendarService.find
(GUICalendarEventSearchCriteria criteria) Searches for eventsDropboxService.finishAuthorization
(String authorizationCode) Ends the authorization code and saves the access token in the databaseString[]
TwoFactorsAuthenticationService.generateGoogleAuthorizationCredentials
(String account) Creates new credentials of the given account name.void
SignService.generateNewCertificate()
Generates a self-signes certificate for the current user.void
SignService.generateNewKeystore
(GUIKeystore keystore) Discards the actual key store and generates a new oneTwoFactorsAuthenticationService.generateYubiKeyCredentials
(String key) Saves the YubiKey credentials in the given user.DashletService.get
(long dashletId) Gets a dashletGets a dashletEmailAccountService.get
(long id) Loads a given account from the databaseLDAPService.get
(long serverId) Loads external authentication settingsLoads a given configuration from the databaseVIAService.get()
Retrieves the settingsLoads a given workflow from the databaseTemplateService.getAttributes
(long templateId, GUIExtensibleObject extensibleObject) Retrieves all attributes of the specified templateAttributeSetService.getAttributeSet
(long setId) Loads a given set from the databaseAttributeSetService.getAttributeSets()
Loads all the sets from the databaseDocumentService.getById
(long docId) Retrieves a specific document by its IDFormService.getById
(long id) Retrieves a specific form by its IDWorkflowService.getCompletionDiagram
(String workflowName, Integer version, String processInstanceId) Loads a given workflow to display a completion diagramDocumentService.getContentAsString
(long docId) Retrieves the document's content as a stringCalendarService.getEvent
(long eventId) Gets an eventFolderService.getFolder
(long folderId, boolean computePath, boolean computeDocs, boolean computeSubfolders) Gets the Folder initializing the permissions.ImportFolderService.getImportFolder
(long id) Loads a given import folder from the databaseSearchEngineService.getInfo()
Loads a search engine that contains all search engine details.MessageService.getMessage
(long messageId, boolean markAsRead) Gets the MessageDocumentService.getNotes
(long docId, String fileVersion, Collection<String> types) Retrieves the notes of a documentString[]
UpdateService.getPatchNotes
(String patchFileName) Retrieves more informations from the patchGUIValue[]
SystemService.getPlugins()
Retrieves all plug-insRetentionPoliciesService.getPolicy
(long id) Loads a given policy from the databaseFormService.getPreFilledLink
(GUIForm form, String responderEmail) Generates the pre-filled link for the web formDocumentService.getRating
(long docId) Retrieves the rating of the given documentReportService.getReport
(long id, boolean withLog) Loads a given report from the databaseReportService.getReportParameters
(long id) Loads the attributes defined in the given reportReportService.getReports()
Loads all the reportsAutomationService.getRoutine
(long id) Loads a given routine from the databaseTagService.getSettings()
Gets the tag settingsStampService.getSignature()
Loads the stamp that represents the signature of the customer.DocuSignService.getSigners
(String envelopeId) Retrieves the list of signers of a given envelopeStampService.getStamp
(long stampId) Loads a given stamp from the databaseLoads a given stamp from the databaseGUIParameter[][]
SystemService.getStatistics
(String locale) Retrieves all the statistics parameters.SyndicationService.getSyndication
(long id) Loads a given syndication from the databaseGUITag[]
TagService.getTagCloud()
Loads the tag cloud from the serverSystemService.getTaskByName
(String taskName, String locale) Retrieves a specific task by its nameBarcodeService.getTemplate
(long templateId) Loads a given template from the databaseMessageService.getTemplate
(long templateId) Gets the templateTemplateService.getTemplate
(long templateId) Loads a given template from the databaseZonalOCRService.getTemplate
(long templateId) Loads a given template from the databaseAutomationService.getTrigger
(long id) Loads a given trigger from the databaseReadingRequestService.getUnconfimedReadings()
Retrieves all the unconfirmed readings by the current userString[]
UpdateService.getUpdateNotes
(String updateFileName) Retrieves more informations from the updateSignService.getUploadedContent()
Read the uploaded file and returns it's contentDocumentService.getUserRating
(long docId) Retrieves the vote of the current user on the specified documentDocumentService.getVersionsById
(long id1, long id2) Retrieves two specific versions by its IDWorkflowService.getWorkflowDetailsByTask
(String taskId) Retrieves all the info of the workflow of the given taskvoid
SignService.imporKeystore
(GUIKeystore keystore) TenantService.importBrandingPackage()
Imports the uploaded branding packagevoid
SignService.importCertificate
(String certificate, String privateKey) Imports an uploaded certificateint
DropboxService.importDocuments
(long targetFolder, String[] paths) void
GDriveService.importDocuments
(String[] resourceIds, long targetFolderId, String format) Imports some Google documents into LogicalDOCint
ShareFileService.importDocuments
(long targetFolder, String[] itemIds) int
ZohoService.importDocuments
(long targetFolder, String[] folderCompositeIds, String[] documentIds) Exports documents and folders from Zoho into LogicalDOCWorkflowService.importSchema()
Imports a new workflow schema already uploadedGUIValue[]
LDAPService.importUsers
(String[] usernames, long serverId) Imports a selection of usersvoid
DocumentService.indexDocuments
(Long[] docIds) Indexes the given set of documentsFolderService.inheritRights
(long folderId, long rightsFolderId) Inherits the rights of another foldervoid
SystemService.initializePlugin
(String plugin) Launches the initialization of a pluginvoid
SystemService.installPlugin()
Installs the uploaded plugin packagevoid
Invites the users to join the chatvoid
Invites by email a set of recipients to fill out the given formboolean
DocuSignService.isAuthorized()
Checks if the current user is authorized to interact with DocuSignboolean
ShareFileService.isAuthorized()
Checks if the current user is authorized to interact with ShreFileboolean
DropboxService.isConnected()
Checks if the user has connected the LogicalDOC application to his Dropbox accountboolean
SignService.isVisualSignatureEnabled()
void
DocumentService.linkDocuments
(Long[] inDocIds, Long[] outDocIds) Links a set of documentsWorkflowService.list()
Lists all the workflows on the databaseGUIUser[]
Search for users in the LDAP repositoryContactService.load
(long id) Loads a contact from the databaseImpexService.load
(long archiveId) Loads a given archiveSchemeService.load()
Load all Custom Identifiers rulesLoads a saved searchTenantService.load
(long tenantId) Loads a given tenantSettingService.loadConverterParameters
(String converter) Loads the parameters of a specified converterDashletService.loadDashlets()
Loads all the dashlet definitionsSettingService.loadEmailSettings()
Loads email settings (SMTP connection)SettingService.loadGUISettings()
Load the GUI settingsImpexService.loadIncremental
(long id) Loads an incremental configurationSignService.loadKeystore
(long tenantId) Gets the keystore's metadata of the given tenantUpdateService.loadPatch()
Loads a new patchSettingService.loadProtocolSettings()
Loads web services, webDav and other protocol settingsSchemeService.loadSequences()
Loads the list of sequencesDocuSignService.loadSettings()
Retrieves the DocuSign settings from the server.String[]
GDriveService.loadSettings()
Save the settings used by the Google Drive moduleOCRService.loadSettings()
Loads the OCR settingsSettingService.loadSettings()
Loads the complete settings setString[]
ShareFileService.loadSettings()
Retrieve the settings saved for connecting to FileShareString[]
ZohoService.loadSettings()
Save the settings used by the Zoho moduleSettingService.loadSettingsByNames
(String[] names) Loads a set of settings valuesGUITask[]
Retrieves all tasks.GUIValue[]
FolderService.loadTemplates()
Loads the folders templatesMessageService.loadTemplates
(String language, String type) Loads the templates configured for a given language and typeUpdateService.loadUpdate()
Loads a new update packageSettingService.loadWebserviceStats
(Long tenantId) Loads the usage stats of the webservicevoid
Locks a set of documentsvoid
ClusterService.makeGlobal
(String[] parameters) Shares a list of configuration parametersvoid
DocumentService.makeImmutable
(Long[] docIds, String comment) Makes immutable a set of documentsvoid
Unshares a list of configuration parametersvoid
DocumentService.markHistoryAsRead
(String event) Marks as read the histories related to the current user and the given event.void
DocumentService.markIndexable
(Long[] docIds, int policy) Marks a set of documents as indexablevoid
DocumentService.markUnindexable
(Long[] docIds) Marks a set of documents as unindexablevoid
BarcodeService.markUnprocessable
(long[] ids) Marks a set of documents as not processablevoid
ZonalOCRService.markUnprocessable
(long[] ids) Marks a set of documents as not processableMerges a set of documents into a single PDFvoid
FolderService.merge
(long[] folderIds, long targetId) Merges some folders to a target foldervoid
FolderService.move
(long[] folderIds, long targetId) Moves some folders under a target foldervoid
ReadingRequestService.notityReadingRequest
(long readingId) Notifies again a reading request.ContactService.parseContacts
(boolean preview, GUIParseContactsParameters parameters) Reads the contacts that are about to be imported from CSV fileGUIValue[]
AttributeSetService.parseOptions
(long setId, String attribute) Reads the contacts that are about to be imported from CSVvoid
Pastes documents into the target foldervoid
FolderService.pasteAsAlias
(long[] docIds, long folderId, String type) void
Posts a message to the chatBarcodeService.process
(long docId) Processes the given documentZonalOCRService.process
(long docId) Processes the given documentFormService.processImage()
Processes an uploaded image for being used as form headerDocumentService.promoteVersion
(long docId, String version) If you promote a prior version, what it does is make it the default version again.void
SearchEngineService.purge()
Launches the purgeExecutes a low-level query in the fulltext indexFolderService.readImage()
Read the uploaded image and converts it into Base64WorkflowService.reassignTask
(String taskId, String userId) The task is assigned to another uservoid
Removes a set of entries from the indexvoid
WorkflowService.removeDocument
(String taskId, long docId) Detaches a document from a workflowString[]
SettingService.removeStorage
(int storageId) Tries to delete a storage and fails in case at least one folder is using it and also if the storage is marked as the default write onevoid
Removes an available from the list of available tagsvoid
StampService.removeUsers
(long[] userIds, long stampId) Remove users from stampRenames the given documentvoid
Renames the given foldervoid
Rename an existing tag to another labelvoid
void
RetentionPoliciesService.reorder
(long[] ids) Reorder the policiesvoid
SearchEngineService.reorderTokenFilters
(String[] filters) Reorders the token filters.DocumentService.replaceAlias
(long aliasId) Replaces an alias with a copy of the original filevoid
DocumentService.replaceFile
(long docId, String fileVersion, String comment) Replaces the file associated to a given versionvoid
BarcodeService.rescheduleAll()
Reschedule all documents for processingvoid
SearchEngineService.rescheduleAll
(boolean dropIndex) Reschedule all entries for indexingvoid
ZonalOCRService.rescheduleAll()
Reschedule all documents for processingvoid
EmailAccountService.resetCache
(long id) Cleans the cachevoid
ImportFolderService.resetCache
(long id) Cleans the cachevoid
SyndicationService.resetCache
(long id) Cleans the cachevoid
EmailAccountService.resetCounter
(long id) Reset the import countervoid
ImportFolderService.resetCounter
(long id) Reset the import countervoid
SchemeService.resetSequence
(long sequenceId, long value) Reset the numbering of a given sequencevoid
SystemService.restart()
Restarts the applicationvoid
Restores a given documentvoid
Restores a given folderAttributeSetService.save
(GUIAttributeSet set) Creates or updates a setBarcodeService.save
(GUIBarcodeTemplate template) Creates or updates a templatevoid
ContactService.save
(GUIContact contact) Saves a contact in the databasevoid
DashletService.save
(GUIDashlet dashlet) Saves a dashletDocumentService.save
(GUIDocument document) Saves the document in the DBEmailAccountService.save
(GUIEmailAccount account) Creates or updates an accountSaves the folder in the DBSaves / Creates a formImpexService.save
(GUIArchive archive) Saves/Updates a given archiveImportFolderService.save
(GUIImportFolder importFolder) Creates or updates an import folderLDAPService.save
(GUILDAPServer ldapServer) Saves external authentication settingsvoid
MessageService.save
(GUIMessage message, long[] recipientIds) Updates a reportRetentionPoliciesService.save
(GUIRetentionPolicy policy) Creates or updates a retention policyvoid
Creates or updates a configurationvoid
SearchEngineService.save
(GUISearchEngine searchEngine) Saves search engine settingsboolean
SearchService.save
(GUISearchOptions options) Saves the search options in the user's working dirCreates or updates a stampSyndicationService.save
(GUISyndication syndication) Creates or updates a syndicationTemplateService.save
(GUITemplate template) Creates or updates a templateSaves/Updates a given tenantVIAService.save
(GUIVIASettings settings) Saves the settingsWorkflowService.save
(GUIWorkflow workflow) Creates or updates a workflowZonalOCRService.save
(GUIOCRTemplate template) Creates or updates a templatevoid
DashletService.saveDashlets
(GUIDashlet[] dashlets) Saves the dashlet definitionsDocumentService.saveEmailAttachment
(long docId, String fileVersion, String attachmentFileName) Extracts an email attachment and saves it in the same folder of the documentvoid
SettingService.saveEmailSettings
(GUIEmailSettings settings) Saves email settings (SMTP connection)void
CalendarService.saveEvent
(GUICalendarEvent event) Saves an event into the calendarvoid
SettingService.saveExtensionAliases
(String extension, String aliases) Persists new aliases for the given extensionvoid
SettingService.saveFirewallSettings
(GUIParameter[] settings) Saves settings related to the firewallvoid
StampService.saveImage
(long stampId) Saves the stamp's image already uploadedImpexService.saveIncremental
(GUIIncrementalArchive incremental) Saves the passed incremental configurationvoid
SignService.saveKeystore
(GUIKeystore keystore) void
DocumentService.saveNotes
(long docId, GUIDocumentNote[] notes, Collection<String> types) Saves a set of notesvoid
AttributeSetService.saveOptions
(long setId, String attribute, GUIValue[] options) Saves the list of all possible optionsint
DocumentService.saveRating
(GUIRating rating) Save a rating vote on a documentvoid
SettingService.saveRegistration
(String name, String email, String organization, String website) Saves the registration settingsAutomationService.saveRoutine
(GUIAutomationRoutine routine) Creates or updates a routineGDriveService.saveSettings
(String clientId, String clientSecret) Save the settings used by the Google Drive modulevoid
SettingService.saveSettings
(GUIParameter[] settings) Saves settingsZohoService.saveSettings
(String clientId, String clientSecret) Save the settings used by the Zoho modulevoid
SettingService.saveStorageSettings
(GUIParameter[] settings) Saves settings related to the storageSaves the taskvoid
FolderService.saveTemplates
(GUIValue[] templates) Saves the passed folder templatesvoid
MessageService.saveTemplates
(GUIMessageTemplate[] templates) Saves the given templatesvoid
SearchEngineService.saveTokenFilterSettings
(String filter, GUIParameter[] settings) Saves the settings of the specified token filterAutomationService.saveTrigger
(GUIAutomationTrigger trigger) Creates or updates a triggervoid
WorkflowService.saveTrigger
(String folderId, String workflowId, String templateId, String events) Save a new workflow trigger on the given folder with the given workflowId and templateIdvoid
DashletService.saveUserDashlets
(GUIDashlet[] dashlets) Saves the user's dashlet configurationSearch in documents into Google DriveSearchService.search
(GUISearchOptions options) Performs a search against the databaseSystemService.search
(Long userId, Date from, Date till, int maxResult, String historySid, String[] event, Long rootFolderId) SystemService.searchApiCalls
(Long userId, Date from, Date till, String callSid, String protocol, String uri, int maxResult) DocumentService.sendAsEmail
(GUIEmail email, String locale) Sends a document as email(attachment or download ticket)DocuSignService.sendEnvelope
(GUIDocuSignSettings envelope) Creates the envelope and sends it to DocuSignvoid
SearchEngineService.setAliases
(String extension, String aliases) Sets the parser aliases for the given extension.void
FolderService.setFolderPagination
(long folderId, Integer startRecord, Integer pageSize) Sets the pagination informations for the visualization of the folders treevoid
SystemService.setGUILanguageStatus
(String language, boolean active) Changes the activation status of a languagevoid
SearchEngineService.setLanguageStatus
(String language, boolean active) Changes the activation status of a languagevoid
DocumentService.setPassword
(long docId, String password) Puts a password protection to the documentvoid
ImpexService.setStatus
(long archiveId, int status) Change the status of the given Archivevoid
SearchEngineService.setTokenFilterStatus
(String language, boolean active) Changes the activation status of a token filtervoid
ContactService.shareContacts
(long[] contactIds, long[] userIds, long[] groupIds) Shares contacts among a set of users and groupsvoid
SearchService.shareSearch
(String name, long[] userIds, long[] groupIds) Shares a search among a set of users and groupsvoid
SignService.signDocuments
(Long[] docIds, String reason, int page, String signX, String signY, String signWidth) void
Splits a document using different options, the splitted segments are saved in the same folder as the original PDF with -N prefix.DropboxService.startAuthorization()
Starts the authorization process and returns the Dropbox authorization page URL to be shown to the uservoid
ImpexService.startImport
(String folderName) Create a new import archive for the specified bundle foldervoid
WorkflowService.startWorkflow
(String workflowName, String workflowDescription, String tag, String color, Long[] docIds) Start a workflow with the given name and associated to the documents with the given doc idsvoid
ReportService.storeUploadedDesign
(long id) Store the uploaded design file in the given reportvoid
AuditService.subscribeDocuments
(Long[] docIds, String[] events, Long userId, Long groupId) Subscribes a selection of documentsvoid
AuditService.subscribeFolder
(long folderId, boolean currentOnly, String[] events, Long userId, Long groupId) Subscribes a folderboolean
EmailAccountService.test
(long id) Test the connection to the given accountboolean
ImportFolderService.test
(long id) Tests the connection to the given import folderboolean
SyndicationService.test
(long id) Test the connection to the given syndicationboolean
LDAPService.testConnection
(GUILDAPServer ldapServer) Tests the connectionboolean
Tests the SMTP connectionboolean
SettingService.testStorage
(int id) Tests a storage (read/write access)void
WorkflowService.turnBackTaskToPool
(String taskId) The task is reassigned to the pooled usersvoid
DocumentService.unarchiveDocuments
(long[] docIds) Restores a given set of archived documentsvoid
Undeploys a given workflowvoid
SystemService.uninstallPlugin
(String plugin) Uninstalls the given pluginvoid
Unlocks a set of documentsvoid
SearchEngineService.unlock()
Unlocks the indexerboolean
Checks if the document can be accessed with the given passwordvoid
SystemService.unscheduleJobs
(GUIValue[] jobs) Unschedules a selection of jobsvoid
DocumentService.unsetPassword
(long docId, String password) Removes the password protection from the documentvoid
Changes a set of subscriptionsvoid
DocumentService.updateBookmark
(GUIBookmark bookmark) Updates a single bookmark's datavoid
DocumentService.updateLink
(long id, String type) Updates the links typevoid
DocumentService.updateNote
(long docId, long noteId, String note) Updates a document note on the given documentint
DocumentService.updatePages
(long docId) Counts the pages of a document and updates the DB.BarcodeService.updateZone
(GUIBarcodeZone zone) Updates a single zone, if the zone does not exist it will be createdZonalOCRService.updateZone
(GUIZone zone) Updates a single zone, if the zone does not exist it will be createdGDriveService.upload
(long docId) Uploads a document to Google DriveZohoService.upload
(long docId) Uploads a document to Zoho.void
DocumentService.validate
(GUIDocument document) Validates the metadataDocuSignService.validateEnvelope
(Collection<Long> docIds) Checks if a collection of document can be put into an envelope, that is if all of them define the docusign tabs annotations. -
Uses of ServerException in com.logicaldoc.gui.login.client.services
Modifier and TypeMethodDescriptionTfaService.generateKey
(String username) Notifies the server to send a secret key for the userboolean
LoginService.isSecretKeyRequired
(String username, String deviceId) Check if a secret key must be provided by the uservoid
LoginService.resetPassword
(String username, String emailAddress, String productName) Reset the password for the given email. -
Uses of ServerException in com.logicaldoc.gui.setup.client.services
Modifier and TypeMethodDescriptionvoid
SetupService.securityCheck()
Performs simple security check to enforce that only the admin can go through the setupvoid
Performs a system setup. -
Uses of ServerException in com.logicaldoc.web.service
Modifier and TypeMethodDescriptionvoid
DocumentServiceImpl.addBookmarks
(Long[] ids, int type) DocumentServiceImpl.addDocuments
(boolean importZip, String charset, boolean immediateIndexing, GUIDocument metadata) DocumentServiceImpl.addDocuments
(String language, long folderId, boolean importZip, String charset, boolean immediateIndexing, Long templateId) long
void
void
SecurityServiceImpl.addUserToGroup
(long groupId, long userId) void
AttributeSetServiceImpl.applyAllToTemplates
(long setId, String attributeName) void
FolderServiceImpl.applyGridLayout
(long folderId) void
AttributeSetServiceImpl.applyInitializationToTemplates
(long setId, String attribute) void
FolderServiceImpl.applyMetadata
(long parentId) void
FolderServiceImpl.applyOCR
(long parentId) void
FolderServiceImpl.applyRights
(GUIFolder folder, boolean subtree) void
SecurityServiceImpl.applyRights
(GUIMenu menu) void
FolderServiceImpl.applyStorage
(long parentId) void
FolderServiceImpl.applyTags
(long parentId) void
FolderServiceImpl.applyTemplate
(long folderId, long templateId, boolean inheritSecurity) void
AttributeSetServiceImpl.applyValidationToTemplates
(long setId, String attribute) void
DocumentServiceImpl.archiveDocuments
(Long[] docIds, String comment) long
DocumentServiceImpl.archiveFolder
(long folderId, String comment) DocumentServiceImpl.bulkUpdate
(Long[] ids, GUIDocument vo, boolean ignoreEmptyFields) void
SecurityServiceImpl.changeStatus
(long userId, boolean enabled) SearchEngineServiceImpl.check()
DocumentServiceImpl.checkin
(GUIDocument document, boolean major) DocumentServiceImpl.checkinContent
(long docId, String content) void
void
DocumentServiceImpl.cleanUploadedFileFolder()
void
SecurityServiceImpl.cloneWorkTimes
(long srcUserId, long[] userIds, long[] groupIds) long[]
FolderServiceImpl.computeStats
(long folderId) void
SystemServiceImpl.confirmUpdate()
void
FolderServiceImpl.copyFolders
(long[] folderIds, long targetId, boolean foldersOnly, String securityOption, GUIFolder model) long
DocumentServiceImpl.countDocuments
(long[] folderIds, int status) long
TemplateServiceImpl.countDocuments
(long templateId) long
SearchEngineServiceImpl.countEntries()
FolderServiceImpl.createAlias
(long parentId, long foldRef) DocumentServiceImpl.createDocument
(GUIDocument document, String content) String[]
DocumentServiceImpl.createDownloadTicket
(long docId, int type, String suffix, Integer expireHours, Date expireDate, Integer maxDownloads, Integer maxViews) DocumentServiceImpl.createWithContent
(GUIDocument vo, String content, boolean checkout) void
DocumentServiceImpl.deDuplicate
(Long folderId, boolean retainNewest) void
AttributeSetServiceImpl.delete
(long setId) void
ContactServiceImpl.delete
(long[] ids) void
DashletServiceImpl.delete
(long dashletId) void
void
FolderServiceImpl.delete
(long[] folderIds) void
MessageServiceImpl.delete
(long[] ids) void
void
TemplateServiceImpl.delete
(long templateId) void
DocumentServiceImpl.deleteBookmarks
(long[] bookmarkIds) void
DocumentServiceImpl.deleteFromTrash
(Long[] ids) void
FolderServiceImpl.deleteFromTrash
(Long[] ids) void
SecurityServiceImpl.deleteGroup
(long groupId) void
DocumentServiceImpl.deleteLinks
(long[] ids) void
SecurityServiceImpl.deleteMenu
(long menuId) void
DocumentServiceImpl.deleteNotes
(long[] ids) void
AttributeSetServiceImpl.deleteOptions
(long setId, String attribute, String[] values) DocumentServiceImpl.deleteRating
(long id) void
MessageServiceImpl.deleteTemplates
(long[] ids) void
MessageServiceImpl.deleteTemplates
(String name) void
DocumentServiceImpl.deleteTicket
(long ticketId) void
SecurityServiceImpl.deleteTrustedDevices
(String[] ids) void
SecurityServiceImpl.deleteUser
(long userId) DocumentServiceImpl.deleteVersions
(long[] ids) boolean
SystemServiceImpl.disableTask
(String taskName) void
DocumentServiceImpl.disableTicket
(long ticketId) void
DocumentServiceImpl.emptyTrash()
boolean
SystemServiceImpl.enableTask
(String taskName) void
DocumentServiceImpl.enableTicket
(long ticketId) void
DocumentServiceImpl.enforceFilesIntoFolderStorage
(long folderId) DocumentServiceImpl.extractEmail
(long docId, String fileVersion) DashletServiceImpl.get
(long dashletId) TemplateServiceImpl.getAttributes
(long templateId, GUIExtensibleObject extensibleObject) AttributeSetServiceImpl.getAttributeSet
(long setId) AttributeSetServiceImpl.getAttributeSet
(String name) AttributeSetServiceImpl.getAttributeSets()
DocumentServiceImpl.getById
(long docId) DocumentServiceImpl.getContentAsString
(long docId) InfoServiceImpl.getCronDescription
(String expression, String locale) FolderServiceImpl.getFolder
(long folderId, boolean computePath, boolean computeDocs, boolean computeSubfolders) SecurityServiceImpl.getGroup
(long groupId) SearchEngineServiceImpl.getInfo()
GUIMenu[]
MessageServiceImpl.getMessage
(long messageId, boolean markAsRead) DocumentServiceImpl.getNotes
(long docId, String fileVersion, Collection<String> types) GUIValue[]
SystemServiceImpl.getPlugins()
DocumentServiceImpl.getRating
(long docId) TagServiceImpl.getSettings()
GUIParameter[][]
SystemServiceImpl.getStatistics
(String locale) GUITag[]
TagServiceImpl.getTagCloud()
SystemServiceImpl.getTaskByName
(String taskName, String locale) MessageServiceImpl.getTemplate
(long templateId) TemplateServiceImpl.getTemplate
(long templateId) SecurityServiceImpl.getUser
(long userId) DocumentServiceImpl.getUserRating
(long docId) DocumentServiceImpl.getVersionsById
(long id1, long id2) void
DocumentServiceImpl.indexDocuments
(Long[] docIds) FolderServiceImpl.inheritRights
(long folderId, long rightsFolderId) void
SystemServiceImpl.initializePlugin
(String pluginId) void
SystemServiceImpl.installPlugin()
boolean
LoginServiceImpl.isSecretKeyRequired
(String username, String deviceId) SecurityServiceImpl.isTrustedDevice
(String deviceId) void
DocumentServiceImpl.linkDocuments
(Long[] inDocIds, Long[] outDocIds) ContactServiceImpl.load
(long id) SecurityServiceImpl.loadBlockedEntities()
SettingServiceImpl.loadConverterParameters
(String converter) DashletServiceImpl.loadDashlets()
SettingServiceImpl.loadEmailSettings()
SettingServiceImpl.loadGUISettings()
SettingServiceImpl.loadProtocolSettings()
SecurityServiceImpl.loadSession
(Session sess, String locale) Used internally by login procedures, instantiates a new GUISession by a given authenticated userSecurityServiceImpl.loadSettings()
SettingServiceImpl.loadSettings()
SettingServiceImpl.loadSettingsByNames
(String[] names) GUITask[]
GUIValue[]
FolderServiceImpl.loadTemplates()
MessageServiceImpl.loadTemplates
(String language, String type) SettingServiceImpl.loadWebserviceStats
(Long tenantId) void
void
DocumentServiceImpl.makeImmutable
(Long[] docIds, String comment) void
DocumentServiceImpl.markHistoryAsRead
(String event) void
DocumentServiceImpl.markIndexable
(Long[] docIds, int policy) void
DocumentServiceImpl.markUnindexable
(Long[] docIds) void
FolderServiceImpl.merge
(long[] folderIds, long targetId) void
FolderServiceImpl.move
(long[] folderIds, long targetId) ContactServiceImpl.parseContacts
(boolean preview, GUIParseContactsParameters parameters) GUIValue[]
AttributeSetServiceImpl.parseOptions
(long setId, String attribute) void
void
FolderServiceImpl.pasteAsAlias
(long[] docIds, long folderId, String type) DocumentServiceImpl.promoteVersion
(long docId, String version) void
SearchEngineServiceImpl.purge()
FolderServiceImpl.readImage()
void
void
SecurityServiceImpl.removeBlockedEntities
(long[] ids) void
SecurityServiceImpl.removeFromGroup
(long groupId, long[] userIds) String[]
SettingServiceImpl.removeStorage
(int storageId) void
void
void
SearchEngineServiceImpl.reorderTokenFilters
(String[] filters) DocumentServiceImpl.replaceAlias
(long aliasId) void
DocumentServiceImpl.replaceFile
(long docId, String fileVersion, String comment) void
SecurityServiceImpl.replicateUsersSettings
(long masterUserId, Long[] userIds, boolean gui, boolean groups) void
SearchEngineServiceImpl.rescheduleAll
(boolean dropIndex) void
SecurityServiceImpl.resetAvatar
(long userId) void
LoginServiceImpl.resetPassword
(String username, String emailAddress, String productName) void
SystemServiceImpl.restart()
void
void
AttributeSetServiceImpl.save
(GUIAttributeSet guiAttributeSet) void
ContactServiceImpl.save
(GUIContact contact) void
DashletServiceImpl.save
(GUIDashlet guiDashlet) DocumentServiceImpl.save
(GUIDocument guiDocument) void
MessageServiceImpl.save
(GUIMessage message, long[] recipientIds) void
SearchEngineServiceImpl.save
(GUISearchEngine searchEngine) boolean
SearchServiceImpl.save
(GUISearchOptions options) TemplateServiceImpl.save
(GUITemplate guiTemplate) void
SecurityServiceImpl.saveAvatar
(long userId) void
DashletServiceImpl.saveDashlets
(GUIDashlet[] dashlets) DocumentServiceImpl.saveEmailAttachment
(long docId, String fileVersion, String attachmentFileName) void
SettingServiceImpl.saveEmailSettings
(GUIEmailSettings settings) void
SettingServiceImpl.saveExtensionAliases
(String extension, String aliases) void
SettingServiceImpl.saveFirewallSettings
(GUIParameter[] settings) SecurityServiceImpl.saveInterfaceSettings
(GUIUser user) void
void
DocumentServiceImpl.saveNotes
(long docId, GUIDocumentNote[] notes, Collection<String> types) void
AttributeSetServiceImpl.saveOptions
(long setId, String attribute, GUIValue[] values) SecurityServiceImpl.saveProfile
(GUIUser user) int
DocumentServiceImpl.saveRating
(GUIRating rating) void
SettingServiceImpl.saveRegistration
(String name, String email, String organization, String website) boolean
SecurityServiceImpl.saveSettings
(GUISecuritySettings settings) void
SettingServiceImpl.saveSettings
(GUIParameter[] settings) void
SettingServiceImpl.saveStorageSettings
(GUIParameter[] settings) void
FolderServiceImpl.saveTemplates
(GUIValue[] templates) void
MessageServiceImpl.saveTemplates
(GUIMessageTemplate[] templates) void
SearchEngineServiceImpl.saveTokenFilterSettings
(String filter, GUIParameter[] settings) void
DashletServiceImpl.saveUserDashlets
(GUIDashlet[] dashlets) SearchServiceImpl.search
(GUISearchOptions options) SystemServiceImpl.search
(Long userId, Date from, Date till, int maxResult, String historySid, String[] events, Long rootFolderId) SystemServiceImpl.searchApiCalls
(Long userId, Date from, Date till, String callSid, String protocol, String uri, int maxResult) GUIUser[]
SecurityServiceImpl.searchUsers
(String username, String groupId) void
SetupServiceImpl.securityCheck()
DocumentServiceImpl.sendAsEmail
(GUIEmail guiMail, String locale) void
SearchEngineServiceImpl.setAliases
(String extension, String aliases) void
FolderServiceImpl.setFolderPagination
(long folderId, Integer startRecord, Integer pageSize) void
SystemServiceImpl.setGUILanguageStatus
(String language, boolean active) void
SearchEngineServiceImpl.setLanguageStatus
(String language, boolean active) void
DocumentServiceImpl.setPassword
(long docId, String password) void
SearchEngineServiceImpl.setTokenFilterStatus
(String filter, boolean active) void
void
ContactServiceImpl.shareContacts
(long[] contactIds, long[] userIds, long[] groupIds) void
SearchServiceImpl.shareSearch
(String name, long[] userIds, long[] groupIds) SecurityServiceImpl.syncGeolocationDB
(String key) boolean
boolean
SettingServiceImpl.testStorage
(int id) SecurityServiceImpl.trustDevice
(String label) void
DocumentServiceImpl.unarchiveDocuments
(long[] docIds) void
SystemServiceImpl.uninstallPlugin
(String pluginId) void
void
SearchEngineServiceImpl.unlock()
boolean
void
SystemServiceImpl.unscheduleJobs
(GUIValue[] jobs) void
DocumentServiceImpl.unsetPassword
(long docId, String currentPassword) void
DocumentServiceImpl.updateBookmark
(GUIBookmark bookmark) void
SecurityServiceImpl.updateDeviceLabel
(long deviceId, String label) void
DocumentServiceImpl.updateLink
(long id, String type) void
DocumentServiceImpl.updateNote
(long docId, long noteId, String message) int
DocumentServiceImpl.updatePages
(long docId) void
DocumentServiceImpl.validate
(GUIDocument document)