Package com.openkm.sdk4j.definition

Interface BaseWizard

All Known Implementing Classes:

WizardImpl

public interface BaseWizard

BaseWizard

Author:

sochoa

Method Summary

Modifier and Type	Method	Description
void	addDigitalSignature(String uuid, int order)	Add digital signature.
void	addGroup(String uuid, String group, int order)	Add group.
void	addShowWizardCategories(String uuid, int order)	Add show wizard categories.
void	addShowWizardKeywords(String uuid, int order)	Add show wizard keywords.
void	addShowWizardOCRDataCapture(String uuid, int order)	Add show wizard ocr data capture.
void	addWorkflow(String uuid, String workflow, int order)	Add workflow.
void	cancelPostponedNode(String uuid)	Cancel postponed node.
void	deleteAll()	Delete all.
void	deleteByNode(String uuid)	Delete by node.
List<WizardNode>	findAllByUser()	Find all by user list.
List<WizardNode>	findByUser()	Find by user list.
WizardNode	findByUserAndUuid(String uuid)	Find by user and uuid wizard node.
boolean	hasWizardByUserAndNode(String uuid)	Has wizard by user and node boolean.
void	postponeNode(String uuid, Calendar date)	Postpone node.
void	removeDigitalSignature(String uuid)	Remove digital signature.
void	removeGroup(String uuid, String group)	Remove group.
void	removeShowWizardCategories(String uuid)	Remove show wizard categories.
void	removeShowWizardKeywords(String uuid)	Remove show wizard keywords.
void	removeShowWizardOCRDataCapture(String uuid)	Remove show wizard ocr data capture.
void	removeWorkflow(String uuid, String workflow)	Remove workflow.
void	setAutostart(String uuid)	Sets autostart.

Method Detail

findByUser

List<WizardNode> findByUser()
                     throws DatabaseException,
                            UnknownException,
                            WebserviceException

Find by user list.

Returns:

the list

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findAllByUser

List<WizardNode> findAllByUser()
                        throws DatabaseException,
                               UnknownException,
                               WebserviceException

Find all by user list.

Returns:

the list

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

findByUserAndUuid

WizardNode findByUserAndUuid(String uuid)
                      throws DatabaseException,
                             UnknownException,
                             WebserviceException

Find by user and uuid wizard node.

Parameters:

uuid - the uuid

Returns:

the wizard node

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

hasWizardByUserAndNode

boolean hasWizardByUserAndNode(String uuid)
                        throws DatabaseException,
                               UnknownException,
                               WebserviceException

Has wizard by user and node boolean.

Parameters:

uuid - the uuid

Returns:

the boolean

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteAll

void deleteAll()
        throws DatabaseException,
               UnknownException,
               WebserviceException

Delete all.

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

postponeNode

void postponeNode(String uuid,
                  Calendar date)
           throws DatabaseException,
                  UnknownException,
                  WebserviceException

Postpone node.

Parameters:

uuid - the uuid

date - the date

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

cancelPostponedNode

void cancelPostponedNode(String uuid)
                  throws DatabaseException,
                         UnknownException,
                         WebserviceException

Cancel postponed node.

Parameters:

uuid - the uuid

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteByNode

void deleteByNode(String uuid)
           throws DatabaseException,
                  UnknownException,
                  WebserviceException

Delete by node.

Parameters:

uuid - the uuid

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

addDigitalSignature

void addDigitalSignature(String uuid,
                         int order)
                  throws DatabaseException,
                         UnknownException,
                         WebserviceException

Add digital signature.

Parameters:

uuid - the uuid

order - the order of the action

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

removeDigitalSignature

void removeDigitalSignature(String uuid)
                     throws DatabaseException,
                            UnknownException,
                            WebserviceException

Remove digital signature.

Parameters:

uuid - the uuid

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

addShowWizardCategories

void addShowWizardCategories(String uuid,
                             int order)
                      throws DatabaseException,
                             UnknownException,
                             WebserviceException

Add show wizard categories.

Parameters:

uuid - the uuid

order - the order of the action

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

removeShowWizardCategories

void removeShowWizardCategories(String uuid)
                         throws DatabaseException,
                                UnknownException,
                                WebserviceException

Remove show wizard categories.

Parameters:

uuid - the uuid

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

addShowWizardKeywords

void addShowWizardKeywords(String uuid,
                           int order)
                    throws DatabaseException,
                           UnknownException,
                           WebserviceException

Add show wizard keywords.

Parameters:

uuid - the uuid

order - the order of the action

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

removeShowWizardKeywords

void removeShowWizardKeywords(String uuid)
                       throws DatabaseException,
                              UnknownException,
                              WebserviceException

Remove show wizard keywords.

Parameters:

uuid - the uuid

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

addShowWizardOCRDataCapture

void addShowWizardOCRDataCapture(String uuid,
                                 int order)
                          throws DatabaseException,
                                 UnknownException,
                                 WebserviceException

Add show wizard ocr data capture.

Parameters:

uuid - the uuid

order - the order of the action

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

removeShowWizardOCRDataCapture

void removeShowWizardOCRDataCapture(String uuid)
                             throws DatabaseException,
                                    UnknownException,
                                    WebserviceException

Remove show wizard ocr data capture.

Parameters:

uuid - the uuid

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

addGroup

void addGroup(String uuid,
              String group,
              int order)
       throws DatabaseException,
              UnknownException,
              WebserviceException

Add group.

Parameters:

uuid - the uuid

group - the group

order - the order of the action

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

removeGroup

void removeGroup(String uuid,
                 String group)
          throws DatabaseException,
                 UnknownException,
                 WebserviceException

Remove group.

Parameters:

uuid - the uuid

group - the group

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

addWorkflow

void addWorkflow(String uuid,
                 String workflow,
                 int order)
          throws DatabaseException,
                 UnknownException,
                 WebserviceException

Add workflow.

Parameters:

uuid - the uuid

workflow - the workflow

order - the order of the action

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

removeWorkflow

void removeWorkflow(String uuid,
                    String workflow)
             throws DatabaseException,
                    UnknownException,
                    WebserviceException

Remove workflow.

Parameters:

uuid - the uuid

workflow - the workflow

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setAutostart

void setAutostart(String uuid)
           throws DatabaseException,
                  UnknownException,
                  WebserviceException

Sets autostart.

Parameters:

uuid - the uuid

Throws:

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception