Package ch.ivyteam.ivy.workflow

Interface IStartEventElement

All Superinterfaces:

IProcessStart

public interface IStartEventElement
extends IProcessStart

Configuration of a start event element

Since:

22.01.2007

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
ISecurityMember	getActivator()	Gets the activator, which one must own to start a case on this start event element
String	getEventBeanClassName()	Gets the class name of the event bean of the start event element
String	getEventBeanConfiguration()	Gets the configuration string for the event bean of the start event element
boolean	isEventBeanEnabled()	Is this event bean enabled to start
void	setEventBeanEnabled(boolean enabled)	Sets the enable state of this event bean.

Methods inherited from interface ch.ivyteam.ivy.workflow.IProcessStart

getDescription, getFullRequestPath, getFullUserFriendlyRequestPath, getId, getName, getProcessElementId, getProcessModelVersion, getRequestPath, getTaskStart, getUserFriendlyRequestPath

Method Detail

getEventBeanClassName

String getEventBeanClassName()
                      throws PersistencyException

Gets the class name of the event bean of the start event element

Returns:

event bean class name

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

Security:

SESSION OWNS StartEventElementReadEventBeanClassName PERMISSION OR OWNS StartEventElementReadEventBeanClassName@SYSTEM PERMISSION

getEventBeanConfiguration

String getEventBeanConfiguration()
                          throws PersistencyException

Gets the configuration string for the event bean of the start event element

Returns:

configuration string

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

Security:

SESSION OWNS StartEventElementReadEventBeanConfiguration PERMISSION OR OWNS StartEventElementReadEventBeanConfiguration@SYSTEM PERMISSION

isEventBeanEnabled

boolean isEventBeanEnabled()
                    throws PersistencyException

Is this event bean enabled to start

Returns:

true if it is enabled to start

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

Security:

SESSION OWNS StartEventElementReadEventBeanEnabled PERMISSION OR OWNS StartEventElementReadEventBeanEnabled@SYSTEM PERMISSION

setEventBeanEnabled

void setEventBeanEnabled(boolean enabled)
                  throws PersistencyException

Sets the enable state of this event bean. If the event bean is disabled it is not started during the server start. If it is enabled it is started during the server start.

Parameters:

enabled - true to set enable, false to set disabled

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

Security:

SESSION OWNS StartEventElementWriteEventBeanEnabled PERMISSION OR OWNS StartEventElementWriteEventBeanEnabled@SYSTEM PERMISSION

getActivator

ISecurityMember getActivator()
                      throws PersistencyException

Gets the activator, which one must own to start a case on this start event element

Returns:

activator

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.