Clase Repositorio [Guía de Usuario de Enterprise Architect]

Top Previous Next

Clase Repositorio

button_main button_prev button_next

El Repositorio es el contenedor principal de todas las estructuras tal como modelos, paquetes y elementos. Puede comenzar a acceder iterativamente al modelo utilizando la colección de Modelos. También tiene algunos métodos convenientes para acceder directamente a las estructuras sin tener que localizarlos primero en la jerarquía.

Tabla asociada en archivo .EAP <none>

Atributos del Repositorio

Atributo

Tipo

Notas

Ver También

Autores

Colección

Sólo lectura

Esta es la colección de Autores del sistema. Este contiene 0 o más objetos de Autor, cada uno de los cuales puede ser asociado con, por ejemplo, elementos o diagramas como el ítem autor o propietario.

Utilizar AddNew, Delete () () y GetAt () para administrar Autores.

 

 

BatchAppend

Boolean

Lectura/Escritura

Establezca esta propiedad como verdadera cuando su cliente de automatización tiene que insertar rápidamente muchos elementos, atributos, operaciones y/o parámetros de operación.

Se establece como falso cuando el trabajo está completo.

Esto puede resultar en 10 a 20 veces la mejora al agregar nuevos elementos agrupados.

 

 

Clientes

Colección

Sólo lectura

Una lista de Clientes asociados con el proyecto. Puede modificar, eliminar y agregar nuevos objetos de Cliente utilizando esta colección.

 

 

ConnectionString

String

Sólo lectura

La cadena de nombre da archivo/conexión del Repositorio actual.

Para una cadena de conexión, el tipo de repositorio DBMS es identificado por "DBType=n", donde n es un número que corresponde al tipo de DBMS, como los siguientes:

0 - MYSQL

1 - SQLSVR

2 - ADOJET

3 - ORACLE

4 - POSTGRES

5 - ASA

7 - OPENEDGE

8 - ACCESS2007

 

 

Tipos de Datos

Colección

Sólo lectura

La colección de Tipos de Datos. Este contiene una lista de objetos de Tipo de Datos, cada uno de los cuales representa una definición de tipo de dato con el propósito del modelado de datos o de la generación de código.

 

 

EAEdition

EAEditionTypes

Sólo lectura

Devuelve el nivel actual de la funcionalidad núcleo con licencia disponible.

Esta propiedad devuelve Corporativo cuando la edición es de Ingeniería de Negocios y Software,Ingeniería de Sistemas o Ultimate.

Utilice EAEditionEx para identificar cuál de estas ediciones extendidas está disponible.

 

 

EAEditionEx

EAEditionTypes

Sólo lectura

Devuelve el nivel actual de la funcionalidad con licencia extendida disponible.

 

 

EnableCache

Boolean

Lectura/Escritura

Una optimización para pre-cargar los objetos del paquete cuando se trata de grandes conjuntos de objetos de automatización.

 

 

EnableUIUpdates

Boolean

Lectura/Escritura

Establezca esta propiedad como falsa para mejorar el rendimiento de los cambios en el modelo; por ejemplo, una adición agrupada de elementos a un paquete. Para revelar cambios al usuario, llame a Repository.RefreshModelView ().

 

 

FlagUpdate

Boolean

Lectura/Escritura

Encarga que Enterprise Architect actualice el Repositorio con el valor LastUpdate.

 

 

InstanceGUID

String

Sólo lectura

La cadena identificadora, identifica la sesión de tiempo de ejecución de Enterprise Architect.

 

 

IsSecurityEnabled

Boolean

Sólo lectura

Comprueba si la Seguridad de Usuario está habilitada para el repositorio actual.

 

 

Problemas

Colección

Sólo lectura

La lista de Problemas del Sistema. Contiene objetos de ProjectIssues, cada uno detallando un problema en particular y como se relaciona con un proyecto como un todo.

 

 

LastUpdate

String

Sólo lectura

La cadena de identificador identifica la sesión de tiempo de ejecución de Enterprise Architect y el sello de tiempo para cuando se configuró.

 

 

LibraryVersion

Long

Sólo lectura

El número de construcción del tiempo de ejecución de Enterprise Architect.

 

 

Modelos

Colección de tipo Paquete

Sólo lectura

Los modelos son de tipo paquete y pertenecen a una colección de paquetes. Este es el punto de entrada de nivel superior a un archivo de proyecto de Enterprise Architect. Cada modelo es un nodo raíz en el Explorador de Proyectos y puede contener ítems como Vistas y paquetes.

Un modelo es una forma especial de un paquete; tiene un ParentID de 0. Al iterar a través de todos los modelos, puede acceder a todos los elementos dentro de la jerarquía del proyecto.

También puede utilizar la función AddNew () para crear un nuevo modelo. Un modelo puede ser eliminado, pero recuerde que todo el contenido del modelo se elimina también.

 

 

ObjectType

ObjectType

Sólo lectura

Distingue objetos referidos a través de la interfaz de Envío.

 

 

ProjectGUID

String

Sólo lectura

Devuelve un ID único para el proyecto.

 

 

ProjectRoles

Colección

Sólo lectura

La colección de Roles del sistema. Contiene 0 o más objetos de Rol, cada uno de los cuales puede ser asociado con, por ejemplo, elementos o diagramas como el ítem autor o propietario.

Utilizar AddNew, Delete () () y GetAt () para administrar Roles.

 

 

PropertyTypes

Colección

Sólo lectura

Colección de Tipos de Propiedades disponibles en el Repositorio.

 

Clase de Tipo de Propiedad

Recursos

Colección

Sólo lectura

Contiene objetos de ProjectResource disponibles para asignar a los ítems de trabajo dentro del proyecto.

Utilice las funciones agregar nuevo, modificar y eliminar para administrar recursos.

 

 

Estereotipos

Colección

Sólo lectura

La colección de Estereotipos. Una lista de objetos de Estereotipo que contiene información sobre un estereotipo y a qué elementos puede aplicarse.

 

Clase Estereotipo

SuppressEADialogs

Boolean

Lectura/Escritura

Configure esta propiedad en el evento de transmisión EA_OnPostNewElement para controlar si Enterprise Architect debería reprimirse a mostrar la ventana de Propiedades por defecto al usuario cuando se crea un elemento.

 

EA_OnPostNewElement

EA_OnPostNewConnector

SuppressSecurityDialog

Boolean

Lectura/Escritura

Suprime la ventana de solicitud de iniciar sesión que aparece predeterminadamente cuando los parámetros de nombre de usuario y contraseña pasados a OpenFile2 son inválidos. Para el uso de clientes de automatización externa únicamente.

 

 

Tareas

Colección

Sólo lectura

Una lista de tareas del sistema (lista de tareas). Cada entrada es un Ítem de Tarea; puede modificar, eliminar y agregar nuevas tareas.

 

Clase Tarea

Términos

Colección

Sólo lectura

El Glosario del proyecto. Cada objeto de Término es una entrada en el Glosario. Agregar, modificar y eliminar Términos para mantener el Glosario.

 

Clase de Término

Métodos del Repositorio

Método

Tipo

Notas

Ver También

ActivateDiagram (

long DiagramID)

 

Activa un diagrama ya abierto (es decir, lo hace la pestaña activa) en la interfaz de usuario principal de Enterprise Architect.

Parámetros:

DiagramID: Long - el ID del diagrama para activar

 

 

ActivatePerspective (

string long)

 

Boolean

Obsoleto - ya no está en uso.

 

ActivateTab (

string Name)

 

Activa una vista tabulada abierta de Enterprise Architect.

Parámetros:

Nombre: String - el nombre de la vista para activar

 

 

ActivateTechnology (

string TechnologyID)

 

Activa una Tecnología MDG permitida.

Parámetros:

TechnologyID: String - el ID de la tecnología para activar, tal como se asignó en el Asistente de Tecnología MDG

 

Crear un Archivo de Tecnología MDG

ActivateToolbox (

string Toolbox,

long Options)

Boolean

Activa una página de la Caja de Herramientas en la GUI.

El valor devuelto está reservado para uso futuro.

Parámetros:

Caja de Herramientas: String - el nombre de la página de la Caja de Herramientas para activar

Opciones: Long - reservado para uso futuro

 

 

AddDefinedSearches (

string sXML)

 

Le permite ingresar un conjunto de búsquedas definidas que duran en Enterprise Architect para la vida de la aplicación; cuando Enterprise Architect se carga de nuevo, deben insertarse de nuevo mediante su Add-In.

Parámetros:

sXML: String - el XML de las búsquedas definidas; puede obtener este XML al realizar una exportación de las búsquedas desde la ventana Administrar Búsquedas en Enterprise Architect

 

Crear y Administrar Búsquedas

AddDocumentationPath(

string Name,

string Path,

long Type)

 

 

Proporciona un Add-In con habilidad de insertar la ruta de libro en el directorio de instalación de Enterprise Architect, para mostrar las páginas del Centro de Aprendizaje sobre temas creados por el usuario (tal como el uso del Add-In).

Parámetros:

Nombre: String - el nombre de nivel superior (raíz) de la jerarquía de la documentación del Centro de Aprendizaje para el Add-In (por ejemplo, Enterprise Architect)

