| Package | Description | 
|---|---|
| com.axemble.vdoc.sdk.interfaces | |
| com.axemble.vdoc.sdk.modules | 
| Modifier and Type | Method and Description | 
|---|---|
ICatalog | 
IStorageResource.getCatalog()
Gets the catalog of the resource 
 | 
ICatalog | 
IRole.getCatalog()
Deprecated.  
The catalog of the role. 
 | 
ICatalog | 
IProfile.getCatalog()  | 
ICatalog | 
IWorkflowContainer.getCatalog()
Retrieve the parent catalog. 
 | 
ICatalog | 
IWorkflow.getCatalog()  | 
ICatalog | 
IOperatorRole.getCatalog()
The catalog of the role. 
 | 
ICatalog | 
ILinkedResource.getCatalog()
Gets the catalog of the linked resource 
 | 
ICatalog | 
IWorkflowInstance.getCatalog()
Gets the catalog. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
IReport | 
IDelegationController.delegateOperatorRoles(ICatalog catalog,
                     Collection<? extends IOperatorRole> roles,
                     IUser user,
                     IUser substituteUser)
Allow to replace a user for the operator roles 
 | 
IReport | 
IDelegationController.delegateProfiles(ICatalog catalog,
                Collection<? extends IProfile> profiles,
                IUser user,
                IUser substituteUser)
Allow to replace a user for the profiles 
 | 
IReport | 
IDelegationController.delegateResources(ICatalog catalog,
                 Collection<? extends IOperatorRole> roles,
                 Collection<? extends IWorkflowInstance> resources,
                 IUser user,
                 IUser substituteUser)
Allow to replace a user for a specified set of workflow instances 
 | 
IReport | 
IDelegationController.delegateRoles(ICatalog catalog,
             Collection<? extends IRole> roles,
             Collection<? extends IWorkflowInstance> resources,
             IUser user,
             IUser substituteUser)
Deprecated. 
 
: use delegateOperatorRoles or delegateProfiles 
 | 
Collection | 
IViewController.evaluate(ICatalog catalog)
Evaluate the request on the catalog scope 
 | 
int | 
IViewController.evaluateSize(ICatalog catalog)
Evaluate the request on the catalog scope 
 | 
| Modifier and Type | Method and Description | 
|---|---|
ICatalog | 
IBaseWorkflowModule.createCatalog(IContext context,
             String name,
             String label)
Deprecated. 
 
: use createCatalog( IContext context, String name, String label, IProject project ) 
 | 
ICatalog | 
IBaseDocumentModule.createCatalog(IContext context,
             String name,
             String label,
             IProject project)
Allows to create a new catalog. 
 | 
ICatalog | 
IBaseWorkflowModule.createCatalog(IContext context,
             String name,
             String label,
             IProject project)
Allows to create a new catalog. 
 | 
ICatalog | 
IBaseDirectoryModule.getCatalog()
Gets the extended attributes catalog 
 | 
ICatalog | 
IBaseSiteModule.getCatalog(IContext context,
          ISite site)
Retrieves the catalog of the site. 
 | 
ICatalog | 
IBaseWorkflowModule.getCatalog(IContext context,
          String name)
Deprecated. 
 
: use getCatalog( IContext context, String name, IProject project ) 
 | 
ICatalog | 
IBaseWorkflowModule.getCatalog(IContext context,
          String name,
          int catalogType)
Deprecated. 
 
: use getCatalog( IContext context, String name, int catalogType, IProject project ) 
 | 
ICatalog | 
IBaseDocumentModule.getCatalog(IContext context,
          String name,
          int catalogType,
          IProject project)
Retrieves a catalog form its name. 
 | 
ICatalog | 
IBaseWorkflowModule.getCatalog(IContext context,
          String name,
          int catalogType,
          IProject project)
Retrieves a catalog form its name. 
 | 
ICatalog | 
IBaseWorkflowModule.getCatalog(IContext context,
          String name,
          IProject project)
Retrieves a catalog form its name. 
 | 
ICatalog | 
IBaseDocumentModule.getCatalog(IResourceDefinition resourceDefinition)
Gets a  
ICatalog object from a resource definitino. | 
ICatalog | 
IBaseWorkflowModule.getCatalog(IResourceDefinition resourceDefinition)
Gets a  
ICatalog object from a resource definitino. | 
ICatalog | 
IBaseDocumentModule.getCatalog(IStorageKey key)
Gets a catalog object from its identifier. 
 | 
ICatalog | 
IBaseWorkflowModule.getCatalog(IStorageKey key)
Gets a catalog object from its identifier. 
 | 
