com.axemble.vdoc.sdk.modules

Interface IProjectModule

All Superinterfaces:

IModule, Remote

public interface IProjectModule
extends IModule

The IBaseProjectModule interface is the main entry point from where most of the methods to manipulate VDoc applications.

Code sample :

 // creation of a project module object
 IBaseProjectModule projectModule = Modules.getProjectModule();
 try
 {
 }
 finally
 {
  // uninitialize the module
        Modules.releaseModule(projectModule);
 }
 

Author:

vlygeros

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IProjectModule.DesignElementNames Enumerates the design element names
static interface	IProjectModule.LinkedDesignElementGroupNames Enumerates the linked groups
static interface	IProjectModule.UniqueGroupNames Enumerates the group

Method Summary

Modifier and Type	Method and 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
IChrono	getChronoByName(String name, IProject project) find a IChrono by it's name.
IComponentsFactory	getComponentsFactory() Gets the user interface components factory.
IDefinitionsFactory	getDefinitionsFactory() Gets the component definition factory.
IProtocolSupport	getElementByProtocolURI(String protocolURI) Gets an IElement object which implements IProtocolSupport interface.
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.
IDesignForm	loadDesignForm(IContext context, IStorageKey storageKey)
IDesignWorkflow	loadDesignWorkflow(IContext context, IStorageKey storageKey)

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, 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

Method Detail

createProject

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

Create a new project object

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

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

Gets a project by its name and organization.

Parameters:

context - the execution context.

name - the system name of the project.

organization - the IOrganization of the project.

Returns:

a IProject object.

Throws:

ProjectModuleException

getProject

IProject getProject(IStorageKey key)
             throws ProjectModuleException

Gets a project from its identifier.

Parameters:

key - a key.

Returns:

a IProject object.

Throws:

ProjectModuleException

getProjects

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

Get all projects of the organization

Parameters:

context - the execution context.

organization - the IOrganization of the project.

Returns:

a java.util.Collection of IProject objects.

Throws:

ProjectModuleException

getProjects

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

Get all projects

Parameters:

context - the execution context.

Returns:

a java.util.Collection of IProject objects.

Throws:

ProjectModuleException

getElementByProtocolURI

IProtocolSupport getElementByProtocolURI(String protocolURI)
                                  throws ModuleException

Gets an IElement object which implements IProtocolSupport interface.

Parameters:

protocolURI - The protocol URI as a java.lang.String.

Returns:

A IProtocolSupport object.

Throws:

ModuleException - default module exception.

getSecurityController

ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                   throws ProjectModuleException

Gets a security controller on a specified object.

Parameters:

securitySupport - Any IElement that implements ISecuritySupport interface.

Returns:

The ISecurityController object.

Throws:

ProjectModuleException - default module exception.

getMessageController

IMessageController getMessageController()
                                 throws ProjectModuleException

Gets a message controller

Returns:

The IMessageController object.

Throws:

ProjectModuleException - default module exception.

createDesignWorkflow

IDesignWorkflow createDesignWorkflow()
                              throws ProjectModuleException

Creates a design workflow diagram.

Returns:

A IDesignWorkflow object.

Throws:

ProjectModuleException - default module exception.

loadDesignWorkflow

IDesignWorkflow loadDesignWorkflow(IContext context,
                                   IStorageKey storageKey)
                            throws ProjectModuleException

Throws:

ProjectModuleException

compile

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

Throws:

ProjectModuleException

createDesignForm

IDesignForm createDesignForm()
                      throws ProjectModuleException

Creates a design form object.

Returns:

A IDesignForm object.

Throws:

ProjectModuleException - default module exception.

loadDesignForm

IDesignForm loadDesignForm(IContext context,
                           IStorageKey storageKey)
                    throws ProjectModuleException

Throws:

ProjectModuleException

compile

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

Throws:

ProjectModuleException

getComponentsFactory

IComponentsFactory getComponentsFactory()

Gets the user interface components factory.

Returns:

A IComponentsFactory object.

getDefinitionsFactory

IDefinitionsFactory getDefinitionsFactory()

Gets the component definition factory.

Returns:

A IDefinitionsFactory object.

getChronoByName

IChrono getChronoByName(String name,
                        IProject project)

find a IChrono by it's name.

Parameters:

name -

project - the parent project

Returns:

the found chrono or null.