Ruta: String - la ruta de directorio de la carpeta que contiene la estructura de documentación del Centro de Aprendizaje (por ejemplo,

C:\Program Files (86)\Sparx Systems\EA\Books

Tipo: Long - reservado para uso futuro; establecido como 0

 

 

Centro de Aprendizaje

 

 

 

Crear Páginas del Centro de Aprendizaje

AddPerspective (

string Perspective,

long Options)

 

Boolean

Obsoleto - ya no está en uso.

 

AddTab (

string TabName,

string ControlID)

Control personalizado de activeX

Agrega un control personalizado de ActiveX como una ventana con pestañas. Enterprise Architect crea un control y, si tiene éxito, devuelve su puntero Desconocido, el cual puede ser utilizado por la persona que llama para manipular el control.

Parámetros:

TabName: String - utilizada como el título de la pestaña

ControlID: String - el ProgID del control; por ejemplo, "CS_AddinFramework.UserControl1"

 

Crear una Vista Personalizada

 

AddWindow (

string WindowName,

string ControlID)

Control personalizado de activeX

Agrega un control personalizado de ActiveX como una ventana a la ventana acoplada de Add-Ins. Enterprise Architect crea un control y, si tiene éxito, devuelve su puntero Desconocido, el cual puede ser utilizado por la persona que llama para manipular el control.

Parámetros:

WindowName: String - utilizada como el título de la ventana

ControlID: String - el ProgID del control; por ejemplo, "CS_AddinFramework.UserControl1"

 

Ventana Acoplada Personalizada

RemoveWindow

 

AdviseConnectorChange (

long ConnectorID)

 

Proporciona un Add-In o cliente de automatización con capacidad para aconsejar a la interfaz de usuario de Enterprise Architect de que un conector determinado ha cambiado, y si es visible en cualquier diagrama abierto, para volver a cargar y actualizar dicho conector para el usuario.

Parámetros:

ConnectorID: Long - el ID del conector

 

 

AdviseElementChange (

long ObjectID)

 

Proporciona un Add-In o cliente de automatización con capacidad para aconsejar a la interfaz de usuario de Enterprise Architect de que un elemento determinado ha cambiado, y si es visible en cualquier diagrama abierto, para volver a cargar y actualizar dicho elemento para el usuario.

Parámetros:

ObjectID: Long - el ID del elemento

 

 

ChangeLoginUser (

string Name,

string Password)

Boolean

Configura el usuario conectado actualmente para ser aquel especificado por un nombre y una contraseña; esto inicia la sesión del usuario en el repositorio cuando la seguridad está activada.

Si la seguridad no está activada se lanza una excepción (Seguridad No Activada).

Parámetros:

Nombre: String - el nombre del usuario

Contraseña: String - la contraseña del usuario

 

 

ClearAuditLogs (

Object StartDateTime,

Object EndDateTime)

Boolean

Borre todos los Registros de Auditoría del modelo.

Si StartDateTime y EndDateTime no son nulos, entonces, sólo los ítems de registro que entran en este período se borran.

Devuelve verdadero en caso de éxito, falso en caso de fallo.

Este método no se puede deshacer. Es aconsejable que llame primero a SaveAuditLogs para hacer una copia de seguridad de los registros

Este método puede fallar si el usuario que ha iniciado sesión en el modelo no tiene el permiso de acceso correcto

 

Parámetros:

StartDateTime: Variante ( DateTime ) - la primera fecha y hora de entradas de registro para borrar

EndDateTime; Variante ( DateTime ) - la última fecha y hora de entradas de registro para borrar

 

 

ClearOutput (

string Name)

 

Elimina todo el texto de una pestaña en la ventana de Salida.

Parámetros:

Nombre: String - el nombre de la pestaña de la cual eliminar texto

 

CreateOutputTab

EnsureOutput Visible

WriteOutput

CloseAddins ()

 

Llamado por los controladores de automatización para garantizar que los Add-Ins creados en .NET no persistan después de que se hayan borrado todas las referencias a Enterprise Architect del controlador.

 

 

CloseDiagram (

long DiagramID)

 

Cierra un diagrama en la lista actual de diagramas que Enterprise Architect tiene abierta.

Parámetros:

DiagramID: Long - el ID del diagrama a cerrar

 

 

CloseFile ()

 

Cierra cualquier archivo abierto.

 

 

CreateDocumentGenerator()

Generador de Documento

 

Devuelve un puntero a la interfaz EA.DocumentGenerator.

 

CreateModel (

CreateModelType CreateType,

string FilePath,

long ParentWnd)

Boolean

Crea un nuevo archivo modelo .eap basado en el modelo Base estándar de Enterprise Architect, o un acceso directo .eap basado en una conexión SQL proporcionada.

Devuelve verdadero cuando se crea el nuevo archivo, de lo contrario devuelve falso.

Parámetros:

CreateType: CreateModelType - Especificar si va a realizar una nueva copia del modelo EABase.eap, o si va a crear un acceso directo al archivo .eap a un repositorio DBMS; esta última opción requiere que esté abierta una ventana para que el usuario proporcione detalles de la conexión SQL

FilePath: String - Destino para el nuevo archivo .eap

ParentWnd: Long - controlador de Windows para actuar como el padre de la ven} de conexión SQL; sólo se requiere cuando se utiliza cmEAPFromSQLRepository

 

Crear Tipo de Modelo

CreateOutputTab (

string Name)

 

Crea una pestaña en la ventana de Salida.

Parámetros:

Nombre: String - el nombre de la pestaña para crear

 

CreateOutputTab

EnsureOutput Visible

WriteOutput

 

DeletePerspective (

string Perspective,

long Options)

 

Boolean

Obsoleto - ya no está en uso.

 

DeleteTechnology (

string ID)

Boolean

Elimina un recurso de Tecnología MDG del repositorio.

Devuelve verdadero, si la tecnología es eliminada exitosamente del modelo. De lo contrario, devuelve falso.

Esto se aplica a las tecnologías importadas en las versiones previas a 7.0 de Enterprise Architect (tecnologías importadas), no tecnologías referidas en la versión 7.0 y posteriores (tecnologías de referencia)

 

Parámetros:

ID: String - el ID de la tecnología.

 

Desplegar una Tecnología MDG

EnsureOutputVisible (

string Name)

 

Asegura que una pestaña especificada en la ventana de Salida está visible para el usuario. La ventana de Salida se hace visible si está oculto.

Parámetros:

Nombre: String - el nombre de la pestaña para hacer visible

 

CreateOutputTab

EnsureOutput Visible

WriteOutput

ExecutePackageBuildScript (

long ScriptOptions,

string PackageGuid)

 

Le permite ejecutar el script de compilación del paquete activo basado en la selección actual en el Explorador de Proyectos. También puede ejecutar un script pasando el GUID del paquete.

Parámetros:

ScriptOptions: Long - el tipo de script; puede ser cualquiera de los siguientes valores numéricos:

1 = Build

2 = Test

3 = Run

4 = Create Workbench Instance

5 = Debug

 

PackageGuid: String - El ID del paquete para el cual ejecutar el script

 

 

Salida

 

Apaga inmediatamente a Enterprise Architect. Utilizado por programadores .NET cuando el recolector de elementos no utilizados no libera inmediatamente todos los objetos referidos COM.

 

 

GetActivePerspective ()

String

Obsoleto - ya no está en uso.

 

 

GetAttributeByGuid (

string Guid)

Atributo

Devuelve un puntero a un atributo en el repositorio, ubicado por su GUID. Esto generalmente se encuentra utilizando la propiedad AttributeGUID de un atributo.

Parámetros:

Guid: String - el GUID del atributo para ubicar

 

 

GetAttributeByID (

string Id)

Atributo

Devuelve un puntero a un atributo en el repositorio, ubicado por su ID. Esta se encuentra generalmente utilizando la propiedad AttributeID de un atributo.

Parámetros:

Id: String - el ID del atributo para ubicar

 

 

GetConnectorByGuid (

string Guid)

Conector

Devuelve un puntero a un conector en el repositorio, ubicado por su GUID. Esta se encuentra generalmente utilizando la propiedad ConnectorGUID de un conector.

Parámetros:

Guid: String - el GUID del conector para ubicar

 

 

GetConnectorByID (

long ConnectorID)

Conector

Busca en el repositorio, un conector con un ID específico.

Parámetros:

ConnectorID: Long - el ID del conector a ubicar

 

 

GetContextItem (

object Item)

ObjectType

Establece un puntero a un ítem en contexto dentro de Enterprise Architect.

También devuelve el ObjectType correspondiente.

Para obtener información adicional acerca de ContextItems y los ObjectTypes soportados, vea el método GetContextItemType (abajo).

Parámetros:

Ítem: Objeto - el ítem al cual apuntar

 

 

GetContextItemType ()

ObjectType

Devuelve el ObjectType de un ítem de contexto dentro de Enterprise Architect. Un ContextItem es definido como un ítem seleccionado en cualquier lugar dentro de la GUI de Enterprise Architect, incluyendo:

Un ítem seleccionado en el Explorador de Proyectos

Un ítem seleccionado en un diagrama abierto

Un ítem seleccionado en ciertas ventanas, tal como la ventana de Propiedades del atributo

 

Los ObjectTypes soportados pueden ser cualquiera de los siguientes valores:

otElement

otPackage

otDiagram

otAttribute

otMethod

otConnector

 

 

GetContextObject ()

Objeto

Devuelve el Objeto de contexto actual.

 

 

GetCounts ()

String

Devuelve un conjunto de recuentos de un número de tablas dentro del repositorio base de Enterprise Architect. Estos pueden ser utilizados para determinar si los registros se han agregado o eliminado de las tablas para las cuales se recuperará información.

 

 

GetCurrentDiagram ()

Diagrama

Devuelve un diagrama seleccionado.

 

 

GetCurrentLoginUser (

boolean GetGuid)

String

Si la seguridad no está activada en el repositorio, se genera un error.

Si GetGuid es Verdadero, se devuelve un GUID generado por Enterprise Architect que representa al usuario; de lo contrario, el texto tal y como se introduce en Detalles/Inicio de Sesión Usuarios/Usuario del Sistema es devuelto.

 

 

GetDiagramByGuid (

string Guid)

Diagrama

Devuelve un puntero a un diagrama utilizando el ID de referencia global (ID global). Esta función se encuentra generalmente utilizando la propiedad de GUID del diagrama de un elemento, y se almacena para su uso posterior para abrir un diagrama sin utilizar la función de colección GetAt().

Parámetros:

Guid: String - el GUID del diagrama para ubicar

 

 

GetDiagramByID (

long DiagramID)

Diagrama

Obtiene un puntero a un diagrama utilizando un número de referencia absoluta (ID local). Esta función se encuentra generalmente utilizando la propiedad de DiagramID de un elemento, y se almacena para su uso posterior para abrir un diagrama sin utilizar la función de colección GetAt().

Parámetros:

DiagramID: Long - el ID del diagrama para ubicar

 

 

GetElementByGuid (

string Guid)

Elemento

Devuelve un puntero a un elemento en el repositorio, utilizando el número de referencia de GUID del elemento (ID global). Esta función se encuentra generalmente utilizando la propiedad de ElementGUID de un elemento, y se almacena para su uso posterior para abrir un elemento sin utilizar la función de colección GetAt().

Parámetros:

Guid: String - el GUID del elemento para ubicar

 

 

GetElementByID (

long ElementID)

Elemento

Obtiene un puntero a un elemento utilizando un número de referencia absoluta (ID local). Esta función se encuentra generalmente utilizando la propiedad de ElementID de un elemento, y se almacena para su uso posterior para abrir un elemento sin utilizar la función de colección GetAt().

Parámetros:

ElementID: Long - el ID del elemento para ubicar

 

 

GetElementsByQuery (

string QueryName,

string SearchTerm)

Colección (de tipo de Elemento)

Permite al usuario ejecutar una búsqueda en Enterprise Architect, devolviendo el resultado como una colección.

