Package de.aristaflow.adept2.core.activityrepository

Interface ActivityTemplateDefinitionManager

  • public interface ActivityTemplateDefinitionManager
    This interface provides the means for managing ActivityTemplateDefinitions which includes retrieval, creation, updating and managing the states of ActivityTemplateDefinitions. Activity template definitions are identified by their name, the name of their operation and the name of their executable component description. Their name is therefore unique with respect to the operation. Additionally they are identified by a separate ID.

    If the provided entity (or its identifying attributes) of a method does not exist, an UnknownEntityException will be thrown.

    • Method Detail

      • getATDReference

        ATDReference getATDReference​(SessionToken session,
                             UUID atID)
        Gets a lightweight object representing the revision of the activity model branch having the designated ID.
        Parameters:
        session - The session which is used to check for access rights on this method.
        atID - The ID of the activity template of which to retrieve the corresponding activity model branch and its revision.
        Returns:
        The activity template definition reference representing the activity model branch (and its revision) identified by the designated ID.
        Throws:
        UnknownEntityException - If the designated ATD does not exist, an UnknownEntityException will be thrown.

      • getLatestATDReferencesOfOperation

        Collection<ATDReference> getLatestATDReferencesOfOperation​(SessionToken session,
                                                           String ecName,
                                                           String operationName,
                                                           boolean productionOnly)
        Gets lightweight objects representing the latest revisions ( IN_PRODUCTION and/or OUTDATED) of all activity template definitions of the designated operation known by this manager.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the operation of which to retrieve all latest revisions of the activity template definitions.
        operationName - The name of the operation of which to retrieve all latest revisions of the activity template definitions.
        productionOnly - Whether only the revisions IN_PRODUCTCION should be retrieved.
        Returns:
        Lightweight representations of the latest revisions of activity template definitions of the designated operation IN_PRODUCTION and/or OUTDATED known by this manager.
        Throws:
        UnknownEntityException - If the designated operation (or the executable component description) does not exist, an UnknownEntityException will be thrown.

      • getLatestATDReferencesOfOperationIterator

        RemoteIterator<List<ATDReference>> getLatestATDReferencesOfOperationIterator​(SessionToken session,
                                                                             String ecName,
                                                                             String operationName,
                                                                             boolean productionOnly)
        The same as getLatestATDReferencesOfOperation(SessionToken, String, String, boolean) but with partial retrieval of the references.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the operation of which to retrieve all latest revisions of the activity template definitions.
        operationName - The name of the operation of which to retrieve all latest revisions of the activity template definitions.
        productionOnly - Whether only the revisions IN_PRODUCTCION should be retrieved.
        Returns:
        Lightweight representations of the latest revisions of activity template definitions of the designated operation IN_PRODUCTION and/or OUTDATED known by this manager as iterator. The caller is responsible for closing.
        Throws:
        UnknownEntityException - If the designated operation (or the executable component description) does not exist, an UnknownEntityException will be thrown.

      • getLatestATDReferencesOfCS

        Collection<ATDReference> getLatestATDReferencesOfCS​(SessionToken session,
                                                    String csName,
                                                    boolean productionOnly)
        Gets lightweight objects representing the latest revisions ( IN_PRODUCTION and/or OUTDATED) of all activity template definitions of the designated configuration set known by this manager.
        Parameters:
        session - The session which is used to check for access rights on this method.
        csName - The name of the configuration set of which to retrieve all latest revisions of the activity template definitions.
        productionOnly - Whether only the revisions IN_PRODUCTION should be retrieved.
        Returns:
        Lightweight representations of the latest revisions of activity template definitions of the designated configuration set IN_PRODUCTION and/or OUTDATED known by this manager.
        Throws:
        UnknownEntityException - If the designated configuration set does not exist, an UnknownEntityException will be thrown.

      • getLatestATDReferencesOfCSIterator

        RemoteIterator<List<ATDReference>> getLatestATDReferencesOfCSIterator​(SessionToken session,
                                                                      String csName,
                                                                      boolean productionOnly)
        The same as getLatestATDReferencesOfCS(SessionToken, String, boolean) but with partial retrieval of the references.
        Parameters:
        session - The session which is used to check for access rights on this method.
        csName - The name of the configuration set of which to retrieve all latest revisions of the activity template definitions.
        productionOnly - Whether only the revisions IN_PRODUCTION should be retrieved.
        Returns:
        Lightweight representations of the latest revisions of activity template definitions of the designated configuration set IN_PRODUCTION and/or OUTDATED known by this manager as iterator. The caller is responsible for closing.
        Throws:
        UnknownEntityException - If the designated configuration set does not exist, an UnknownEntityException will be thrown.

      • getATDReferencesRevisionOfOperation

        Collection<ATDReference> getATDReferencesRevisionOfOperation​(SessionToken session,
                                                             String ecName,
                                                             String operationName,
                                                             long revision)
        Gets lightweight objects representing all activity template definitions of the designated revision of the designated operation known by this manager. These are either IN_PRODUCTION or OUTDATED depending on whether they have been changed or set to outdated from the designated to the latest revision.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the operation of which to retrieve all activity template definitions of the designated revision.
        operationName - The name of the operation of which to retrieve all activity template definitions of the designated revision.
        revision - The revision of which to retrieve all activity template definition of the designated operation known by this manager.
        Returns:
        Lightweight representations of all activity template definitions of the designated operation of the designated revision known by this manager.

      • getATDReferencesRevisionOfOperationIterator

        RemoteIterator<List<ATDReference>> getATDReferencesRevisionOfOperationIterator​(SessionToken session,
                                                                               String ecName,
                                                                               String operationName,
                                                                               long revision)
        The same as getATDReferencesRevisionOfOperation(SessionToken, String, String, long) but with partial retrieval of the references.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the operation of which to retrieve all activity template definitions of the designated revision.
        operationName - The name of the operation of which to retrieve all activity template definitions of the designated revision.
        revision - The revision of which to retrieve all activity template definition of the designated operation known by this manager as iterator.
        Returns:
        Lightweight representations of all activity template definitions of the designated operation of the designated revision known by this manager. The caller is responsible for closing.

      • getATDReferencesRevisionOfCS

        Collection<ATDReference> getATDReferencesRevisionOfCS​(SessionToken session,
                                                      String csName,
                                                      long revision)
        Gets lightweight objects representing all activity template definitions of the designated revision of the designated configuration set known by this manager. These are either IN_PRODUCTION or OUTDATED depending on whether they have been changed or set to outdated from the designated to the latest revision.
        Parameters:
        session - The session which is used to check for access rights on this method.
        csName - The name of the configuration set of which to retrieve all activity template definitions of the designated revision.
        revision - The revision of which to retrieve all activity template definition of the designated configuration set known by this manager.
        Returns:
        Lightweight representations of all activity template definitions of the designated configuration set of the designated revision known by this manager.

      • getATDReferencesRevisionOfCSIterator

        RemoteIterator<List<ATDReference>> getATDReferencesRevisionOfCSIterator​(SessionToken session,
                                                                        String csName,
                                                                        long revision)
        The same as getATDReferencesRevisionOfCS(SessionToken, String, long) but with partial retrieval of the references.
        Parameters:
        session - The session which is used to check for access rights on this method.
        csName - The name of the configuration set of which to retrieve all activity template definitions of the designated revision.
        revision - The revision of which to retrieve all activity template definition of the designated configuration set known by this manager.
        Returns:
        Lightweight representations of all activity template definitions of the designated configuration set of the designated revision known by this manager as iterator. The caller is responsible for closing.

      • getLatestATDReference

        ATDReference getLatestATDReference​(SessionToken session,
                                   String ecName,
                                   String operationName,
                                   String atdName)
        Gets a lightweight object representing the latest revision of the designated activity template definition.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the activity template definition of which to retrieve a lightweight representation.
        operationName - The name of the operation of the activity template definition which to retrieve a lightweight representation.
        atdName - The name of the activity template definition of which to retrieve a lightweight representation.
        Returns:
        A lightweight representation of the latest revision of the operation having the designated name.
        Throws:
        UnknownEntityException - If the designated activity template definition (or the operation or the executable component description) does not exist, an UnknownEntityException will be thrown.

      • getATDReferenceRevisions

        List<ATDReference> getATDReferenceRevisions​(SessionToken session,
                                            String ecName,
                                            String operationName,
                                            String atdName)
        Gets lightweight objects representing all revisions of the designated activity template definition or an empty list in case there are no revisions yet.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the activity template definition of which to retrieve all revisions as lightweight representation.
        operationName - The name of the operation of the activity template definition of which to retrieve all revisions as lightweight representation.
        atdName - The name of the activity template definition of which to retrieve all revisions as lightweight representation.
        Returns:
        Lightweight representation of all revisions of the activity template definition having the designated name.
        Throws:
        UnknownEntityException - If the designated activity template definition (or the operation or the executable component description) does not exist, an UnknownEntityException will be thrown.

      • getATDReferenceRevisionsIterator

        RemoteIterator<List<ATDReference>> getATDReferenceRevisionsIterator​(SessionToken session,
                                                                    String ecName,
                                                                    String operationName,
                                                                    String atdName)
        The same as getATDReferenceRevisions(SessionToken, String, String, String) but with partial retrieval of the references.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the activity template definition of which to retrieve all revisions as lightweight representation.
        operationName - The name of the operation of the activity template definition of which to retrieve all revisions as lightweight representation.
        atdName - The name of the activity template definition of which to retrieve all revisions as lightweight representation.
        Returns:
        Lightweight representation of all revisions of the activity template definition having the designated name as iterator. The caller is responsible for closing.
        Throws:
        UnknownEntityException - If the designated activity template definition (or the operation or the executable component description) does not exist, an UnknownEntityException will be thrown.

      • getLatestATD

        ActivityTemplateDefinition getLatestATD​(SessionToken session,
                                        String ecName,
                                        String operationName,
                                        String atdName)
        Gets the (full-fledged object representing the) latest revision of the designated activity template definition.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the activity template definition of which to retrieve the latest revision.
        operationName - The name of the operation of the activity template definition of which to retrieve the latest revision.
        atdName - The name of the activity template definition of which to retrieve the latest revision.
        Returns:
        The latest revision of the activity template definition having the designated name.
        Throws:
        UnknownEntityException - If the designated activity template definition (or the operation or the executable component description) does not exist, an UnknownEntityException will be thrown.

      • getATDRevision

        ActivityTemplateDefinition getATDRevision​(SessionToken session,
                                          String ecName,
                                          String operationName,
                                          String atdName,
                                          long revision)
        Gets the (full-fledged object representing the) designated revision of the designated activity template definition.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the activity template definition of which to retrieve a specific revision.
        operationName - The name of operation of the activity template definition of which to retrieve a specific revision.
        atdName - The name of activity template definition of which to retrieve a specific revision.
        revision - The revision of the activity template which to retrieve.
        Returns:
        The designated revision of the activity template definition having the designated name.
        Throws:
        UnknownEntityException - If the designated activity template definition (or the operation or the executable component description) or the revision does not exist, an UnknownEntityException will be thrown.

      • getDevelopmentATDReferencesOfOperation

        Collection<ATDReference> getDevelopmentATDReferencesOfOperation​(SessionToken session,
                                                                String ecName,
                                                                String operationName,
                                                                long branch)
        Gets lightweight objects representing the development versions of all activity template definitions of the designated operation in the designated branch known by this manager. The development versions stem from the base revision of the designated branch, that is, unchanged entities are copies of the corresponding base revisions while changed entities are modified with respect to the base revision. Therefore the returned (referenced) entities may be IN_DEVELOPMENT (changed entities), IN_PRODUCTION (unchanged entities whereas the base revision is the latest revision) or OUTDATED (unchanged entities).
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the operation of which to retrieve all development versions of the activity template definitions.
        operationName - The name of the operation of which to retrieve all development versions of the activity template definitions.
        branch - The branch of which to retrieve lightweight objects representing the activity template definitions of the designated operation.
        Returns:
        Lightweight representations of the development versions of all activity template definitions of the designated operation in the designated branch (changed or unchanged entities) known by this manager.
        Throws:
        UnknownEntityException - If the designated operation (or the executable component description) does not exist or the designated branch is currently unused, an UnknownEntityException will be thrown.

      • getDevelopmentATDReferencesOfOperationIterator

        RemoteIterator<List<ATDReference>> getDevelopmentATDReferencesOfOperationIterator​(SessionToken session,
                                                                                  String ecName,
                                                                                  String operationName,
                                                                                  long branch)
        The same as getDevelopmentATDReferencesOfOperation(SessionToken, String, String, long) but with partial retrieval of the references.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the operation of which to retrieve all development versions of the activity template definitions.
        operationName - The name of the operation of which to retrieve all development versions of the activity template definitions.
        branch - The branch of which to retrieve lightweight objects representing the activity template definitions of the designated operation.
        Returns:
        Lightweight representations of the development versions of all activity template definitions of the designated operation in the designated branch (changed or unchanged entities) known by this manager as iterator. The caller is responsible for closing.
        Throws:
        UnknownEntityException - If the designated operation (or the executable component description) does not exist or the designated branch is currently unused, an UnknownEntityException will be thrown.

      • getDevelopmentATDReferencesOfCS

        Collection<ATDReference> getDevelopmentATDReferencesOfCS​(SessionToken session,
                                                         String csName,
                                                         long branch)
        Gets lightweight objects representing the development versions of all activity template definitions of the designated configuration set in the designated branch known by this manager. The development versions stem from the base revision of the designated branch, that is, unchanged entities are copies of the corresponding base revisions while changed entities are modified with respect to the base revision. Therefore the returned (referenced) entities may be IN_DEVELOPMENT (changed entities), IN_PRODUCTION (unchanged entities whereas the base revision is the latest revision) or OUTDATED (unchanged entities).
        Parameters:
        session - The session which is used to check for access rights on this method.
        csName - The name of the configuration set of which to retrieve all development versions of the activity template definitions.
        branch - The branch of which to retrieve lightweight objects representing the activity template definitions of the designated configuration set.
        Returns:
        Lightweight representations of the development versions of all activity template definitions of the designated configuration set in the designated branch (changed or unchanged entities) known by this manager.
        Throws:
        UnknownEntityException - If the designated configuration set does not exist or the designated branch is currently unused, an UnknownEntityException will be thrown.

      • getDevelopmentATDReferencesOfCSIterator

        RemoteIterator<List<ATDReference>> getDevelopmentATDReferencesOfCSIterator​(SessionToken session,
                                                                           String csName,
                                                                           long branch)
        The same as getDevelopmentATDReferencesOfCS(SessionToken, String, long) but with partial retrieval of the references.
        Parameters:
        session - The session which is used to check for access rights on this method.
        csName - The name of the configuration set of which to retrieve all development versions of the activity template definitions.
        branch - The branch of which to retrieve lightweight objects representing the activity template definitions of the designated configuration set.
        Returns:
        Lightweight representations of the development versions of all activity template definitions of the designated configuration set in the designated branch (changed or unchanged entities) known by this manager as iterator. The caller is responsible for closing.
        Throws:
        UnknownEntityException - If the designated configuration set does not exist or the designated branch is currently unused, an UnknownEntityException will be thrown.

      • getDevelopmentATD

        ActivityTemplateDefinition getDevelopmentATD​(SessionToken session,
                                             String ecName,
                                             String operationName,
                                             String atdName,
                                             long branch)
        Gets the (full-fledged object representing the) development version of the designated activity template definition in the designated branch. The returned entity will be IN_DEVELOPMENT if it has already been changed with respect to its base revision. Otherwise the entity will a copy of the base revision of the branch and therefore IN_PRODUCTION (in case the base revision is the latest revision) or OUTDATED (in case the base revision is already outdated). This copy will be set IN_DEVELOPMENT as soon as it is stored the first time.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the activity template definition of which to retrieve the development version of the designated branch.
        operationName - The name of the operation of the activity template definition of which to retrieve the development version of the designated branch.
        atdName - The name of the activity template definition of which to retrieve the development version of the designated branch.
        branch - The branch of which to retrieve the corresponding activity template definition (or a new copy of the corresponding base revision entity in case it has not been changed before in this branch).
        Returns:
        The development version of the activity template definition in the designated branch.
        Throws:
        UnknownEntityException - If the designated activity template definition (or the operation or the executable component description) does not exist or the designated branch is currently unused, an UnknownEntityException will be thrown.

      • storeDevelopmentATD

        void storeDevelopmentATD​(SessionToken session,
                         StorageActivityTemplateDefinition atd,
                         long branch)
        Stores the designated (storage representation of the) activity template definition in the designated branch and sets it IN_DEVELOPMENT if not done yet. All changes are therefore persisted. The branch is usually the same as specified when retrieving the activity template definition for development. However, it can be changed but the content of the target branch will be overwritten. This can be used to copy changes between branches.
        When storing a new activity template definition its ID does not need to be set. When storing a changed activity template definition, its ID will be changed.
        Parameters:
        session - The session which is used to check for access rights on this method and to identify the storing agent and the corresponding organisational position.
        atd - The activity template definition providing the new attributes to be set. Activity template definitions are identified by their name, therefore the name will not be able to be changed if there is at least one production revision.
        branch - The branch in which to store the corresponding activity template definition.
        Throws:
        UnknownEntityException - If the designated branch is currently unused, an UnknownEntityException will be thrown.

      • importDevelopmentATD

        void importDevelopmentATD​(SessionToken session,
                          StorageActivityTemplateDefinition atd,
                          long branch)
        Imports the designated (storage representation of the) activity template definition as retrieved from an external ACB-file into the designated branch. I.e. its state will be IN_DEVELOPMENT regardless of its previous state. If the designated activity template definition already exists, it will be overridden with the designated one. All changes are therefore persisted.
        This method is basically identical to storeDevelopmentATD(SessionToken, StorageActivityTemplateDefinition, long) except that the ID of the activity template definition will not be changed.
        Parameters:
        session - The session which is used to check for access rights on this method and to identify the importing agent and the corresponding organisational position.
        atd - The activity template definition to be imported. The designated activity template definition is identified by its name as well as its ID.
        branch - The branch in which to store the corresponding activity template definition.
        Throws:
        UnknownEntityException - If the designated branch is currently unused, an UnknownEntityException will be thrown.

      • revertDevelopmentATD

        void revertDevelopmentATD​(SessionToken session,
                          String ecName,
                          String operationName,
                          String atdName,
                          long branch)
        Reverts the designated development activity template definition in the designated branch that is all changes will be undone and the activity template definition will logically be the same as the base revision of the branch.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the activity template definition of which to revert the development version in the designated branch.
        operationName - The name of the operation of the activity template definition of which to delete the development version in the designated branch.
        atdName - The name of the activity template definition of which to delete the development version in the designated branch.
        branch - The branch in which to revert the designated activity template definition and therefore undoing made changes.
        Throws:
        UnknownEntityException - If the designated activity template definition (or the operation or the executable component description) does not exist in the designated branch or does not exist at all or the designated branch is currently unused, an UnknownEntityException will be thrown.

      • simulateUpdateOfDevelopmentATD

        CheckReport simulateUpdateOfDevelopmentATD​(SessionToken session,
                                           String ecName,
                                           String operationName,
                                           String atdName,
                                           long branch)
        Simulates updating of the designated activity template definition in the designated branch, that is only the designated activity template definition of the branch is checked for whether it can be updated to the latest revision. The returned check report therefore contains all conflicts due to versioning. These occur for concurrent changes in the designated branch and changing the latest revision (by releasing a new one). If conflicts occur, checking only for one activity template definition instead of checking the whole branch will provide a much simpler way to resolve these conflicts.
        When checking an activity template definition that does not have any changes in the designated branch, the check report will contain no entries, indicating that there will be no problems when updating.
        Parameters:
        session - The session which is used to check for access rights on this method.
        ecName - The name of the executable component description of the activity template definition of which to check versioning conflicts due to updating to the latest revision.
        operationName - The name of the operation of the activity template definition which to check for versioning conflicts due to updating to the latest revision.
        atdName - The name of the activity template definition which to check for versioning conflicts due to updating to the latest revision.
        branch - The branch in which to check the designated activity template definition for versioning conflicts when updating.
        Returns:
        A check report providing information on versioning on the designated activity template definition only.
        Throws:
        UnknownEntityException - If the designated acitivty template definition (or the operation or the executable component description) does not exist in the designated branch or does not exist at all, an UnknownEntityException will be thrown.

      • outdateATD

        void outdateATD​(SessionToken session,
                String ecName,
                String operationName,
                String atdName)
        Outdates the latest revision of the designated activity template definition explicitly which prevents its usage afterwards. The latest revision may be used for a development version which in turn may be released later.
        Outdating an OUTDATED activity template definition will be ignored.
        Parameters:
        session - The session which is used to check for access rights on this method and to identify the outdating agent and the corresponding organisational position.
        ecName - The name of the executable component description of the activity template definition of which to explicitly outdate the latest revision.
        operationName - The name of the operation of the activity template definition of which to explicitly outdate the latest revision.
        atdName - The name of the activity template definition of which to explicitly outdate the latest revision.
        Throws:
        UnknownEntityException - If the designated activity template definition (or the operation or the executable component description) does not exist, an UnknownEntityException will be thrown.