Package | Description |
---|---|
com.axemble.vdoc.sdk.interfaces | |
com.axemble.vdoc.sdk.modules | |
com.axemble.vdoc.sdk.workflow.extensions |
Modifier and Type | Interface and Description |
---|---|
interface |
ILinkedResourceDefinition
This class defines a resource definition for linked resources.
|
interface |
IStorageResourceDefinition
This class defines a resource definition for storage resource.
|
interface |
IWorkflowResourceDefinition
This class defines a resource definition for a workflow.
|
Modifier and Type | Method and Description |
---|---|
IResourceDefinition |
IAttachmentTemplate.getDefinition()
Gets the associated resource definition.
|
IResourceDefinition |
IProperty.getDefinition()
Retrieves the
IResourceDefinition of the property. |
IResourceDefinition |
IResource.getDefinition()
Gets the definition of the resource
|
IResourceDefinition |
IProperty.getForeignResourceDefinition()
Gets the foreign resource definition.
|
Modifier and Type | Method and Description |
---|---|
void |
ISecurityController.addPermission(IGroup group,
IResourceDefinition storageDefinition,
int permissionLevel,
int... flags)
Adds access permissions to a group
|
void |
ISecurityController.addPermission(IGroup group,
IResourceDefinition storageDefinition,
int permissionLevel,
int organizationFilter,
IOrganization organization,
int localizationFilter,
ILocalization localization,
int... flags)
Adds access permissions to a group and allows to specify localization and organization scopes.
|
void |
ISecurityController.addPermission(int joker,
IResourceDefinition storageDefinition,
int permissionLevel,
int... flags)
Adds a special permission
|
void |
ISecurityController.addPermission(int joker,
IResourceDefinition storageDefinition,
int permissionLevel,
int organizationFilter,
IOrganization organization,
int localizationFilter,
ILocalization localization,
int... flags)
Adds a special permission
|
void |
ISecurityController.addPermission(IProfile profile,
IResourceDefinition storageDefinition,
int permissionLevel,
int... flags)
Adds access permissions to a profile
|
void |
ISecurityController.addPermission(IProfile profile,
IResourceDefinition storageDefinition,
int permissionLevel,
int organizationFilter,
IOrganization organization,
int localizationFilter,
ILocalization localization,
int... flags)
Adds access permissions to a profile and allows to specify localization and organization scopes.
|
void |
ISecurityController.addPermission(IUser user,
IResourceDefinition storageDefinition,
int permissionLevel,
int... flags)
Adds access permissions to a user for a
ISecuritySupport object. |
void |
ISecurityController.addPermission(IUser user,
IResourceDefinition storageDefinition,
int permissionLevel,
int organizationFilter,
IOrganization organization,
int localizationFilter,
ILocalization localization,
int... flags)
Adds access permissions to a user for a
ISecuritySupport object and allows to specify localization and organization scopes. |
Collection |
IViewController.evaluate(IResourceDefinition resourceDefinition)
Evaluate the request on the resource definition scope
|
int |
IViewController.evaluateSize(IResourceDefinition resourceDefinition)
Evaluate the request on the resource definition scope
|
boolean |
ISecurityController.hasPermission(IGroup group,
IResourceDefinition storageDefinition,
int permissionLevel,
int... flags)
Check the group permission on a specific object (no recursivity)
|
boolean |
ISecurityController.hasPermission(int joker,
IResourceDefinition storageDefinition,
int permissionLevel,
int... flags)
Check the special permission on a specific object (no recursivity)
|
boolean |
ISecurityController.hasPermission(IProfile profile,
IResourceDefinition storageDefinition,
int permissionLevel,
int... flags)
Check the profile permission on a specific object (no recursivity)
|
boolean |
ISecurityController.hasPermission(IUser user,
IResourceDefinition storageDefinition,
int permissionLevel,
int... flags)
Check the user permission on a specific object (no recursivity)
|
void |
ISecurityController.removePermission(IGroup group,
IResourceDefinition storageDefinition)
Remove a permission on a group
|
void |
ISecurityController.removePermission(IGroup group,
IResourceDefinition storageDefinition,
int organizationFilter,
IOrganization organization,
int localizationFilter,
ILocalization localization)
Remove a permission on a group
|
void |
ISecurityController.removePermission(int joker,
IResourceDefinition storageDefinition)
Remove a special permission
|
void |
ISecurityController.removePermission(int joker,
IResourceDefinition storageDefinition,
int organizationFilter,
IOrganization organization,
int localizationFilter,
ILocalization localization)
Remove a special permission
|
void |
ISecurityController.removePermission(IProfile profile,
IResourceDefinition storageDefinition)
Remove a permission on a profile
|
void |
ISecurityController.removePermission(IProfile profile,
IResourceDefinition storageDefinition,
int organizationFilter,
IOrganization organization,
int localizationFilter,
ILocalization localization)
Remove a permission on a profile
|
void |
ISecurityController.removePermission(IUser user,
IResourceDefinition storageDefinition)
Remove a permission on a user
|
void |
ISecurityController.removePermission(IUser user,
IResourceDefinition storageDefinition,
int organizationFilter,
IOrganization organization,
int localizationFilter,
ILocalization localization)
Remove a permission on a user
|
void |
IFile.setDefinition(IResourceDefinition definition)
Associates the specified definition with the file.
|
Modifier and Type | Method and Description |
---|---|
IResourceDefinition |
IBaseLibraryModule.createResourceDefinition(IContext context,
String name) |
IResourceDefinition |
IBaseWorkflowModule.getResourceDefinition(IContext context,
ICatalog catalog,
String name)
Retrieves a resource definition by specifying the
ICatalog and its system name. |
IResourceDefinition |
IBaseDocumentModule.getResourceDefinition(IContext context,
ICatalog catalog,
String name)
Retrieves a resource definition by specifying the
ICatalog and its system name. |
IResourceDefinition |
IBaseLibraryModule.getResourceDefinition(IContext context,
ILibrary library,
String name) |
IResourceDefinition |
IBaseSiteModule.getResourceDefinition(IContext context,
IPageContainer pageContainer,
String dataFormName) |
IResourceDefinition |
IBaseDirectoryModule.getResourceDefinition(IContext context,
String name)
Gets an extended attributes table
|
IResourceDefinition |
IBaseWorkflowModule.getResourceDefinition(IStorageKey key)
Gets a resource definition object from its identifier.
|
IResourceDefinition |
IBaseDocumentModule.getResourceDefinition(IStorageKey key)
Gets a resource definition object from its identifier.
|
IResourceDefinition |
IBaseLibraryModule.getResourceDefinition(Object object) |
Modifier and Type | Method and Description |
---|---|
Collection<? extends IResourceDefinition> |
IBaseWorkflowModule.getResourceDefinitions(IContext context,
ICatalog catalog)
Retrieves all resource definitions by specifying the
ICatalog |
Collection<? extends IResourceDefinition> |
IBaseDocumentModule.getResourceDefinitions(IContext context,
ICatalog catalog)
Retrieves all resource definitions by specifying the
ICatalog |
Collection<IResourceDefinition> |
IBaseLibraryModule.getResourceDefinitions(IContext context,
ILibrary library) |
Modifier and Type | Method and Description |
---|---|
IDataUnit |
IBaseDocumentModule.createDataUnit(IContext context,
IResourceDefinition resourceDefinition,
String reference)
Creates a storage resource object by specifying the
IResourceDefinition object, its reference. |
IDataUnit |
IBaseDocumentModule.createDataUnit(IContext context,
IResourceDefinition resourceDefinition,
String reference,
String label)
Creates a data unit object by specifying the
IResourceDefinition object, its reference, and its label. |
IStorageResource |
IBaseWorkflowModule.createStorageResource(IContext context,
IResourceDefinition resourceDefinition,
String reference)
Creates a storage resource object by specifying the
IResourceDefinition object, its reference. |
IStorageResource |
IBaseWorkflowModule.createStorageResource(IContext context,
IResourceDefinition resourceDefinition,
String reference,
String label)
Creates a storage resource object by specifying the
IResourceDefinition object, its reference, and its label. |
IVersion |
IBaseDocumentModule.createVersion(IContext context,
IResourceDefinition resourceDefinition,
String reference,
String label)
Creates a version object by specifying the
IResourceDefinition object, its reference, and its label. |
int |
IBaseWorkflowModule.generateChrono(IResourceDefinition resourceDefinition)
Deprecated.
: should not use this method anymore.
|
int |
IBaseDocumentModule.generateChrono(IResourceDefinition resourceDefinition)
Evaluate the next chrono based on the format specified on the Designer tool.
|
String |
IBaseWorkflowModule.generateReference(IResourceDefinition resourceDefinition)
Evaluate the next reference based on the format specified on the Designer tool.
|
String |
IBaseDocumentModule.generateReference(IResourceDefinition resourceDefinition)
Evaluate the next reference based on the format specified on the Designer tool.
|
String |
IBaseWorkflowModule.generateReference(IResourceDefinition resourceDefinition,
String format)
Deprecated.
: should not use this method anymore. The format argument is not supported.
|
String |
IBaseDocumentModule.generateReference(IResourceDefinition resourceDefinition,
String format)
Evaluate the next reference based on the passed format.
|
ICatalog |
IBaseWorkflowModule.getCatalog(IResourceDefinition resourceDefinition)
Gets a
ICatalog object from a resource definitino. |
ICatalog |
IBaseDocumentModule.getCatalog(IResourceDefinition resourceDefinition)
Gets a
ICatalog object from a resource definitino. |
IForm |
IBaseWorkflowModule.getForm(IContext context,
IResourceDefinition resourceDefinition,
String formName)
Gets a resource definition form by its name.
|
IForm |
IBaseDocumentModule.getForm(IContext context,
IResourceDefinition resourceDefinition,
String formName)
Gets a resource definition form by its name.
|
Collection<? extends IProperty> |
IBaseWorkflowModule.getProperties(IContext context,
IResourceDefinition resourceDefinition)
Gets all the properties of a specified definition.
|
Collection<? extends IProperty> |
IBaseDocumentModule.getProperties(IContext context,
IResourceDefinition resourceDefinition)
Gets all the properties of a specified definition.
|
Collection |
IBaseLibraryModule.getProperties(IContext context,
IResourceDefinition resourceDefinition) |
IProperty |
IBaseWorkflowModule.getProperty(IContext context,
IResourceDefinition resourceDefinition,
String name)
Gets a property definition by specifying the
IResourceDefinition and its system name. |
IProperty |
IBaseDocumentModule.getProperty(IContext context,
IResourceDefinition resourceDefinition,
String name)
Gets a property definition by specifying the
IResourceDefinition and its system name. |
IProperty |
IBaseLibraryModule.getProperty(IContext context,
IResourceDefinition resourceDefinition,
String name) |
Collection<? extends IResource> |
IBaseWorkflowModule.getResources(IContext context,
IResourceDefinition resourceDefinition)
Gets a collection of
IResource objects from a resource definition. |
Collection<? extends IResource> |
IBaseDocumentModule.getResources(IContext context,
IResourceDefinition resourceDefinition)
Gets a collection of
IResource objects from a resource definition. |
Collection<? extends IVersion> |
IBaseDocumentModule.getVersions(IContext context,
IResourceDefinition resourceDefinition,
String reference)
Gets all the versions with the same reference within a specified
IWorkflow object. |
IView |
IBaseWorkflowModule.getView(IContext context,
IResourceDefinition resourceDefinition,
String viewName)
Retrieves a view by its name.
|
IView |
IBaseDocumentModule.getView(IContext context,
IResourceDefinition resourceDefinition,
String viewName)
Retrieves a view by its name.
|
IView |
IBaseSiteModule.getView(IContext context,
IResourceDefinition resourceDefinition,
String viewName) |
Collection<? extends IView> |
IBaseWorkflowModule.getViews(IContext context,
IResourceDefinition resourceDefinition)
Retrieves all the views associated with the resource definition.
|
Modifier and Type | Method and Description |
---|---|
IResourceDefinition |
BaseResourceDefinitionExtension.getResourceDefinition() |
IResourceDefinition |
BaseWorkflowExtension.getResourceDefinition() |
Modifier and Type | Method and Description |
---|---|
void |
BaseWorkflowExtension.init(IResourceDefinition resourceDefinition,
IWorkflow workflow) |
Copyright © 2021 Visiativ Software. All rights reserved.