Interface ISolution
- All Known Implementing Classes:
Solution
public interface ISolution
This interface defines the properties of a project that can be started through the portal engine. A solution can
consist of a single application (the main application), but may also have references to other applications when for
instance a process engine is used.
- Since:
- 7.1
- Author:
- O. Kerpershoek
-
Method Summary
Modifier and TypeMethodDescriptionThis method returns the main application of the project.getId()
This method returns the ID of the application.getMapping
(String name) This method returns a mapping for a specified name.String[]
This method returns an array containing all the mapping names.This method will return the module for the specified ID, and load the module if needed.String[]
This method returns the project definition.getTimer()
boolean
This method returns a boolean indicating if a process engine is used by this project.
-
Method Details
-
getId
ApplicationID getId()This method returns the ID of the application.- Returns:
- The ID of the application.
-
getApplication
ILocalApplication getApplication()This method returns the main application of the project.- Returns:
- The main application of the project (never null).
-
getProject
IProject getProject()This method returns the project definition.- Returns:
- the project definition.
-
usesProcessEngine
boolean usesProcessEngine()This method returns a boolean indicating if a process engine is used by this project.- Returns:
- boolean indicating if a process engine is used by this project.
-
getModule
This method will return the module for the specified ID, and load the module if needed.- Parameters:
moduleId
- The ID of the requested module.- Returns:
- Module definition for the specified ID.
- Throws:
UnknownModuleException
- This exception is thrown when the ID does not reference a known module.InitializationException
- This exception is thrown when the module could not be loaded.
-
getConfiguration
IApplicationConfig getConfiguration() -
getFactoryManager
IFactoryManager getFactoryManager() -
getResourceManager
IResourceManager getResourceManager() -
getConnectionManager
IConnectionManager getConnectionManager() -
getTimer
ITimer getTimer() -
getUserScopeDao
IUserScopeDao getUserScopeDao() -
getMapping
This method returns a mapping for a specified name.- Parameters:
name
- The mapping name used for lookup (case insensitive).- Returns:
- The mapping, never null
- Throws:
UnknownMappingException
- Is thrown when no mapping exists for the given name.
-
getMappingNames
String[] getMappingNames()This method returns an array containing all the mapping names.- Returns:
- array containing all the mapping names.
-
getWebServices
WebServices getWebServices() -
getProcessMapping
IProcessMapping getProcessMapping() -
getModuleNames
String[] getModuleNames() -
getCaseEngineClient
CaseEngineClient getCaseEngineClient() -
getAuditEngine
IAuditEngine getAuditEngine() -
getCommentsManager
ICommentsManager getCommentsManager()
-