Package ch.ivyteam.ivy.application
Interface IApplication
- All Superinterfaces:
IActivity
,IAttributeStore<Object>
,ICustomPropertyProvider
,ISystemEventDispatcher
public interface IApplication
extends IActivity, IAttributeStore<Object>, ISystemEventDispatcher, ICustomPropertyProvider
- API:
- This is a public API.
-
Nested Class Summary
Nested classes/interfaces inherited from interface ch.ivyteam.ivy.event.ISystemEventDispatcher
ISystemEventDispatcher.DispatchStatus
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptioncreateProcessModel
(String processModelName, String description) Creates a new process model within the applicationstatic IApplication
current()
Gets the current application.void
deleteProcessModel
(String processModelName) Deletes a process modelfindProcessModel
(Object identifier) Finds a process model by its identifierfindProcessModel
(String processModelName) Finds a process model by its namefindProcessModelVersion
(String processModelVersionUrl) Finds a process model version with the procesModelVersionUrl or procesModelUrlReturns theIBusinessCalendarSettings
to accessIBusinessCalendarConfiguration
sdefault Locale
Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.Returns the descriptionGets the directory where the persistent files that can be accessed with the IvyScript File type are stored for this application.Returns the directory where the files of the application are stored (in this directory, there are different directories for each project and then in each directory different directories for each version...)long
getId()
Gets the identifier of the applicationGets all liberariesgetName()
Returns the name of the applicationGets the owner nameGets all process modelsGets all process models sorted by the name of the process modelsGets the security context of this applicationGets the security descriptor of the applicationGets the directory where the temporary IvyScript Files for the current session are stored.boolean
isSystem()
Returns true if this application is the system applicationdefault boolean
Deprecated, for removal: This API element is subject to removal in a future version.useisSystem()
void
setBusinessCalendar
(IBusinessCalendar calendar) Defines theIBusinessCalendar
for thisIApplication
.default void
setDefaultEMailLanguage
(Locale emailLanguage) Deprecated, for removal: This API element is subject to removal in a future version.useLanguageConfigurator
void
Deprecated, for removal: This API element is subject to removal in a future version.void
setDescription
(String description) Sets the descriptionvoid
setFileDirectory
(String directory) Set the data directory where the files of the application are stored (in this directory, there are different directories for each project and then in each directory different directories for each version...)void
setOwnerName
(String ownerName) Sets the owner nameMethods inherited from interface ch.ivyteam.ivy.application.IActivity
activate, deactivate, getActivityOperationState, getActivityState, lock
Methods inherited from interface ch.ivyteam.util.IAttributeStore
getAttribute, getAttributeNames, removeAttribute, setAttribute
Methods inherited from interface ch.ivyteam.ivy.application.property.ICustomPropertyProvider
customProperties
Methods inherited from interface ch.ivyteam.ivy.event.ISystemEventDispatcher
addSystemEventListener, removeSystemEventListener, sendSystemEvent
-
Field Details
-
SYSTEM_APPLICATION_NAME
System application name- See Also:
- API:
- This public API is available in Java.
-
DESIGNER_APPLICATION_NAME
The name of the application on the designer (is always the same)- See Also:
- API:
- This public API is available in Java.
-
-
Method Details
-
getId
long getId()Gets the identifier of the application- Returns:
- the identifier
- API:
- This public API is available in Java.
-
getName
String getName()Returns the name of the application- Returns:
- name
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
getDescription
String getDescription()Returns the description- Returns:
- description
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
setDescription
Sets the description- Parameters:
description
- The description of the application- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
- Security:
- SESSION OWNS ApplicationWriteDescription PERMISSION OR OWNS ApplicationWriteDescription@SYSTEM PERMISSION
-
getFileDirectory
String getFileDirectory()Returns the directory where the files of the application are stored (in this directory, there are different directories for each project and then in each directory different directories for each version...)- Returns:
- the directory where the files of the application are stored
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
getFileArea
File getFileArea()Gets the directory where the persistent files that can be accessed with the IvyScript File type are stored for this application. The returned location is relative to the application's general file directory, which is accessible withgetFileDirectory()
.- Returns:
- persistent file area directory
- Throws:
PersistencyException
- if persistency access fails- See Also:
- API:
- This public API is available in Java.
-
getSessionFileArea
File getSessionFileArea()Gets the directory where the temporary IvyScript Files for the current session are stored. The returned location is relative to the application's general file directory, which is accessible withgetFileDirectory()
.- Returns:
- temporary file area directory for current session
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
setFileDirectory
Set the data directory where the files of the application are stored (in this directory, there are different directories for each project and then in each directory different directories for each version...)- Parameters:
directory
- The directory where the files of the application are stored (null means default directory)- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
- Security:
- SESSION OWNS ApplicationWriteFileDirectory PERMISSION OR OWNS ApplicationWriteFileDirectory@SYSTEM PERMISSION
-
setOwnerName
Sets the owner name- Parameters:
ownerName
- The new owner name- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
- Security:
- SESSION OWNS ApplicationWriteOwnerName PERMISSION OR OWNS ApplicationWriteOwnerName@SYSTEM PERMISSION
-
getOwnerName
String getOwnerName()Gets the owner name- Returns:
- owner name
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
findProcessModel
Finds a process model by its name- Parameters:
processModelName
- Name of the process model- Returns:
- process model or null if no process model with the name exists
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
findProcessModel
Finds a process model by its identifier- Parameters:
identifier
- process model identifier- Returns:
- process model or null
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
findProcessModelVersion
Finds a process model version with the procesModelVersionUrl or procesModelUrl- Parameters:
processModelVersionUrl
- of the process model version- Returns:
- process model version or null
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
createProcessModel
Creates a new process model within the application- Parameters:
processModelName
- The process model namedescription
- Description of the process model- Returns:
- created process model or null if processModelName isn't unique
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
- Security:
- SESSION OWNS ProcessModelCreate PERMISSION OR OWNS ProcessModelCreate@SYSTEM PERMISSION
-
deleteProcessModel
Deletes a process model- Parameters:
processModelName
- The name of the process model- Throws:
PersistencyException
- If db access failsPersistencyException
- if persistency access fails- API:
- This public API is available in Java.
- Security:
- SESSION OWNS ProcessModelDelete PERMISSION OR OWNS ProcessModelDelete@SYSTEM PERMISSION
-
getProcessModels
List<IProcessModel> getProcessModels()Gets all process models- Returns:
- unmodifiable list with all process models
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
getProcessModelsSortedByName
List<IProcessModel> getProcessModelsSortedByName()Gets all process models sorted by the name of the process models- Returns:
- unmodifiable list with all process models sorted by name
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
isSystem
boolean isSystem()Returns true if this application is the system application- Returns:
- true if system application, otherwise false
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
isSystemProvided
Deprecated, for removal: This API element is subject to removal in a future version.useisSystem()
- API:
- This public API is available in Java.
-
getSecurityDescriptor
ISecurityDescriptor getSecurityDescriptor()Gets the security descriptor of the application- Returns:
- the security descriptor
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
getSecurityContext
ISecurityContext getSecurityContext()Gets the security context of this application- Returns:
- security context
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
getLibraries
Gets all liberaries- Returns:
- list with libraries. Maybe empty, never null.
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
getDefaultEMailNotifcationSettings
@Deprecated(since="9.4", forRemoval=true) IEMailNotificationSettings getDefaultEMailNotifcationSettings()Deprecated, for removal: This API element is subject to removal in a future version.Gets the default email notification settings of this application. If not set or is set tonull
, default settings are returned, nevernull
.This settings are used if the user settings define to use the application default (see
IUserEMailNotificationSettings.isUseApplicationDefault()
).- Returns:
- the default email notification settings of this application, never
null
. - Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
setDefaultEMailNotifcationSettings
@Deprecated(since="9.4", forRemoval=true) void setDefaultEMailNotifcationSettings(IEMailNotificationSettings settings) Deprecated, for removal: This API element is subject to removal in a future version.Sets the default email notification settings of this application.This settings are used if the user settings define to use the application default (see
IUserEMailNotificationSettings.isUseApplicationDefault()
).- Parameters:
settings
- the default email notification settings of this application, can benull
.- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
getDefaultEMailLanguage
Deprecated, for removal: This API element is subject to removal in a future version.useLanguageConfigurator
Gets the default email language of this application. If not set or is set tonull
,Locale.ENGLISH
is returned, nevernull
.This language is used if the email language property of the user is
null
.- Returns:
- the default email notification settings of this application, never
null
. - See Also:
- API:
- This public API is available in Java.
-
setDefaultEMailLanguage
@Deprecated(since="9.4", forRemoval=true) default void setDefaultEMailLanguage(Locale emailLanguage) Deprecated, for removal: This API element is subject to removal in a future version.useLanguageConfigurator
Sets the default email language of this application.This language is used if the email language property of the user is
null
.- Parameters:
emailLanguage
- the default email language of this application, can benull
.- See Also:
- API:
- This public API is available in Java.
-
getBusinessCalendarSettings
IBusinessCalendarSettings getBusinessCalendarSettings()Returns theIBusinessCalendarSettings
to accessIBusinessCalendarConfiguration
s- Returns:
- never null
- API:
- This public API is available in Java.
-
setBusinessCalendar
Defines theIBusinessCalendar
for thisIApplication
. This influences theIDefaultBusinessCalendar
determination when callingivy.cal
.- Parameters:
calendar
- may be null.- API:
- This public API is available in Java.
-
current
Gets the current application.
Will return null if called out of scope. The scope is set if you call this method from an ivy process or any supported ivy environment. It is not set in non supported ivy environments (e.g. if you start your own threads, etc.).
- Returns:
- current application or null if out of scope
- Since:
- 9.1
- API:
- This public API is available in Java.
-
LanguageConfigurator