com.ibm.pdp.maf.rpp.service

Class MAFModelService

  • java.lang.Object
    • com.ibm.pdp.maf.rpp.service.MAFModelService
    • Method Detail

      • closeLocation

        public boolean closeLocation(java.lang.String locationName)
        Description copied from interface: IMAFModelService

        Closes the location. If success returns true.

        Specified by:
        closeLocation in interface IMAFModelService
        Returns:
      • getAbstractBlockBase

        public AbstractBlockBase getAbstractBlockBase(java.lang.String projectName,
                                             java.lang.String packageName,
                                             java.lang.String entityName)
        Description copied from interface: IMAFModelService

        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

        Specified by:
        getAbstractBlockBase in interface IMAFModelService
        Returns:
      • getAbstractSegment

        public AbstractSegment getAbstractSegment(java.lang.String projectName,
                                         java.lang.String packageName,
                                         java.lang.String entityName)
        Description copied from interface: IMAFModelService

        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

        Specified by:
        getAbstractSegment in interface IMAFModelService
        Returns:
      • getCodasylBlockBase

        public CodasylBlockBase getCodasylBlockBase(java.lang.String projectName,
                                           java.lang.String packageName,
                                           java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getCodasylBlockBase in interface IMAFModelService
        Returns:
      • getCopybook

        public Copybook getCopybook(java.lang.String projectName,
                           java.lang.String packageName,
                           java.lang.String entityName)
        Description copied from interface: IMAFModelService
        Specified by:
        getCopybook in interface IMAFModelService
        Returns:
      • getDataElement

        public DataElement getDataElement(java.lang.String projectName,
                                 java.lang.String packageName,
                                 java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getDataElement in interface IMAFModelService
        Returns:
      • getDataStructure

        public DataStructure getDataStructure(java.lang.String projectName,
                                     java.lang.String packageName,
                                     java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getDataStructure in interface IMAFModelService
        Returns:
      • getDialog

        public Dialog getDialog(java.lang.String projectName,
                       java.lang.String packageName,
                       java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getDialog in interface IMAFModelService
        Returns:
      • getDialogServer

        public DialogServer getDialogServer(java.lang.String projectName,
                                   java.lang.String packageName,
                                   java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getDialogServer in interface IMAFModelService
        Returns:
      • getHierarchicalBlockBase

        public HierarchicalBlockBase getHierarchicalBlockBase(java.lang.String projectName,
                                                     java.lang.String packageName,
                                                     java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getHierarchicalBlockBase in interface IMAFModelService
        Returns:
      • getInputAid

        public InputAid getInputAid(java.lang.String projectName,
                           java.lang.String packageName,
                           java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getInputAid in interface IMAFModelService
        Returns:
      • getLibrary

        public Library getLibrary(java.lang.String projectName,
                         java.lang.String packageName,
                         java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getLibrary in interface IMAFModelService
        Returns:
      • getLogicalView

        public LogicalView getLogicalView(java.lang.String projectName,
                                 java.lang.String packageName,
                                 java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getLogicalView in interface IMAFModelService
        Returns:
      • getMacro

        public Macro getMacro(java.lang.String projectName,
                     java.lang.String packageName,
                     java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getMacro in interface IMAFModelService
        Returns:
      • getMetaDataAggregate

        public MetaDataAggregate getMetaDataAggregate(java.lang.String projectName,
                                             java.lang.String packageName,
                                             java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getMetaDataAggregate in interface IMAFModelService
        Returns:
      • getMetaEntity

        public MetaEntity getMetaEntity(java.lang.String projectName,
                               java.lang.String packageName,
                               java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getMetaEntity in interface IMAFModelService
        Returns:
      • getMetaEntityType

        public MetaEntityType getMetaEntityType(java.lang.String projectName,
                                       java.lang.String packageName,
                                       java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getMetaEntityType in interface IMAFModelService
        Returns:
      • getMonoStructureSegment

        public MonoStructureSegment getMonoStructureSegment(java.lang.String projectName,
                                                   java.lang.String packageName,
                                                   java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getMonoStructureSegment in interface IMAFModelService
        Returns:
      • getProgram

        public Program getProgram(java.lang.String projectName,
                         java.lang.String packageName,
                         java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getProgram in interface IMAFModelService
        Returns:
      • getRadicalElement

        public RadicalElement getRadicalElement(java.lang.String projectName,
                                       java.lang.String packageName,
                                       java.lang.String entityName,
                                       java.lang.String entityType)
        Description copied from interface: IMAFModelService

        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.

        Specified by:
        getRadicalElement in interface IMAFModelService
        Returns:
      • getRadicalElement

        public RadicalElement getRadicalElement(java.lang.String projectName,
                                       java.lang.String packageName,
                                       java.lang.String metaEntityName,
                                       java.lang.String entityName,
                                       java.lang.String entityType)
        Description copied from interface: IMAFModelService

        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.

        Specified by:
        getRadicalElement in interface IMAFModelService
        Returns:
      • getRelationalBlockBase

        public RelationalBlockBase getRelationalBlockBase(java.lang.String projectName,
                                                 java.lang.String packageName,
                                                 java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getRelationalBlockBase in interface IMAFModelService
        Returns:
      • getReport

        public Report getReport(java.lang.String projectName,
                       java.lang.String packageName,
                       java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getReport in interface IMAFModelService
        Returns:
      • getScreen

        public Screen getScreen(java.lang.String projectName,
                       java.lang.String packageName,
                       java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getScreen in interface IMAFModelService
        Returns:
      • getServer

        public Server getServer(java.lang.String projectName,
                       java.lang.String packageName,
                       java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getServer in interface IMAFModelService
        Returns:
      • getSocrateBlockBase

        public SocrateBlockBase getSocrateBlockBase(java.lang.String projectName,
                                           java.lang.String packageName,
                                           java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getSocrateBlockBase in interface IMAFModelService
        Returns:
      • getStandardSegment

        public StandardSegment getStandardSegment(java.lang.String projectName,
                                         java.lang.String packageName,
                                         java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getStandardSegment in interface IMAFModelService
        Returns:
      • getTable

        public Table getTable(java.lang.String projectName,
                     java.lang.String packageName,
                     java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getTable in interface IMAFModelService
        Returns:
      • getText

        public Text getText(java.lang.String projectName,
                   java.lang.String packageName,
                   java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getText in interface IMAFModelService
        Returns:
      • getUserEntity

        public UserEntity getUserEntity(java.lang.String projectName,
                               java.lang.String packageName,
                               java.lang.String metaEntityType,
                               java.lang.String entityName)
        Description copied from interface: IMAFModelService

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

        Specified by:
        getUserEntity in interface IMAFModelService
        Returns:
      • getVolume

        public Volume getVolume(java.lang.String projectName,
                       java.lang.String packageName,
                       java.lang.String entityName)
        Description copied from interface: IMAFModelService
        Specified by:
        getVolume in interface IMAFModelService
        Returns:
      • isLocationOpen

        public boolean isLocationOpen(java.lang.String locationName)
        Description copied from interface: IMAFModelService

        Returns true if the location is open.

        Specified by:
        isLocationOpen in interface IMAFModelService
        Returns:
      • openLocation

        public boolean openLocation(java.lang.String locationName)
        Description copied from interface: IMAFModelService

        Opens the location. If success returns true.

        Specified by:
        openLocation in interface IMAFModelService
        Returns:
      • references

        public java.util.List<RadicalElement> references(RadicalElement radicalElement,
                                                boolean subReferences)
        Description copied from interface: IMAFModelService

        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.

        Specified by:
        references in interface IMAFModelService
        Returns:
      • referencesIds

        public java.util.List<java.lang.String> referencesIds(RadicalElement radicalElement,
                                                     boolean subReferences)
        Description copied from interface: IMAFModelService

        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.

        Specified by:
        referencesIds in interface IMAFModelService
        Returns:
      • searchIds

        public java.util.List<java.lang.String> searchIds(IMAFSearchPattern searchPattern)
        Description copied from interface: IMAFModelService

        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.

        Specified by:
        searchIds in interface IMAFModelService
        Returns: