Package com.axemble.vdoc.sdk.impl

Class ProjectModuleImpl

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractTranslaterModule

com.axemble.vdoc.sdk.impl.CoreModule

com.axemble.vdoc.sdk.impl.ProjectModuleImpl

All Implemented Interfaces:

com.axemble.vdoc.core.interfaces.InternalProjectModule, IModule, IProjectModule, Serializable, Remote

public class ProjectModuleImpl
extends CoreModule
implements com.axemble.vdoc.core.interfaces.InternalProjectModule

Project module implementation

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.axemble.vdoc.sdk.modules.IProjectModule

IProjectModule.DesignElementNames, IProjectModule.LinkedDesignElementGroupNames, IProjectModule.UniqueGroupNames

Field Summary

Fields

Modifier and Type	Field	Description
protected IExecutionContext	executionContext

Fields inherited from class com.axemble.vdoc.sdk.impl.CoreModule

LOGGER, properties

Constructor Summary

Constructors

Constructor	Description
ProjectModuleImpl()	Deprecated. Use com.axemble.vdoc.sdk.Modules.getProjectModule() instead.

Method Summary

Modifier and Type	Method	Description
IReport	compile(IContext context, IDesignForm designForm, boolean validate)
IReport	compile(IContext context, IDesignWorkflow designWorkflow, boolean validate)
IDesignForm	createDesignForm()	Creates a design form object.
IDesignWorkflow	createDesignWorkflow()	Creates a design workflow diagram.
IProject	createProject(IContext context, IOrganization organization, String name, String label)	Create a new project object
String	generateSystemName(String label)	Generate a valid system name for this module and this label.
IChrono	getChronoByName(String name, IProject project)	find a IChrono by its name.
IExecutionContext	getExecutionContext()
IMessageController	getMessageController()	Gets a message controller
IProject	getProject(IContext context, String name, IOrganization organization)	Gets a project by its name and organization.
IProject	getProject(IStorageKey key)	Gets a project from its identifier.
Collection<? extends IProject>	getProjects(IContext context)	Get all projects
Collection<? extends IProject>	getProjects(IContext context, IOrganization organization)	Get all projects of the organization
ISecurityController	getSecurityController(ISecuritySupport securitySupport)	Gets a security controller on a specified object.
IDesignWorkflow	importWorkflowDiagram(IWorkflow workflow)	Utilisé en interne pour importer un diagramme de workflow
IDesignForm	loadDesignForm(IContext context, IStorageKey storageKey)
IDesignWorkflow	loadDesignWorkflow(IContext context, IStorageKey storageKey)
Element	saveWorkflowDiagram(IDesignWorkflow designWorkflow, boolean useLongSuffix)	Utilisé en interne pour sauvegarder un diagramme de workflow

Methods inherited from class com.axemble.vdoc.sdk.impl.CoreModule

beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, createAttachment, createAttachment, createAttachment, createAttachment, createProfile, findNativeClass, getAnonymous, getAnonymousContext, getComponentsFactory, getConfiguration, getContext, getContext, getContext, getContextByLogin, getDefinitionsFactory, getElementByProtocolURI, getElementFromExternalElement, getExternalElement, getExternalElement, getLanguage, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProfile, getProfile, getProfiles, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getUser, getUser, getUserById, getUserByLogin, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractTranslaterModule

getTranslation, getTranslationForLanguage, getTranslationKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.axemble.vdoc.sdk.modules.IModule

beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, findNativeClass, getAnonymous, getAnonymousContext, getContext, getContext, getContextByLogin, getElementFromExternalElement, getExternalElement, getExternalElement, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getTranslation, getTranslationForLanguage, getTranslationKey, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize

Methods inherited from interface com.axemble.vdoc.sdk.modules.IProjectModule

getComponentsFactory, getDefinitionsFactory, getElementByProtocolURI

Field Details

executionContext

protected IExecutionContext executionContext

Constructor Details

ProjectModuleImpl

@Deprecated
public ProjectModuleImpl()

Deprecated.

Use com.axemble.vdoc.sdk.Modules.getProjectModule() instead.

Constructor

Method Details

createProject

public IProject createProject(IContext context,
 IOrganization organization,
 String name,
 String label)
                       throws ProjectModuleException

Description copied from interface: IProjectModule

Create a new project object

Specified by:

createProject in interface IProjectModule

Parameters:

context - the execution context.

organization - the IOrganization of the project.

name - the system name of the project.

label - the label of the project

Returns:

a IProject object.

Throws:

ProjectModuleException - default module exception.

getProject

public IProject getProject(IContext context,
 String name,
 IOrganization organization)
                    throws ProjectModuleException

Description copied from interface: IProjectModule

Gets a project by its name and organization.

Specified by:

getProject in interface IProjectModule

Parameters:

context - the execution context.

name - the system name of the project.

organization - the IOrganization of the project.

Returns:

a IProject object.

Throws:

ProjectModuleException - default module exception.

getProject

public IProject getProject(IStorageKey key)
                    throws ProjectModuleException

Description copied from interface: IProjectModule

Gets a project from its identifier.

Specified by:

getProject in interface IProjectModule

Parameters:

key - a key.

Returns:

a IProject object.

Throws:

ProjectModuleException - default module exception.

getProjects

public Collection<? extends IProject> getProjects(IContext context,
 IOrganization organization)
                                           throws ProjectModuleException

Description copied from interface: IProjectModule

Get all projects of the organization

Specified by:

getProjects in interface IProjectModule

Parameters:

context - the execution context.

organization - the IOrganization of the project.

Returns:

a java.util.Collection of IProject objects.

Throws:

ProjectModuleException - default module exception.

getProjects

public Collection<? extends IProject> getProjects(IContext context)
                                           throws ProjectModuleException

Description copied from interface: IProjectModule

Get all projects

Specified by:

getProjects in interface IProjectModule

Parameters:

context - the execution context.

Returns:

a java.util.Collection of IProject objects.

Throws:

ProjectModuleException - default module exception.

getSecurityController

public ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                          throws ProjectModuleException

Description copied from interface: IProjectModule

Gets a security controller on a specified object.

Specified by:

getSecurityController in interface IProjectModule

Parameters:

securitySupport - Any IElement that implements ISecuritySupport interface.

Returns:

The ISecurityController object.

Throws:

ProjectModuleException - default module exception.

getExecutionContext

public IExecutionContext getExecutionContext()

Returns:

the executionContext

getMessageController

public IMessageController getMessageController()
                                        throws ProjectModuleException

Description copied from interface: IProjectModule

Gets a message controller

Specified by:

getMessageController in interface IProjectModule

Returns:

The IMessageController object.

Throws:

ProjectModuleException - default module exception.

createDesignWorkflow

public IDesignWorkflow createDesignWorkflow()
                                     throws ProjectModuleException

Description copied from interface: IProjectModule

Creates a design workflow diagram.

Specified by:

createDesignWorkflow in interface IProjectModule

Returns:

A IDesignWorkflow object.

Throws:

ProjectModuleException - default module exception.

loadDesignWorkflow

public IDesignWorkflow loadDesignWorkflow(IContext context,
 IStorageKey storageKey)
                                   throws ProjectModuleException

Specified by:

loadDesignWorkflow in interface IProjectModule

Throws:

ProjectModuleException

compile

public IReport compile(IContext context,
 IDesignWorkflow designWorkflow,
 boolean validate)
                throws ProjectModuleException

Specified by:

compile in interface IProjectModule

Throws:

ProjectModuleException

createDesignForm

public IDesignForm createDesignForm()
                             throws ProjectModuleException

Description copied from interface: IProjectModule

Creates a design form object.

Specified by:

createDesignForm in interface IProjectModule

Returns:

A IDesignForm object.

Throws:

ProjectModuleException - default module exception.

loadDesignForm

public IDesignForm loadDesignForm(IContext context,
 IStorageKey storageKey)
                           throws ProjectModuleException

Specified by:

loadDesignForm in interface IProjectModule

Throws:

ProjectModuleException

compile

public IReport compile(IContext context,
 IDesignForm designForm,
 boolean validate)
                throws ProjectModuleException

Specified by:

compile in interface IProjectModule

Throws:

ProjectModuleException

saveWorkflowDiagram

public Element saveWorkflowDiagram(IDesignWorkflow designWorkflow,
 boolean useLongSuffix)
                            throws ProjectModuleException

Utilisé en interne pour sauvegarder un diagramme de workflow

Specified by:

saveWorkflowDiagram in interface com.axemble.vdoc.core.interfaces.InternalProjectModule

Parameters:

designWorkflow - the IDesignWorkflow

useLongSuffix - true to use long suffix otherwise false

Throws:

ProjectModuleException - the ProjectModuleException if there is one

importWorkflowDiagram

public IDesignWorkflow importWorkflowDiagram(IWorkflow workflow)

Utilisé en interne pour importer un diagramme de workflow

Specified by:

importWorkflowDiagram in interface com.axemble.vdoc.core.interfaces.InternalProjectModule

getChronoByName

public IChrono getChronoByName(String name,
 IProject project)

Description copied from interface: IProjectModule

find a IChrono by its name.

Specified by:

getChronoByName in interface IProjectModule

Parameters:

name - the name of the chrono

project - the parent project

Returns:

the found chrono or null.

generateSystemName

public String generateSystemName(String label)

Description copied from interface: IModule

Generate a valid system name for this module and this label.

Specified by:

generateSystemName in interface IModule

Parameters:

label - label to normalize

Returns:

normalized value