ICatalog | 
IBaseDocumentModule.getCatalog(IWorkflow workflow)
Retrieves the catalog of a  
IWorkflow object. | 
ICatalog | 
IBaseWorkflowModule.getCatalog(IWorkflow workflow)
Retrieves the catalog of a  
IWorkflow object. | 
| Modifier and Type | Method and Description | 
|---|---|
Collection<? extends ICatalog> | 
IBaseWorkflowModule.getAllCatalogs(IContext context)
Retrieves a collection of  
ICatalog object. | 
Collection<? extends ICatalog> | 
IBaseDocumentModule.getCatalogs(IContext context)
Retrieves a collection of  
ICatalog object. | 
Collection<? extends ICatalog> | 
IBaseWorkflowModule.getCatalogs(IContext context)
Deprecated. 
 
: use getCatalogs( IContext context, IProject project ) 
 | 
Collection<? extends ICatalog> | 
IBaseDocumentModule.getCatalogs(IContext context,
           int catalogType)
Retrieves a collection of  
ICatalog object. | 
Collection<? extends ICatalog> | 
IBaseWorkflowModule.getCatalogs(IContext context,
           int catalogType)
Deprecated. 
 
: use getCatalogs( IContext context, int catalogType, IProject project ) 
 | 
Collection<? extends ICatalog> | 
IBaseWorkflowModule.getCatalogs(IContext context,
           int catalogType,
           IProject project)
Retrieves a collection of  
ICatalog object. | 
Collection<? extends ICatalog> | 
IBaseDocumentModule.getCatalogs(IContext context,
           IProject project)
Retrieves a collection of  
ICatalog object. | 
Collection<? extends ICatalog> | 
IBaseWorkflowModule.getCatalogs(IContext context,
           IProject project)
Retrieves a collection of  
ICatalog object. | 
| Modifier and Type | Method and Description | 
|---|---|
IDynamicLocalizationsWrapper | 
IBaseWorkflowModule.createDynamicLocalizationsWrapper(IContext context,
                                 ICatalog catalog)
Creates a dynamicLocalizationsWrapper object by specifying the parent  
ICatalog object. | 
IOperatorRole | 
IBaseWorkflowModule.createOperatorRole(IContext context,
                  ICatalog catalog,
                  String name)
Creates a  
IOperatorRole into the catalog object. | 
IRole | 
IBaseDocumentModule.createRole(IContext context,
          ICatalog catalog,
          String name)
Creates a  
IRole into the catalog object. | 
IRole | 
IBaseWorkflowModule.createRole(IContext context,
          ICatalog catalog,
          String name)
Deprecated. 
 
: use createOperatorRole or createProfile 
 | 
IWorkflowContainer | 
IBaseDocumentModule.createWorkflowContainer(IContext context,
                       ICatalog catalog,
                       String name)
Creates a workflow container within a  
ICatalog object. | 
IWorkflowContainer | 
IBaseWorkflowModule.createWorkflowContainer(IContext context,
                       ICatalog catalog,
                       String name)
Creates a workflow container within a  
ICatalog object. | 
IList | 
IBaseDocumentModule.getList(IContext context,
       ICatalog catalog,
       String name)
Gets a list object from a catalog by its name. 
 | 
IList | 
IBaseWorkflowModule.getList(IContext context,
       ICatalog catalog,
       String name)
Gets a list object from a catalog by its name. 
 | 
Collection<? extends IList> | 
IBaseDocumentModule.getLists(IContext context,
        ICatalog catalog)
Gets a collection of a the lists available on a specified  
ICatalog object. | 
Collection<? extends IList> | 
IBaseWorkflowModule.getLists(IContext context,
        ICatalog catalog)
Gets a collection of a the lists available on a specified  
ICatalog object. | 
IOperatorRole | 
IBaseWorkflowModule.getOperatorRole(IContext context,
               ICatalog catalog,
               String name)
Retrieves a  
IOperatorRole object by its system name. | 
Collection<? extends IOperatorRole> | 
IBaseWorkflowModule.getOperatorRoles(IContext context,
                ICatalog catalog)
Retrieves a collection of  
IOperatorRole objects within a specified catalog. | 
IResourceDefinition | 
IBaseDocumentModule.getResourceDefinition(IContext context,
                     ICatalog catalog,
                     String name)
Retrieves a resource definition by specifying the  
ICatalog and its system name. | 
IResourceDefinition | 
IBaseWorkflowModule.getResourceDefinition(IContext context,
                     ICatalog catalog,
                     String name)
Retrieves a resource definition by specifying the  
ICatalog and its system name. | 
Collection<? extends IResourceDefinition> | 
IBaseDocumentModule.getResourceDefinitions(IContext context,
                      ICatalog catalog)
Retrieves all resource definitions by specifying the  
ICatalog | 
Collection<? extends IResourceDefinition> | 
IBaseWorkflowModule.getResourceDefinitions(IContext context,
                      ICatalog catalog)
Retrieves all resource definitions by specifying the  
ICatalog | 
Collection<? extends IResource> | 
IBaseDocumentModule.getResources(IContext context,
            ICatalog catalog)
Gets a collection of  
IResource objects from a catalog | 
Collection<? extends IResource> | 
IBaseWorkflowModule.getResources(IContext context,
            ICatalog catalog)
Gets a collection of  
IResource objects from a catalog | 
IRole | 
IBaseDocumentModule.getRole(IContext context,
       ICatalog catalog,
       String name)
Retrieves a  
IRole object by its system name. | 
IRole | 
IBaseWorkflowModule.getRole(IContext context,
       ICatalog catalog,
       String name)
Deprecated. 
 
: use getRole or getProfile 
 | 
Collection<? extends IRole> | 
IBaseDocumentModule.getRoles(IContext context,
        ICatalog catalog)
Retrieves a collection of  
IRole objects within a specified catalog. | 
Collection<? extends IRole> | 
IBaseWorkflowModule.getRoles(IContext context,
        ICatalog catalog)
Deprecated. 
 
: use getRoles or getProfiles 
 | 
Collection<? extends IVersion> | 
IBaseDocumentModule.getVersions(IContext context,
           ICatalog catalog)
Gets all the versions of a specified  
ICatalog object. | 
Collection<? extends IVersion> | 
IBaseDocumentModule.getVersions(IContext context,
           ICatalog catalog,
           String reference)
Gets all the versions with the same reference within a specified  
ICatalog object. | 
IView | 
IBaseWorkflowModule.getView(IContext context,
       ICatalog catalog,
       String viewName)
Retrieves a view by its name. 
 | 
Collection<? extends IView> | 
IBaseWorkflowModule.getViews(IContext context,
        ICatalog catalog)
Retrieves all the views associated with the catalog. 
 | 
IWorkflow | 
IBaseDocumentModule.getWorkflow(IContext context,
           ICatalog catalog,
           String name)
Retrieves a workflow within a  
IWorkflow object and from its system name. | 
IWorkflow | 
IBaseWorkflowModule.getWorkflow(IContext context,
           ICatalog catalog,
           String name)
Retrieves a workflow within a  
IWorkflow object and from its system name. | 
IWorkflowContainer | 
IBaseDocumentModule.getWorkflowContainer(IContext context,
                    ICatalog catalog,
                    String name)
Retrieves a  
IWorkflowContainer within a ICatalog by its system name | 
IWorkflowContainer | 
IBaseWorkflowModule.getWorkflowContainer(IContext context,
                    ICatalog catalog,
                    String name)
Retrieves a  
IWorkflowContainer within a ICatalog by its system name | 
Collection<? extends IWorkflowContainer> | 
IBaseDocumentModule.getWorkflowContainers(IContext context,
                     ICatalog catalog)
Retrieves a collection of  
IWorkflowContainer objects within a ICatalog object. | 
Collection<? extends IWorkflowContainer> | 
IBaseWorkflowModule.getWorkflowContainers(IContext context,
                     ICatalog catalog)
Retrieves a collection of  
IWorkflowContainer objects within a ICatalog object. | 
Collection<? extends IWorkflowInstance> | 
IBaseWorkflowModule.getWorkflowInstances(IContext context,
                    ICatalog catalog)
Gets all the workflow instances of a specified  
ICatalog object. | 
Collection<? extends IWorkflowInstance> | 
IBaseWorkflowModule.getWorkflowInstances(IContext context,
                    ICatalog catalog,
                    String reference)
Gets all the workflow instances with the same reference within a specified  
ICatalog object. | 
Collection<? extends IWorkflow> | 
IBaseDocumentModule.getWorkflows(IContext context,
            ICatalog catalog)
 | 
Collection<? extends IWorkflow> | 
IBaseWorkflowModule.getWorkflows(IContext context,
            ICatalog catalog)
 | 
IDynamicLocalizationsWrapper | 
IBaseWorkflowModule.setDynamicLocalizationsWrapperMessageForLanguage(IContext context,
                                                IDynamicLocalizationsWrapper dynamicLocalizationsWrapper,
                                                ICatalog catalog,
                                                String language,
                                                String message)
Creates a dynamicLocalizationsWrapper object by specifying the parent  
ICatalog object. | 
Copyright © 2019 Visiativ Software. All rights reserved.