Por ejemplo GetElementsByQuery('Simple','Class1'), donde los resultados contienen elementos Class1 en los campos Nombre y Notas.

Parámetros:

QueryName: String - el nombre de la búsqueda a ejecutar, por ejemplo 'Simple'

SearchTerm: String - el término a buscar

 

 

GetElementSet (

string IDList,

long Options)

Colección

(de tipo de Elemento)

Devuelve un conjunto de elementos como una colección basada en una lista separada por comas de valores ElementID. Por defecto, si no hay valores proporcionados en la lista de parámetros IDList, todos los objetos de todo el proyecto son devueltos.

Parameters

IDList: String - una lista separada por comas de valores de ElementID

Opciones: Long - modifica el comportamiento predeterminado de este método

1 - Devuelve una colección vacía cuando se da la lista de parámetros IDList vacía

2 - Utilizar la cadena de IDList como una consulta SQL para rellenar esta colección

 

 

GetFieldFromFormat (

string Format,

string Text)

String

Convierte un campo desde su formato preferido al formato interno de Enterprise Architect; devuelve el campo en ese formato.

Parámetros:

Formato: String - El formato para convertir el campo desde; los formatos válidos son:

HTML - HTML Completo

RTF - Formato de Texto Enriquecido

TXT - Texto Normal

 

Texto: String - El campo para ser convertido

 

 

GetFormatFromField (

string Format,

string Text)

String

Después de acceder a un campo que contiene el formato, utilice este método para convertirlo a su formato preferido; devuelve el campo en el formato especificado.

Parámetros:

Formato: String - El formato para convertir el campo a; los formatos válidos son:

HTML - HTML Completo

RTF - Formato de Texto Enriquecido

TXT - Texto Normal

 

Texto: String - El campo para ser convertido

 

 

GetGapAnalysisMatrix ()

String

Sólo lectura.

Devuelve todos los Análisis de Brechas como un documento XML.

 

Matriz de Análisis de Brecha

GetLastError ()

String

Devuelve un valor de string describiendo el error más reciente que ocurrió en relación con este objeto.

 

 

GetMailInterface()

MailInterface

Devuelve una instancia de EA.MailIinterface; utilice esta interfaz para automatizar el proceso de creación y envío de mensajes de correo modelo.

 

Paquete de MailInterface

GetMethodByGuid (

string Guid)

Método

Devuelve un puntero a un método en el repositorio; este generalmente se encuentra utilizando la propiedad MethodGUID de un método.

Parámetros:

Guid: String - el GUID del método para buscar

 

 

GetMethodById (

string Id)

Método

Devuelve un puntero a un método en el repositorio; este generalmente se encuentra utilizando la propiedad MethodID de un método.

Parámetros:

Id: String - el ID del método para buscar

 

 

GetPackageByGuid (

string Guid)

Paquete

Devuelve un puntero a un paquete en el repositorio utilizando el número de referencia de GUID del paquete (ID global). Esto se encuentra generalmente utilizando la propiedad PackageGUID del paquete.

Cada paquete en el modelo también tiene un elemento asociado con el mismo GUID, por lo que si tiene un elemento con Type="package" entonces puede cargar el paquete llamando a:

GetPackageByGuid(Element.ElementGUID)

Parámetros:

Guid: String - el GUID del paquete para buscar

 

 

GetPackageByID (

long PackageID)

Paquete

Obtener un puntero de un paquete utilizando un número de referencia absoluta (ID local). Esta función se encuentra generalmente utilizando la propiedad de PackageID de un paquete, y se almacena para su uso posterior para abrir un paquete sin utilizar la función de colección GetAt () .

Parámetros:

PackageID: Long - el ID del paquete para ubicar

 

 

GetProjectInterface ()

Proyecto

Devolver un puntero a la interfaz del Proyecto EA (el servidor de automatización basado en XML para Enterprise Architect). Utilice esta interfaz para trabajar con Enterprise Architect utilizando XML, y también para acceder a las funciones de utilidad para cargar diagramas, ejecutar informes y así sucesivamente.

 

Interfaz de EA.Project

GetReferenceList (

string Type)

Referencia

Utiliza el tipo de lista para obtener un puntero a un objeto de la Lista de Referencia.

Parámetros:

Tipo: String - especifica el tipo de lista a obtener; los tipos de lista válidos son:

 

Diagrama

Elemento

Restricción

Requisito

Conector

Estatus

Cardinalidad

Esfuerzo

Métrica

Escenario

Estatusy

Prueba

 

 

GetRelationshipMatrix()

String

Devuelve todas las Matrices de Relación como un documento XML.

 

Matriz de Relación

GetTechnologyVersion (

string ID)

String

Devuelve la versión de un determinado recurso de Tecnología MDG.

Parámetros:

ID: String - el ID de tecnología especificado

 

 

GetTreeSelectedElements()

Colección

Devuelve el conjunto de elementos seleccionados actualmente en el Explorador de Proyectos como una colección.

 

 

GetTreeSelectedItem (

object SelectedItem)

ObjectType

Obtiene un objeto variable y de tipo correspondiente al ítem seleccionado actualmente en la vista de árbol.

Para utilizar esta función, debe crear una variable de objeto genérico y pasarla como el parámetro. Dependiendo del tipo de retorno, se lanza a un tipo más específico.

El objeto pasado a través del parámetro puede ser un paquete, elemento, diagrama, atributo u objeto de operación.

Parámetros:

SelectedItem: Objeto - el objeto para obtener la variable y el tipo de

 

 

GetTreeSelectedItemType ()

ObjectType

Devuelve el tipo de objeto seleccionado actualmente en el árbol. Uno de los siguientes:

otDiagram

otElement

otPackage

otAttribute

otMethod

 

 

GetTreeSelectedObject ()

Objeto

El método relacionado GetTreeSelectedItem () tiene un parámetro de salida que es inaccesible por algunos lenguajes de scripting. Como alternativa, este método proporciona el ítem seleccionado a través del valor de retorno.

 

GetTreeSelectedItem

GetTreeSelectedPackage ()

Paquete

Devuelve el paquete en el cual el objeto de la vista de árbol seleccionado actualmente está contenido.

 

 

HasPerspective (

string Perspective)

 

String

Obsoleto - ya no está en uso.

 

HideAddinWindow ()

 

Oculta la ventana de Add-In acoplada.

 

AddWindow

Ventana Acoplada Personalizada

RemoveWindow

 

ImportPackageBuildScripts (

string PackageGuid,

string BuildScriptXML)

 

Importa scripts de construcción a un paquete en Enterprise Architect.

Parámetros:

PackageGuid: String - El ID del paquete en el cual importar los scripts de construcción

BuildScriptXML: String - los datos XML del script construcción, que puede exportar desde adentro de Enterprise Architect

 

 

ImportTechnology (

string Technology)

Boolean

Instala un recurso dado de la Tecnología MDG al repositorio.

Devuelve Verdadero, si la tecnología es cargada exitosamente en el modelo. De lo contrario devuelve Falso.

Esto se aplica a las tecnologías importadas en las versiones previas a 7.0 de Enterprise Architect (tecnologías importadas), no tecnologías referidas en la versión 7.0 y posteriores (tecnologías de referencia).

Parámetros:

Tecnología: String - el contenido del archivo de recurso de tecnología

 

Desplegar una Tecnología MDG

InvokeConstructPicker (

string ElementFilter)

String

Invoca la ventana Seleccionar <Ítem> con filtros en el tipo de objeto y, opcionalmente, el estereotipo. Devuelve el ElementID del objeto seleccionado, o 0 si no se ha seleccionado ningún objeto cuando se cerró la ventana.

Por ejemplo:

elementid=Repository.InvokeConstructPicker("IncludedTypes=Class,Component;StereoType=foo,bar")

En este ejemplo, la ventana Seleccionar <ítem> permitirá al usuario seleccionar cualquier elemento de Clase o Componente en el modelo que tiene un estereotipo de foo o bar.

Parámetros:

ElementFilter: String - especifica qué elementos o paquetes deben estar disponibles para la selección, basado en los tipos de elemento y los estereotipos identificados por los filtros IncludedTypes y StereoTypes.

IncludedTypes - (obligatorio) una lista separada por comas de los tipos de elementos que pueden ser seleccionados en esta ventana; por ejemplo: Paquete, Clase, Componente

StereoType - (opcional) una lista separada por comas de estereotipos que pueden ser seleccionados en esta ventana

 

Los filtros de IncludedTypes y StereoType están separados por un punto y coma

No utilice espacios iniciales o finales entre el tipo de elemento o los valores del estereotipo

StereoType e IncludedTypes deben escribirse con el tipo de letra (mayúscula/minúscula) correcto; los nombres del tipo de elemento también distinguen entre mayúsculas y minúsculas.

 

Ventana seleccionar <Ítem>

InvokeFileDialog (

string FilterString,

long Filterindex,

long Flags)

 

String

Abre una Ventana de Abrir Archivo estándar y devuelve una cadena que contiene la ruta completa del archivo seleccionado en caso de éxito. Devuelve una cadena vacía si la ventana fue cancelada.

Parámetros:

FilterString: String - lista de los filtros de tipo de archivo.

Filterindex: Long - Un índice basado en el filtro que se utilizará por defecto

Banderas: Long - banderas de bits adicionales para inicializar la ventana del archivo. Ver la estructura OPENFILENAME en la documentación MSDN para valores aceptados.

 

Project.GetFileNameDialog()

IsTabOpen (

string TabName)

String

Comprueba si una vista tabulada con nombre de Enterprise Architect está abierta y activa. Esto incluye abrir ventanas de diagrama o controles personalizados agregados utilizando Repository.AddTab ().

Devuelve:

2 para indicar que una pestaña está abierta y activa (parte superior)

1 para indicar que está abierta pero no en la parte superior, o

0 para indicar que no está visible del todo

 

Parámetros:

TabName: String - el nombre de la pestaña para revisar; el TabName distingue entre mayúsculas y minúsculas

 

Repository.AddTab()

IsTechnologyEnabled (

string ID)

Boolean

Comprueba si una determinada tecnología está activada en Enterprise Architect.

Devuelve Verdadero si el recurso de la Tecnología MDG está activado. De lo contrario devuelve Falso.

Parámetros:

ID: String - el ID de la tecnología a revisar

 

 

IsTechnologyLoaded (

string ID)

Boolean

Comprueba si una determinada tecnología está cargada en el repositorio.

Devuelve Verdadero si el recurso de la Tecnología MDG es cargado en el repositorio. De lo contrario devuelve Falso.

Parámetros:

ID: String - el ID de la tecnología a revisar

 

 

LoadAddins ()

 

Carga todos los Add-Ins desde un repositorio.

 

 

OpenDiagram (

long DiagramID)

 

Proporciona un método para un cliente de automatización o Add-In pueda abrir un diagrama. El diagrama es agregado a la lista tabulada de diagramas abiertos en la vista principal de Enterprise Architect.

Parámetros:

DiagramID: Long - el ID del diagrama a abrir

 

 

OpenFile (

string Filename)

Boolean

Este es el punto principal para abrir un archivo de proyecto de Enterprise Architect desde un cliente de automatización, y trabajar con los objetos contenidos.

Si el proyecto requerido es un repositorio DBMS, y usted ha creado un acceso directo del archivo .EAP que contiene la cadena de conexión de base de datos, puede llamar a este archivo de acceso directo para acceder al repositorio DBMS.

También puede conectarse a una base de datos SQL al pasar la misma cadena de conexión en lugar de un nombre de archivo. Una cadena de conexión válida puede obtenerse desde la ventana Abrir Proyecto seleccionando un repositorio SQL recientemente abierto.

Parámetros:

Nombre de Archivo: String - el nombre de archivo del proyecto de Enterprise Architect para abrir

 

Abrir un Proyecto

OpenFile2 (

string FilePath,

string Username,

string Password)

Boolean

En cuanto a OpenFile () excepto esto permite la especificación de una contraseña.

Parámetros:

Filepath: String - la ruta del archivo del proyecto de Enterprise Architect para abrir

Nombre de Usuario: String - el ID de inicio de sesión del usuario

Contraseña: String - la contraseña del usuario

 

 

RefreshModelView (

long PackageID)

 

Vuelve a cargar un paquete o el modelo completo, actualizando la interfaz de usuario.

Parámetros:

PackageID: Long - el ID del paquete para volver a cargar: si es 0, el modelo completo se vuelve a cargar; si es un ID de paquete válido, sólo ese paquete se vuelve a cargar

 

 

RefreshOpenDiagrams (

boolean FullReload)

 

Vuelve a cargar el contenido del diagrama para todos los diagramas abiertos desde el repositorio.

Parámetros:

FullReload: Booleano - si es falso sólo el contenido de los compartimientos del elemento se vuelven a cargar; si es verdadero el contenido completo de cada diagrama se vuelve a cargar

 

 

ReloadDiagram (

long DiagramID)

 

Recarga una diagrama determinado. Esto suele utilizarse para actualizar un diagrama visible después de la importación/exportación de código u otros procesos en lote donde el diagrama requiere actualizar completar.

Llamar a este método dentro de una llamada a Ea_OnNotifyContextItemModified no está soportado

 

Parámetros:

DiagramID: Long - el ID del diagrama para volver a cargar

 

EA_OnNotifyContextItemModified

RemoveOutputTab (

string Name)

 

Quita una pestaña especificada de la ventana de Salida.

Parámetros:

Nombre: String - el nombre de la pestaña para eliminar

 

 

RemoveWindow (

string WindowName)

Boolean

Elimina una ventana de Add-In que coincide con el WindowName especificado.

Parámetros:

WindowName: String - el nombre de la ventana para eliminar

 

AddWindow

 

RepositoryType ()

String

Devuelve el tipo de base de datos/repositorio abierto actualmente.

Puede llegar a devolver alguno de los siguientes valores:

JET ( archivo .EAP, formato MS Access 97 a 2003 )

ACCESS2007 ( archivo .accdb, formato MS Access 2007+ )

ASA ( Sybase SQL Anywhere )

SQLSVR ( Servidor SQL de Microsoft )

MYSQL ( MySQL )

ORACLE ( Oracle )

POSTGRES ( PostgreSQL )

 

 

RunModelSearch (

string sQueryName,

string sSearchTerm,

string sSearchOptions,

string sSearchData)

 

Ejecuta una búsqueda, mostrando los resultados en la ventana de Búsqueda de Modelo de Enterprise Architect.

Parámetros:

sQueryName: String - el nombre de la búsqueda a ejecutar, por ejemplo Simple

sSearchTerm: String - el término a buscar

sSearchOptions: String - actualmente no se utiliza

sSearchData: String - le permite suministrar una lista de resultados en forma de XML, el cual se anexa a la lista de resultados en Enterprise Architect - vea el formato XML; este parámetro no es obligatorio por lo que pase una cadena vacía para ejecutar la búsqueda de forma normal.

 

Formato XML

Clase de Proyecto (una llamada diferente para Ejecutar la Búsqueda de Modelo)

SaveAllDiagrams ()

 

Guarda todos los diagramas abiertos.

 

 

SaveAuditLogs (

string FilePath,

object StartDateTime,

object EndDateTime)

Boolean

Guarda los Registros de Auditoría contenidas dentro de un modelo a un archivo especificado.

Si StartDateTime y EndDateTime no son nulos, entonces, sólo los ítems de registro que entran en este período se guardan.

Devuelve verdadero en caso de éxito, falso en caso de fallo.

Esto puede fallar si el usuario que ha iniciado sesión en el modelo no tiene el permiso de acceso correcto

 

Parámetros:

FilePath: String - el archivo en el cual guardar los Registros de Auditoría a

StartDateTime: Variante ( DateTime ) - la primera fecha y hora de entradas de registro para guardar

