com.ibm.pdp.maf.rpp.service

Interface IMAFModelService

  • All Known Implementing Classes:
    MAFModelService


    public interface IMAFModelService

    This interface contains the services methods to retrieve entity model in the local workspace.

    • We provide a convenience method to retrieve model entity problems.

    • We provide a convenience method to retrieve references for a RadicalElement.

    • Method Detail

      • closeLocation

        boolean closeLocation(java.lang.String locationName)

        Closes the location. If success returns true.

        Parameters:
        locationName -
        Returns:
      • getAbstractBlockBase

        AbstractBlockBase getAbstractBlockBase(java.lang.String projectName,
                                             java.lang.String packageName,
                                             java.lang.String entityName)

        Returns the concrete Abstract Block Base for this project name, package name and entity name. Or null if not present in local workspace.

        • Can be an instance of RelationBlockBase, HierarchicalBlockBase, CodasyBlockBase or SocrateBlockBase

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getAbstractSegment

        AbstractSegment getAbstractSegment(java.lang.String projectName,
                                         java.lang.String packageName,
                                         java.lang.String entityName)

        Returns the concrete Abstract Segment for this project name, package name and entity name. Or null if not present in local workspace.

        • Can be an instance of Segment, Table, LogicalView or MonoStructureSegment

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getCodasylBlockBase

        CodasylBlockBase getCodasylBlockBase(java.lang.String projectName,
                                           java.lang.String packageName,
                                           java.lang.String entityName)

        Returns the Codeasyl Block Base for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getCommunicationMonitor

        CommunicationMonitor getCommunicationMonitor(java.lang.String projectName,
                                                   java.lang.String packageName,
                                                   java.lang.String entityName)
        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getCopybook

        Copybook getCopybook(java.lang.String projectName,
                           java.lang.String packageName,
                           java.lang.String entityName)
        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getDataElement

        DataElement getDataElement(java.lang.String projectName,
                                 java.lang.String packageName,
                                 java.lang.String entityName)

        Returns the Data Element for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getDataStructure

        DataStructure getDataStructure(java.lang.String projectName,
                                     java.lang.String packageName,
                                     java.lang.String entityName)

        Returns the Data Structure for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getDialog

        Dialog getDialog(java.lang.String projectName,
                       java.lang.String packageName,
                       java.lang.String entityName)

        Returns the Dialog for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getDialogCommunicationMonitor

        DialogCommunicationMonitor getDialogCommunicationMonitor(java.lang.String projectName,
                                                               java.lang.String packageName,
                                                               java.lang.String entityName)
        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getDialogFolder

        DialogFolder getDialogFolder(java.lang.String projectName,
                                   java.lang.String packageName,
                                   java.lang.String entityName)
        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getDialogFolderView

        DialogFolderView getDialogFolderView(java.lang.String projectName,
                                           java.lang.String packageName,
                                           java.lang.String entityName)
        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getDialogServer

        DialogServer getDialogServer(java.lang.String projectName,
                                   java.lang.String packageName,
                                   java.lang.String entityName)

        Returns the Dialog Server for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getErrorLabel

        ErrorLabel getErrorLabel(java.lang.String projectName,
                               java.lang.String packageName,
                               java.lang.String entityName)
        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getFolder

        Folder getFolder(java.lang.String projectName,
                       java.lang.String packageName,
                       java.lang.String entityName)
        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getFolderView

        FolderView getFolderView(java.lang.String projectName,
                               java.lang.String packageName,
                               java.lang.String entityName)
        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getHierarchicalBlockBase

        HierarchicalBlockBase getHierarchicalBlockBase(java.lang.String projectName,
                                                     java.lang.String packageName,
                                                     java.lang.String entityName)

        Returns the Hierarchical Block Base for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getInputAid

        InputAid getInputAid(java.lang.String projectName,
                           java.lang.String packageName,
                           java.lang.String entityName)

        Returns the UnputAid for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getLibrary

        Library getLibrary(java.lang.String projectName,
                         java.lang.String packageName,
                         java.lang.String entityName)

        Returns the Library for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getLogicalView

        LogicalView getLogicalView(java.lang.String projectName,
                                 java.lang.String packageName,
                                 java.lang.String entityName)

        Returns the Logical View for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getMacro

        Macro getMacro(java.lang.String projectName,
                     java.lang.String packageName,
                     java.lang.String entityName)

        Returns the Macro for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getMetaDataAggregate

        MetaDataAggregate getMetaDataAggregate(java.lang.String projectName,
                                             java.lang.String packageName,
                                             java.lang.String entityName)

        Returns the Meta Data Aggregate for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getMetaEntity

        MetaEntity getMetaEntity(java.lang.String projectName,
                               java.lang.String packageName,
                               java.lang.String entityName)

        Returns the Meta Entity for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getMetaEntityType

        MetaEntityType getMetaEntityType(java.lang.String projectName,
                                       java.lang.String packageName,
                                       java.lang.String entityName)

        Returns the Meta Entity Type for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getMonoStructureSegment

        MonoStructureSegment getMonoStructureSegment(java.lang.String projectName,
                                                   java.lang.String packageName,
                                                   java.lang.String entityName)

        Returns the Mono Structure Segment for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getProblems

        java.util.List<IProblem> getProblems(RadicalElement radicalElement)

        Returns model problems for this element.

        Parameters:
        radicalElement -
        Returns:
      • getProgram

        Program getProgram(java.lang.String projectName,
                         java.lang.String packageName,
                         java.lang.String entityName)

        Returns the Program for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getRadicalElement

        RadicalElement getRadicalElement(java.lang.String designId)

        Returns the radical element for this designId.

        Parameters:
        designId -
        Returns:
      • getRadicalElement

        RadicalElement getRadicalElement(java.lang.String projectName,
                                       java.lang.String packageName,
                                       java.lang.String entityName,
                                       java.lang.String entityType)

        Returns the RadicalElement for this project name, package name, entity name and entity type. Or null if not present in local workspace.

        • entity type is the model extension of a radical element. For example : dataaggregate for a Segment or Table.

        Parameters:
        projectName -
        packageName -
        entityName -
        entityType -
        Returns:
      • getRadicalElement

        RadicalElement getRadicalElement(java.lang.String projectName,
                                       java.lang.String packageName,
                                       java.lang.String metaEntityName,
                                       java.lang.String entityName,
                                       java.lang.String entityType)

        Returns the RadicalElemenr for this project name, package name, meta entity name, entity name and entity type. Or null if not present in local workspace.

        • meta entity name is mandatory for UserEntity

        • entity type is the model extension of a radical element. For example : dataaggregate for a Segment or Table.

        Parameters:
        projectName -
        packageName -
        metaEntityName -
        entityName -
        entityType -
        Returns:
      • getRelationalBlockBase

        RelationalBlockBase getRelationalBlockBase(java.lang.String projectName,
                                                 java.lang.String packageName,
                                                 java.lang.String entityName)

        Returns the Relational Block Base for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getReport

        Report getReport(java.lang.String projectName,
                       java.lang.String packageName,
                       java.lang.String entityName)

        Returns the Report for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getScreen

        Screen getScreen(java.lang.String projectName,
                       java.lang.String packageName,
                       java.lang.String entityName)

        Returns the Screen for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getServer

        Server getServer(java.lang.String projectName,
                       java.lang.String packageName,
                       java.lang.String entityName)

        Returns the Server for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getSocrateBlockBase

        SocrateBlockBase getSocrateBlockBase(java.lang.String projectName,
                                           java.lang.String packageName,
                                           java.lang.String entityName)

        Returns the Socrate Block Base for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getStandardSegment

        StandardSegment getStandardSegment(java.lang.String projectName,
                                         java.lang.String packageName,
                                         java.lang.String entityName)

        Returns the Standard Segment for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getTable

        Table getTable(java.lang.String projectName,
                     java.lang.String packageName,
                     java.lang.String entityName)

        Returns the Table for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getText

        Text getText(java.lang.String projectName,
                   java.lang.String packageName,
                   java.lang.String entityName)

        Returns the Text for this project name, package name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • getUserEntity

        UserEntity getUserEntity(java.lang.String projectName,
                               java.lang.String packageName,
                               java.lang.String metaEntityName,
                               java.lang.String entityName)

        Returns the User Entity for this project name, package name, meta entity name and entity name. Or null if not present in local workspace.

        Parameters:
        projectName -
        packageName -
        metaEntityName -
        entityName -
        Returns:
      • getVolume

        Volume getVolume(java.lang.String projectName,
                       java.lang.String packageName,
                       java.lang.String entityName)
        Parameters:
        projectName -
        packageName -
        entityName -
        Returns:
      • isLocationOpen

        boolean isLocationOpen(java.lang.String locationName)

        Returns true if the location is open.

        Parameters:
        locationName -
        Returns:
      • openLocation

        boolean openLocation(java.lang.String locationName)

        Opens the location. If success returns true.

        Parameters:
        locationName -
        Returns:
      • references

        java.util.List<RadicalElement> references(RadicalElement radicalElement,
                                                boolean subReferences)

        Returns the references of the radical element.

        • if subReferences is true then returns the sub references.

        • if subReferences is false then returns the super references.

        Parameters:
        radicalElement -
        subReferences -
        Returns:
      • referencesIds

        java.util.List<java.lang.String> referencesIds(RadicalElement radicalElement,
                                                     boolean subReferences)

        Returns the references of the radical element. Returns a  list of radical element design id. Can be useful in case of huge volume of result.

        • if subReferences is true then returns the sub references.

        • if subReferences is false then returns the super references.

        Parameters:
        radicalElement -
        subReferences -
        Returns:
      • search

        java.util.List<RadicalElement> search(IMAFSearchPattern searchPattern)

        Returns the list of radical elements base on this pattern.

        Parameters:
        searchPattern -
        Returns:
      • searchIds

        java.util.List<java.lang.String> searchIds(IMAFSearchPattern searchPattern)

        Returns the list of radical elements base on this pattern. Returns a list of radical element design id. Can be useful in case of huge volume of result.

        Parameters:
        searchPattern -
        Returns: