Package ch.ivyteam.ivy.workflow.start

Interface IWebStartable

All Superinterfaces:
Comparable<IWebStartable>
public interface IWebStartable extends 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 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 this IWebStartable. 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 this IWebStartable. 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 this IWebStartable. 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 this IWebStartable. Never returns null.
      Returns:
      link
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility NOVICE.

    • getLinkEmbedded

      WebLink getLinkEmbedded()
      Returns the link of this IWebStartable 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 this IWebStartable. Defines which ISecurityMember can activate this IWebStartable. 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 this IWebStartable.
      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 the IProcessModelVersion of this IWebStartable. 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.

    • parameters

      List<StartParameter> parameters()
      Returns the start parameters of this IWebStartable. This parameters can be added to the start link (see getLink()). Never returns null.
      Returns:
      a list of start parameters
      Since:
      10.0.3
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.