EndDateTime; Variante ( DateTime ) - la última fecha y hora de entradas de registro para guardar

 

 

SaveDiagram (

long DiagramID)

 

Guarda un diagrama abierto; asume que el diagrama está abierto en la lista de Pestaña de interfaz de usuario principal.

Parámetros:

DiagramID: Long - el ID del diagrama para guardar

 

 

ScanXMIAndReconcile ()

 

Escanea los archivos del Paquete XMI asociados con cada uno de los Paquetes controlados del proyecto y restaura cualquier objeto o referencia cruzada del diagrama que se detectan como faltantes del proyecto.

Esta función es útil en entornos en equipo donde cada usuario mantiene su propia copia local de la base de datos del modelo (p.ej. varios archivos .EAP privados) y las actualizaciones del modelo son propagadas a través del uso de paquetes controlados; no proporciona ningún beneficio cuando el modelo es hospedado en una única base de datos compartida que es accedida por todos los miembros del equipo.

Cada paquete controlado se compara con su archivo XMI asociado y, si la información de referencia cruzada en el modelo no coincide con el XMI, Enterprise Architect actualiza el modelo con la información del XMI y registra la actualización en la ventana de Salida.

Puede deshacer esas actualizaciones haciendo clic derecho en la entrada en la ventana de Salida y seleccionando la opción del menú contextual Deshacer Actualización (o Deshacer Actualizaciones Seleccionadas si hay varias entradas seleccionadas).

Cerrar el modelo borra las entradas en la ventana de Salida; una entrada de la ventana Salida también se borra cuando deshace su actualización.

Esta funcionalidad es invocada automáticamente como parte de la operación Obtener Todos los Últimos.

Al trabajar en un entorno que utiliza un despliegue de Modelo Privado y su modelo contiene un número importante de referencias de Paquetes cruzados, se recomienda que invoque esta función de momento a momento, siguiendo la re-importación de Paquetes controlados - por ejemplo, después de utilizar Obtener Último para actualizar varios Paquetes - o después de realizar varias protecciones del Paquete.

Como una regla general, evite ejecutar esta función mientras tiene cambios no confirmados en su modelo

Generalmente, debería:

Desproteger varios paquetes

Invocar ScanXMIAndReconcile

Hacer sus modificaciones

Confirmar cualquier cambio sobresaliente antes de desproteger más paquetes y ejecutar ScanXMIAndReconcile otra vez

 

 

ShowAddinWindow (

string TabName)

Boolean

Muestra la ventana de Add-In acoplada en la página especificada. Devuelve verdadero si una pestaña con el nombre especificado se muestra ahora.

Parameters

TabName: String - especifica la página de la pestaña

 

AddWindow

Ventana Acoplada Personalizada

RemoveWindow

 

ShowDynamicHelp (

string Topic)

 

Muestra un tema de ayuda como una vista.

Parámetros:

Tema: String - especifica el tema de ayuda

 

 

ShowInProjectView (

object Item)

 

Selecciona un objeto especificado en el Explorador de Proyectos.

Los tipos de objetos aceptados son Paquete, Elemento, Diagrama, Atributo, y Método; se lanza una excepción si el objeto es de un tipo no válido.

Parámetros:

Ítem: Objeto - el objeto para resaltar

 

 

ShowWindow (

long Show)

 

Muestra u oculta Enterprise Architect

Parámetros:

Mostrar: Long

 

 

SQLQuery (

string SQL)

String

Permite la ejecución de una declaración select de SQL contra el repositorio actual.

Devuelve un valor de tipo string en formato XML del conjunto de registro resultante.

Parámetros:

SQL: String - contiene la declaración SQL Select

 

 

SynchProfile (

string Profile,

string Stereotype)

Boolean

Sincroniza los Valores Etiquetados y restricciones de un ítem de Perfil UML utilizando la ventana Sincronizar Elementos Perfilados.

Parámetros:

Perfil: String - el nombre del perfil que contiene el estereotipo

Estereotipo: String - el nombre del estereotipo de perfil para los cuales se deben sincronizar las etiquetas y restricciones predeterminadas

 

Sincronizar Valores Etiquetados y Restricciones

VersionControlResynchPkgStatuses (boolean ClearSettings)

 

Sincroniza el estatus de control de cada paquete controlado por versiones dentro del modelo actual con el estado informado por su proveedor de control de versiones.

Parámetros:

ClearSettings: Boolean

 

- Si es verdadero, borre las configuraciones de control de versiones de paquetes que son notificados por el proveedor de control de versiones como no controlados

 

- Si es falso, deje las configuraciones del control de versión invariables para paquetes reportados como no controlados

 

Volver a Sincronizar el Estatus de Paquetes Controlados por Versiones

WriteOutput (

string Name,

string Output,

long ID)

 

Escribe texto en una pestaña especificada en la ventana de Salida, y asocia el texto con un ID.

Parámetros:

Nombre: String - especifica la pestaña en la cual mostrar el texto

Salida: String - especifica el texto a mostrar

ID: Long - especifica un valor de ID numérico para asociar con este ítem de salida para una mayor manipulación por Add-Ins; se puede establecer en 0 si no es necesaria la manipulación

 

ClearOutput

CreateOutputTab

EnsureOutput Visible

 

EA_OnOutputItemClicked

EA_OnOutputItemDoubleClicked