com.semarchy.mdm.runtime.model.logical
Interface IModel

All Superinterfaces:
IUniquelyNamed, Serializable

public interface IModel
extends IUniquelyNamed, Serializable

Represents the Logical Model used by Convergence for MDM.

This model reflects what was designed in the workbench.

Author:
skamel

Field Summary
static String MODEL_PREFIX
           
 
Fields inherited from interface com.semarchy.mdm.runtime.model.logical.IUniquelyNamed
SEP
 
Method Summary
 IApplication getApplication(String pApplicationName)
          Return the IApplication for the given name if exists
 List<IApplication> getApplications()
          Return the list of IApplication for this model (sorted by application name)
 List<IEntity> getBaseEntities()
          Returns the list of base entities in this model ordered by IEntity.getName()
 ITranslationBundle getBaseTranslationBundle()
           
 IBusinessObject getBusinessObject(String pBOName)
          Return the Business Object gor the given name or throws NoSuchBusinessObjectException if there is no BO with such name.
 List<IBusinessObject> getBusinessObjects()
          Return the list of IBusinessObject for this model ordered by BO names
 IComplexType getComplexType(String pTypeName)
           
 List<IComplexType> getComplexTypes()
           
 List<IEntity> getEntities()
          Returns the list of entities managed in this model ordered by IEntity.getName()
 IEntity getEntity(String pEntityName)
          Returns the IEntity with the given name if it exists or throws NoSuchEntityException.
 IModelLabelProvider getLabelProvider()
          Obtain the label provider for IModel objects.
 ILov getLov(String pName)
          Returns the ILov with the given name or throws a NoSuchLovException
 List<ILov> getLovs()
          Returns the list of ILov defined in this model ordered by ILov.getName()
 List<IModelDiagram> getModelDiagrams()
          Return the list of model diagrams ordered by IModelDiagram.getName()
 IModelID getModelID()
           
 IModelJob getModelJob(String pName)
           
 List<IModelJob> getModelJobs()
           
 List<IModelPrivGrant> getModelPrivGrants()
           
 String getName()
           
 List<ITranslationBundle> getNotBaseTranslationBundles()
           
 IPublisher getPublisher(String pCode)
          Returns the IPublisher with the given code if it exists or throws a NoSuchPublisherException
 List<IPublisher> getPublishers()
          Returns the list of IPublisher managed by this model ordered by IPublisher.getCode()Code
 IReference getReference(String pReferenceName)
          Returns the IReference with the given name if it exists or throws a NoSuchReferenceException
 List<IReference> getReferences()
          Returns the list of references managed in this model ordered by IReference.getName().
 IRetentionPolicy getRetentionPolicy()
           
 List<IModelVariable> getVariables()
           
 void setNotBaseTranslationBundles(List<ITranslationBundle> pTranslationBundlesToUse)
          Change the list of not base ITranslationBundle and update the getLabelProvider() to use them.
 
Methods inherited from interface com.semarchy.mdm.runtime.model.logical.IUniquelyNamed
getPrefixedUniqueName, getUniqueName
 

Field Detail

MODEL_PREFIX

static final String MODEL_PREFIX
See Also:
Constant Field Values
Method Detail

getModelID

IModelID getModelID()
Returns:
the unique ID of this model version

getName

String getName()
Returns:
the name of this model

getBaseEntities

List<IEntity> getBaseEntities()
Returns the list of base entities in this model ordered by IEntity.getName()


getEntities

List<IEntity> getEntities()
Returns the list of entities managed in this model ordered by IEntity.getName()

Returns:

getEntity

IEntity getEntity(String pEntityName)
                  throws NoSuchEntityException
Returns the IEntity with the given name if it exists or throws NoSuchEntityException.

Parameters:
pEntityName -
Returns:
a managed entity by name
Throws:
NoSuchEntityException - if name doesn't match any of known entities

getReferences

List<IReference> getReferences()
Returns the list of references managed in this model ordered by IReference.getName().

Returns:

getReference

IReference getReference(String pReferenceName)
                        throws NoSuchReferenceException
Returns the IReference with the given name if it exists or throws a NoSuchReferenceException

Parameters:
pReferenceName -
Returns:
a managed reference by name
Throws:
NoSuchReferenceException - if reference is not found

getPublishers

List<IPublisher> getPublishers()
Returns the list of IPublisher managed by this model ordered by IPublisher.getCode()Code

Returns:

getPublisher

IPublisher getPublisher(String pCode)
                        throws NoSuchPublisherException
Returns the IPublisher with the given code if it exists or throws a NoSuchPublisherException

Parameters:
pCode -
Returns:
a managed publisher code
Throws:
NoSuchPublisherException - if publisher is not found

getLovs

List<ILov> getLovs()
Returns the list of ILov defined in this model ordered by ILov.getName()

Returns:

getLov

ILov getLov(String pName)
            throws NoSuchLovException
Returns the ILov with the given name or throws a NoSuchLovException

Parameters:
pName -
Returns:
Throws:
NoSuchLovException

getLabelProvider

IModelLabelProvider getLabelProvider()
Obtain the label provider for IModel objects.

Returns:

getModelJobs

List<IModelJob> getModelJobs()
Returns:
a non-ordered list of model jobs

getModelJob

IModelJob getModelJob(String pName)
                      throws NoSuchModelJobException
Parameters:
pName -
Returns:
a model job given its unique name
Throws:
NoSuchModelJobException - if not found

getModelPrivGrants

List<IModelPrivGrant> getModelPrivGrants()
Returns:
the list of IModelPrivGrant defined for this model.

getComplexTypes

List<IComplexType> getComplexTypes()
Returns:
the list of IComplexType defined for this model.

getComplexType

IComplexType getComplexType(String pTypeName)
                            throws NoSuchComplexTypeException
Returns:
the IComplexType for the given name.
Throws:
NoSuchComplexTypeException

getBusinessObjects

List<IBusinessObject> getBusinessObjects()
Return the list of IBusinessObject for this model ordered by BO names

Returns:

getBusinessObject

IBusinessObject getBusinessObject(String pBOName)
                                  throws NoSuchBusinessObjectException
Return the Business Object gor the given name or throws NoSuchBusinessObjectException if there is no BO with such name.

Parameters:
pBOName -
Returns:
Throws:
NoSuchBusinessObjectException

getApplications

List<IApplication> getApplications()
Return the list of IApplication for this model (sorted by application name)

Returns:

getApplication

IApplication getApplication(String pApplicationName)
                            throws NoSuchApplicationException
Return the IApplication for the given name if exists

Parameters:
pApplicationName -
Returns:
Throws:
NoSuchApplicationException - if there is no application with such name

getBaseTranslationBundle

ITranslationBundle getBaseTranslationBundle()

getNotBaseTranslationBundles

List<ITranslationBundle> getNotBaseTranslationBundles()

getVariables

List<IModelVariable> getVariables()

setNotBaseTranslationBundles

void setNotBaseTranslationBundles(List<ITranslationBundle> pTranslationBundlesToUse)
Change the list of not base ITranslationBundle and update the getLabelProvider() to use them. This method should not be used by clients.

Parameters:
pTranslationBundlesToUse -

getModelDiagrams

List<IModelDiagram> getModelDiagrams()
Return the list of model diagrams ordered by IModelDiagram.getName()

Returns:

getRetentionPolicy

IRetentionPolicy getRetentionPolicy()


Copyright © 2015. All Rights Reserved.