Package com.axemble.vdoc.sdk.interfaces

Interface Summary

Interface	Description
IAction	The IAction interface represents a workflow action which can be executed by a physical person.
IActionTask	Interface for an action manual task
IAgent	This class allows to manipulate scheduled tasks.
IAgent.ExecutionStatus	All execution states.
IAgentProcessing	Standard agent interface The following method is available: - execute(IAgentProcessingContext executionContext) Use IAgentProcessingContext to manipulate module, agent, configuration or report IAgentProcessingContext
IAgentProcessingContext	Interface of the agent processing context This object carries the information related to the execution context of the IAgentProcessing The following methods are available to gets module object: - getPortalModule() : the module to manipulate the portal system; - getDirectoryModule() : the module to manipulate the directory system; - getProjectModule() : the module to manipulate the project system; - getWorkflowModule() : the module to manipulate the workflow system; The following methods are available to manipulate the agent: - getConfiguration() - getAgent() - getLastRunDate() - isAbortSignalReceived() IStoppableAgentProcessing The following methods are available to manipulate the report: - getReport() - printSeparator() - printLine()
IAlias	This interface represents an alias on any element.
IApplicationTask	Interface for an application manual task
IArchivingController	The IArchivingController interface allows you to archive objects.
IAsyncJobCallable<U>
IAsyncJobQueue
IAsyncJobQueueController
IAttachment	The IAttachment interface represents any attachment in the system.
IAttachmentTemplate	The IAttachmentTemplate interface represents the template.
IAttribute	The IAttribute interface represents the directory extended attributes It allows to manipulate attributes of directory objects such as: IOrganization, ILocalization, IGroup and IUser.
IAttribute.IType
IBlock	This interface represents a block element.
IBlockController	The block controller interface.
IBlockController.IRenderOptions
IBlockTemplate	This class represents a block template.
IBlockTemplateContainer	This interface represents a block template container.
IBlockTemplateContainer.IType
ICatalog	This interface is intended to group workflows.
ICatalog.ISecurityFlag
ICatalog.IType	The various types of catalogs
ICatalogViewTransformer	The catalog view transformer interface.
ICategory	The ICategory interface represents a category object.
IChrono	This class defines a chrono used to generate sys_Reference.
IComponent	This interface represents a block element.
IComponentController	The component controller interface.
IConfiguration	The IConfiguration interface represents a configuration of a ICatalog object.
IConfiguration.CatalogKeys	Catalog scope keys
IConfiguration.CommonKeys	The common keys
IConfiguration.ProjectKeys	Project scope keys
IConfiguration.ServerKeys	Server keys
IConfiguration.SupportedKeys	Deprecated Use ServerKeys instead
IConnectionDefinition<T>	This class retrieves a connection from a specified external reference declared in the administration
IConnectionDefinition.ICategory	Systems or standards Category.
IConnectionDefinition.IType	Systems or standards types.
IConnectorExecutionStatus	This class represents the different status for a connector
IContent	This interface represents the base content element.
IContent.IStatus	This interface represents the various status the content can have.
IContentComponent	This interface represents a block element.
IContentComponentController	The base interface for all content component controllers.
IContentContainer	This interface represents the base content container.
IContentContainer.IStatus
IContext	The IContext interface is used on the various methods of the IBaseWorkflowModule object.
IController	The base interface for all controllers.
ICustomAuthenticationController	Controller gérant lui-même les problèmes d'authentification (ex mauvaise clé)
ICustomMappingProvider<T>
IDataSourceReference	This class retrieves a connection from a specified Data source declared in JNDI
IDataUnit	This class represents a data unit.
IDecisionTask	Interface for a decision manual task
IDelegationController	The IDelegationController interface allows you to either replace of delegate objects which supports delegation.
IDirectory	Represents a directory object (User, Organization, Localization, Group)
IDirectoryLocalizationScope
IDirectoryOrganizationScope
IDirectoryScope
IDirectoryTransformer	Allows to transform directory elements to and from XML documents.
IDynamicLocalizationsWrapper	Created by omassol on 28/04/2017.
IElement	The base interface of all objects.
IExtensionContext	The IExtensionContext interface is used on the protocol URI classes to store data temporary The context will be cleared once the treatment has ended.
IExternalList	The Extenal list interface
IExternalReference	The base interface for external reference.
IFile	The file within the library system.
IFolder	The folder within the library system.
IForm	The form object.
IFormToolProvider	Permet de gérer les sélections de fragments dans le formDesigner
IFunctions
IGenericViewTransformer	This class represents a generic view transformer.
IGroup	The IGroup interface is part of the VDoc directory.
IIndexController	This class manages indexes.
IJdbcReference	Deprecated use IConnectionDefinition
IJMSController
IJMSMessage
IJMSMessageBean
IJMSMessageProcessor<M extends IJMSMessage>
IJMSMessageProperty<T>
IJMSQueueBean
IJMSQueueController
IJMSQueueDeclaration<M extends IJMSMessage>	Implementation of this interface are looked up at application startup and used to create queue if doesnt exist and start consumers which will process queue's messages.
ILdapClient	LDAP connection SDK interface
ILibrary	The library object within the library system.
ILibraryElement	The ILibraryElement interface represents a IFile, a IFolder or a ICategory
ILibrarySubscription	The ILibrarySubscription interface represents a subscription to an IFile or IFolder with the recusive attribute
ILinkedResource	A child resource within a table field
ILinkedResourceDefinition	This class defines a resource definition for linked resources.
IList	The base list interface
IList.IType	Type of the list
IListMappingProvider<T>
ILocalization	The ILocalization interface is part of the VDoc directory.
ILocalizationScope	Interface for VDoc localization scopes All ILocalizableSupport must be attached to a ILocalizationScope
ILock	Resource lock interface
IMailForm	The mail form object.
IMailingList	This interface represents a mailing list.
IMailingList.IStatus	This interface represents the various status the mailing list can have.
IMailingList.IType	This interface represents the various types the mailing list can have.
IManualTask	Interface for a manual task
IMappingProvider<T>	This base class provides the setter and the getter of the mappingStructures of the mappingObject.
IMappingProvider.DataType	All supported data types
IMappingProvider.IMappingType	Mapping object type
IMappingStructure	This class allows to map an external object to a vdoc object (MappingStructure)
IMappingValuesProvider	This base class provides the objects of the mappingObject.
IMarkerModel	Generic model interface
IMarkerModel.IPersistenceScope	Persistence scopes
IMessage	This message interface.
IMessageController	This class allows to play with messages on IMessageSupport objects.
IModel	Generic model interface
IOperator	The IOperator interface is a user acting on a ITaskInstance object.
IOperator.InterveningStatus	Describes the various status the IOperator can have.
IOperatorRole	This class allows to associate either groups or users to ITask objects.
IOptionList	The option list interface
IOptionList.IOption	A key, value couple object.
IOrganization	The IOrganization interface is part of the VDoc directory.
IPage	This class represents a page of a site.
IPageContainer	This interface represents a page container.
IParameterizedMappingStructure
IPlugin	This class represents a plugin.
IPluginConfiguration	This class represents the configuration of a plugin.
IPluginController	The plugin controller interface.
IPluginRequest	The plugin request interface.
IPluginScope	The plugin scope interface
IPortlet	The portlet object.
IProfile	This class allows to manipulate security profile objects.
IProject	This interface represents a project (apps).
IProperty	A property
IProperty.Dynamic	Dynamic properties
IProperty.IAdditionalType	Additional types
IProperty.IDisplaySettings	Display settings
IProperty.IDisplaySettings.IType	Type of the field
IProperty.IElementType	The type of the java.util.Collection items.
IProperty.IIndexType	Index search types
IProperty.IType	All supported types
IProperty.Special	Special properties.
IProperty.System	System properties
IRecipientListener	This recipient listener interface.
IRenderModel	Model interface for JSP rendering
IRenderModel.VirtualPageMarkers
IReport	A property
IReportListener	A report listener : will interact on report events
IResource	A base interface for resources
IResourceController	This class allows to interact with the user interface.
IResourceDefinition	This class defines a resource which may have several IProperty objects.
IResourceHistory	This class represents the history of a resource.
IResourceHistory.IEvent	The document event structure.
IResourceHistory.ISnapshot	The snapshot structure.
IResourceViewTransformer
IResourceViewTransformer.IViews
IRole	Deprecated : use IOperatorRole or IProfile
IRootPluginConfiguration	This class represents the configuration of a root plugin.
IScope	The base interface for scopes.
IScopeContainer	The base interface for scope containers.
ISearchController	This class allows to execute queries object that implements the ISearchSupport.
ISearchViewTransformer	This class allows to transform the result of a search operation to a XML output stream.
ISecurityController	This class allows to check, allow or deny permissions on objects that implement ISecuritySupport interface.
ISecurityController.IPermissionFlag	Deprecated
ISecurityController.IPermissionFlags	Security permission flags
ISecurityController.IPermissionFlags.AgentPermissionFlags	Agent permission flags
ISecurityController.IPermissionFlags.CommonPermissionFlags	Common flags
ISecurityController.IPermissionFlags.CustomPermissionFlags	Custom flags
ISecurityController.IPermissionFlags.DatabasePermissionFlags	Database permission flags.
ISecurityController.IPermissionFlags.TablePermissionFlags	Table permission flags
ISecurityController.IPermissionFlags.ViewPermissionFlags	View permission flags
ISecurityController.IPermissionFlags.WorkflowCatalogPermissionFlags	Workflow catalog permission flags
ISecurityController.IPermissionFlags.WorkflowContainerPermissionFlags	Workflow container flags
ISecurityController.IPermissionFlags.WorkflowInstancePermissionFlags	Workflow instance flags
ISecurityController.IPermissionFlags.WorkflowPermissionFlags	Workflow permission flags
ISecurityController.IPermissionLevel	Deprecated
ISecurityController.IPermissionLevels	Security permission levels
ISecurityController.IScopeFilters	Scopes filters
IServiceDefinition	This class retrieves a service connection
IServiceDefinition.IEvent	The various types of the event
IServiceDefinition.System
ISharedBlock	This class represents a shared block which could be included on several site pages.
ISharedBlockContainer	This interface represents a shared block container.
ISite	This class represents a site.
ISiteTemplate	This class represents a template of a site.
IStoppableAgentProcessing	Stoppable agent interface The following method is available: - execute(IAgentProcessingContext executionContext) Use IAgentProcessingContext to manipulate module, agent, configuration or report IAgentProcessingContext
IStorageKey	The key interface for all objects.
IStorageResource	A resource for storage
IStorageResourceDefinition	This class defines a resource definition for storage resource.
IStringList	Deprecated use IOptionList/IExternalList
ITableCreationMappingProvider<T>
ITask	This class represents the definition of a class.
ITask.ITreatmentTypes	Defines the treatment available types.
ITaskInstance	This class represents an activity of a ITask object.
ITaskInstanceTransformer
ITaskViewTransformer
ITaskViewTransformer.IViews
ITestReferenceGeneratorExtension	Created by wtoscer on 22/02/2017.
ITopic	This class represents a topic.
ITopic.IType	The various types of topics
ITransformer	Allows to transform directory elements to and from XML documents.
ITrash
ITreatmentDefinition	This class retrieves a treatment connection
IUser	The IUser interface is part of the VDoc directory.
IValidators
IVersion	This class represents a version of a document.
IVersion.IVersionStatus	Available version status.
IView	The view interface.
IViewController	This class allows to create functional queries based on field values and scopes such as ICatalog, IWorfklowContainer, IWorfklow and ITask.
IVirtualPage	This interface represents a virtual page.
IWorkflow	This class represents a specific version of a process.
IWorkflow.ILifeCycleStatus
IWorkflowContainer	This class represents a set of IWorkflow objects.
IWorkflowContainerViewTransformer
IWorkflowInstance	This class represents a process document.
IWorkflowInstance.IStatus	Available status for the workflow instance.
IWorkflowResourceDefinition	This class defines a resource definition for a workflow.
IWorkflowViewTransformer
IXmlList	Deprecated use IOptionList/IExternalList
SDKWrapper	Interface des objets SDK qui mappent un objet natif (Domain) Ex : ProcessWorkflowInstance
SEO	Interface implémentée par les objets ayant des metas
SEO.Meta	Interface de manipulation de meta