Package ch.ivyteam.ivy.workflow.start
Interface IWebStartable
- All Superinterfaces:
Comparable<IWebStartable>
A
IWebStartable
can be started from an end user over the web. It
provides anything what you need to build for a simple link in the web.- Since:
- 6.6.2
- API:
- This is a public API.
-
Method Summary
Modifier and TypeMethodDescriptionAccess to customer specific additional informationReturns the activator of thisIWebStartable
.Returns the category of this .Returns the description of thisIWebStartable
.Returns the name of thisIWebStartable
.getId()
Returns a unique identifier for this IWebStartablegetLink()
Returns the link of thisIWebStartable
.Returns the link of thisIWebStartable
for frame mode.getName()
Returns the name of thisIWebStartable
.getType()
Returns the type of thisIWebStartable
.pmv()
Returns theIProcessModelVersion
of thisIWebStartable
.
-
Method Details
-
getId
String getId()Returns a unique identifier for this IWebStartable- Returns:
- id
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getName
String getName()Returns the name of thisIWebStartable
. Never returns null.- Returns:
- name
- API:
- This public API is available in IvyScript and Java. It has the visibility NOVICE.
-
getDisplayName
String getDisplayName()Returns the name of thisIWebStartable
. If the name is empty it will return an alternate name. Never returns null.- Returns:
- display name
- API:
- This public API is available in IvyScript and Java. It has the visibility NOVICE.
-
getDescription
String getDescription()Returns the description of thisIWebStartable
. Never returns null.- Returns:
- description
- API:
- This public API is available in IvyScript and Java. It has the visibility NOVICE.
-
getLink
WebLink getLink()Returns the link of thisIWebStartable
. Never returns null.- Returns:
- link
- API:
- This public API is available in IvyScript and Java. It has the visibility NOVICE.
-
getLinkEmbedded
WebLink getLinkEmbedded()Returns the link of thisIWebStartable
for frame mode. Never returns null.- Returns:
- link
- API:
- This public API is available in IvyScript and Java. It has the visibility NOVICE.
-
getActivator
ISecurityMember getActivator()Returns the activator of thisIWebStartable
. Defines whichISecurityMember
can activate thisIWebStartable
. Never returns null.- Returns:
- activator
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getType
String getType()Returns the type of thisIWebStartable
.- Returns:
- type
- API:
- This public API is available in IvyScript and Java. It has the visibility NOVICE.
-
getCategory
Category getCategory()Returns the category of this .- Returns:
- category
- API:
- This public API is available in IvyScript and Java. It has the visibility NOVICE.
-
customFields
IStartCustomFields customFields()Access to customer specific additional information- Returns:
- custom fields
- Since:
- 9.2
- API:
- This public API is available in IvyScript and Java. It has the visibility NOVICE.
-
pmv
IProcessModelVersion pmv()Returns theIProcessModelVersion
of thisIWebStartable
. Never returns null.- Returns:
- process model version
- Since:
- 9.4
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-