Package de.xima.fc.interfaces.workflow.bpmn

Interface IWorkflowBpmnEnvironmentStore

  • public interface IWorkflowBpmnEnvironmentStore
    Store to access various contextual entities that might be referenced by the workflow when building a BPMN diagram, such as client or form files.
    Since:
    8.4.0

    • Method Detail

      • client

        Mandant client()
        Gets the client to which the workflow belongs that is being modeled as a BPMN diagram.
        Returns:
        The client of the workflow, never null.

      • clientFileName

        String clientFileName​(UUID clientFileUuid)
        Gets the name of a client file, identified by its UUID. Uses the client owning the workflow for which the BPMN diagram is being created.
        Parameters:
        clientFileUuid - The UUID of the client file to get the name for.
        Returns:
        The name of the client file, or empty if no client file with the given UUID exists in the client.

      • clientFileName

        String clientFileName​(UuidEntityRef clientFile)
        Gets the name of a client file, identified by its UUID. Uses the client owning the workflow for which the BPMN diagram is being created.
        Parameters:
        clientFile - The client file reference to get the name for.
        Returns:
        The name of the client file, or empty if no client file with the given UUID exists in the client.

      • clock

        Clock clock()
        Gets the clock of the workflow engine, which is used for obtaining the current date and time.
        Returns:
        The system time zone, never null.

      • counterName

        String counterName​(UUID counterUuid)
        Gets the name of a counter, identified by its UUID. Limited to counters that are defined in the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        counterUuid - The UUID of the counter to get the name for.
        Returns:
        The name of the counter, or empty if no counter with the given UUID exists.

      • counterName

        String counterName​(UuidEntityRef counter)
        Gets the name of a counter, identified by its UUID. Limited to counters that are defined in the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        counter - The counter reference to get the name for.
        Returns:
        The name of the counter, or empty if no counter with the given UUID exists.

      • counterName

        String counterName​(EntityRef counterRef)
        Gets the name of a counter reference by the given EntityRef. Uses the client of the workflow for which the BPMN diagram is being created to look up the counter.
        Parameters:
        counterRef - The reference to the counter to get the name for.
        Returns:
        The name of the counter, or empty if no counter with the given reference exists.

      • databaseConnectionForQuery

        UuidEntityRef databaseConnectionForQuery​(UUID dbQueryUuid)
        Gets the UUID of a database connection, identified by the UUID of a referencing database query. The search is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        dbQueryUuid - The UUID of a database query that references a database connection.
        Returns:
        The UUID of the database connection, or null if no database connection with the given UUID exists in the client.

      • databaseConnectionForQuery

        UuidEntityRef databaseConnectionForQuery​(UuidEntityRef dbQuery)
        Gets the UUID of a database connection, identified by the UUID of a referencing database query. The search is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        dbQuery - The database query reference that references a database connection.
        Returns:
        The UUID of the database connection, or null if no database connection with the given UUID exists in the client.

      • databaseConnectionName

        String databaseConnectionName​(UUID dbConnectionUuid)
        Gets the name of a database connection, identified by its UUID. The search for connections is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        dbConnectionUuid - The UUID of the database connection to get the name for.
        Returns:
        The name of the database connection, or empty if no database connection with the given UUID exists in the client.

      • databaseConnectionName

        String databaseConnectionName​(UuidEntityRef dbConnection)
        Gets the name of a database connection, identified by its UUID. The search for connections is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        dbConnection - The database connection reference to get the name for.
        Returns:
        The name of the database connection, or empty if no database connection with the given UUID exists in the client.

      • databaseQueryName

        String databaseQueryName​(UUID dbQueryUuid)
        Gets the name of a database query, identified by its UUID. The search for queries is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        dbQueryUuid - The UUID of the database query to get the name for.
        Returns:
        The name of the database query, or empty if no database query with the given UUID exists in the client.

      • databaseQueryName

        String databaseQueryName​(UuidEntityRef dbQuery)
        Gets the name of a database query, identified by its UUID. The search for queries is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        dbQuery - The database query reference to get the name for.
        Returns:
        The name of the database query, or empty if no database query with the given UUID exists in the client.

      • directClientAuthorizationName

        String directClientAuthorizationName​(UUID directClientAuthorizationUuid)
        Gets the name of a direct client authorization, identified by its UUID. The search is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        directClientAuthorizationUuid - The UUID of the direct client authorization to get the name for.
        Returns:
        The name of the direct client authorization, or empty if no direct client authorization with the given UUID exists in the client.

      • directClientAuthorizationName

        String directClientAuthorizationName​(UuidEntityRef directClientAuthorization)
        Gets the name of a direct client authorization, identified by its UUID. The search is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        directClientAuthorization - The direct client authorization reference to get the name for.
        Returns:
        The name of the direct client authorization, or empty if no direct client authorization with the given UUID exists in the client.

      • entityContext

        IEntityContext entityContext()
        Grants access to the entity context that can be used for custom database queries.
        Returns:
        The entity context for this store.

      • entityName

        String entityName​(EntityRef entity)
        Gets the name of the given entity reference.
        Parameters:
        entity - The entity reference for which to get the name.
        Returns:
        The name of the entity, or empty string if no matching entity exists.

      • entityName

        String entityName​(UuidEntityRef entity)
        Gets the name of the given entity reference.
        Parameters:
        entity - The entity reference for which to get the name.
        Returns:
        The name of the entity, or empty string if no matching entity exists.

      • formFileName

        String formFileName​(UUID formFileUuid)
        Gets the name of a form file, identified by its UUID. Uses the form of the workflow for which the BPMN diagram is being created.
        Parameters:
        formFileUuid - The UUID of the form file to get the name for.
        Returns:
        The name of the form file, or empty if no form file with the given UUID exists in the project.

      • formFileName

        String formFileName​(UuidEntityRef formFile)
        Gets the name of a form file, identified by its UUID. Uses the form of the workflow for which the BPMN diagram is being created.
        Parameters:
        formFile - The form file reference to get the name for.
        Returns:
        The name of the form file, or empty if no form file with the given UUID exists in the project.

      • inboxName

        String inboxName​(UUID inboxUuid)
        Gets the name of an inbox, identified by its UUID. The search for inboxes is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        inboxUuid - The UUID of the inbox to get the name for.
        Returns:
        The name of the inbox, or empty if no inbox with the given UUID exists in the client.

      • inboxName

        String inboxName​(UuidEntityRef inbox)
        Gets the name of an inbox, identified by its UUID. The search for inboxes is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        inbox - The inbox reference to get the name for.
        Returns:
        The name of the inbox, or empty if no matching inbox exists in the client.

      • indirectClientAuthorizationName

        String indirectClientAuthorizationName​(UUID indirectClientAuthorizationUuid)
        Gets the name of an indirect client authorization, identified by its UUID. The search is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        indirectClientAuthorizationUuid - The UUID of the indirect client authorization to get the name for.
        Returns:
        The name of the indirect client authorization, or empty if no indirect client authorization with the given UUID exists in the client.

      • indirectClientAuthorizationName

        String indirectClientAuthorizationName​(UuidEntityRef indirectClientAuthorization)
        Gets the name of an indirect client authorization, identified by its UUID. The search is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        indirectClientAuthorization - The indirect client authorization reference to get the name for.
        Returns:
        The name of the indirect client authorization, or empty if no indirect client authorization with the given UUID exists in the client.

      • ldapConnectionForQuery

        UuidEntityRef ldapConnectionForQuery​(UUID ldapQueryUuid)
        Gets the UUID of an LDAP connection, identified by the UUID of a referencing LDAP query. The search is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        ldapQueryUuid - The UUID of an LDAP query that references an LDAP connection.
        Returns:
        The UUID of the LDAP connection, or null if no LDAP connection with the given UUID exists in the client.

      • ldapConnectionForQuery

        UuidEntityRef ldapConnectionForQuery​(UuidEntityRef ldapQuery)
        Gets the UUID of an LDAP connection, identified by the UUID of a referencing LDAP query. The search is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        ldapQuery - The LDAP query reference that references an LDAP connection.
        Returns:
        The UUID of the LDAP connection, or null if no LDAP connection with the given UUID exists in the client.

      • ldapConnectionName

        String ldapConnectionName​(UUID ldapConnectionUuid)
        Gets the name of an LDAP connection, identified by its UUID. The search for connections is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        ldapConnectionUuid - The UUID of the LDAP connection to get the name for.
        Returns:
        The name of the LDAP connection, or empty if no LDAP connection with the given UUID exists in the client.

      • ldapConnectionName

        String ldapConnectionName​(UuidEntityRef ldapConnection)
        Gets the name of an LDAP connection, identified by its UUID. The search for connections is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        ldapConnection - The LDAP connection reference to get the name for.
        Returns:
        The name of the LDAP connection, or empty if no LDAP connection with the given UUID exists in the client.

      • ldapQueryName

        String ldapQueryName​(UUID ldapQueryUuid)
        Gets the name of an LDAP query, identified by its UUID. The search for queries is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        ldapQueryUuid - The UUID of the LDAP query to get the name for.
        Returns:
        The name of the LDAP query, or empty if no LDAP query with the given UUID exists in the client.

      • ldapQueryName

        String ldapQueryName​(UuidEntityRef ldapQuery)
        Gets the name of an LDAP query, identified by its UUID. The search for queries is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        ldapQuery - The LDAP query reference to get the name for.
        Returns:
        The name of the LDAP query, or empty if no LDAP query with the given UUID exists in the client.

      • project

        Projekt project()
        Gets the project to which the workflow belongs that is being modeled as a BPMN diagram.
        Returns:
        The project of the workflow, never null.

      • textTemplateName

        String textTemplateName​(UUID textTemplateUuid)
        Gets the name of a text template, identified by its UUID. The search for templates is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        textTemplateUuid - The UUID of the text template to get the name for.
        Returns:
        The name of the text template, or empty if no text template with the given UUID exists in the client.

      • textTemplateName

        String textTemplateName​(UuidEntityRef textTemplate)
        Gets the name of a text template, identified by its UUID. The search for templates is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        textTemplate - The text template reference to get the name for.
        Returns:
        The name of the text template, or empty if no text template with the given UUID exists in the client.

      • userGroupName

        String userGroupName​(UUID userGroupUuid)
        Gets the name of a user group, identified by its UUID. The search for user groups is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        userGroupUuid - The UUID of the user group to get the name for.
        Returns:
        The name of the user group, or empty if no user group with the given UUID exists in the client.

      • userGroupName

        String userGroupName​(UuidEntityRef userGroup)
        Gets the name of a user group, identified by its UUID. The search for user groups is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        userGroup - The user group reference to get the name for.
        Returns:
        The name of the user group, or empty if no user group with the given UUID exists in the client.

      • webDavConnectionName

        String webDavConnectionName​(UUID webDavConnectionUuid)
        Gets the name of a WebDAV connection, identified by its UUID. The search for WebDAV connections is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        webDavConnectionUuid - The UUID of the WebDAV connection to get the name for.
        Returns:
        The name of the WebDAV connection, or empty if no WebDAV connection with the given UUID exists in the client.

      • webDavConnectionName

        String webDavConnectionName​(UuidEntityRef webDavConnection)
        Gets the name of a WebDAV connection, identified by its UUID. The search for WebDAV connections is limited to the client of the workflow for which the BPMN diagram is being created.
        Parameters:
        webDavConnection - The WebDAV connection reference to get the name for.
        Returns:
        The name of the WebDAV connection, or empty if no WebDAV connection with the given UUID exists in the client.

      • workflowStateName

        String workflowStateName​(UUID workflowStateUuid)
        Gets the name of a workflow state, identified by its UUID.
        Parameters:
        workflowStateUuid - The UUID of the workflow state to get the name for.
        Returns:
        The name of the workflow state, or empty if no workflow state with the given UUID exists.

      • workflowStateName

        String workflowStateName​(UuidEntityRef workflowState)
        Gets the name of a workflow state, identified by its UUID.
        Parameters:
        workflowState - The workflow state reference to get the name for.
        Returns:
        The name of the workflow state, or empty if no workflow state with the given UUID exists.

      • zone

        ZoneId zone()
        Gets the default system time zone of the workflow engine, which is used for date and time calculations.
        Returns:
        The system time zone, never null.