Clase Paquete

Un objeto de Paquete corresponde a un elemento de Paquete en el Explorador de Proyectos de Enterprise Architect. Los Paquetes pueden ser accedidos a través de la colección de Modelos del Repositorio (un modelo es una forma especial de Paquete) o a través de la colecciones de Paquetes del Paquete.

Note que un Paquete tiene un objeto de Elemento como un atributo; esto corresponde a un elemento del Paquete de Enterprise Architect en la tabla t_object y es utilizado para asociar información adicional (tal como escenarios y restricciones) con el paquete de lógico.

Para configurar información adicional para un paquete, como referencia al objeto de Elemento directamente. También note que si agrega un Paquete a un diagrama, debería agregar una instancia del elemento (no el Paquete mismo) a la Clase DiagramObject para un diagrama.

Atributo	Tipo	Notas
Alias	Cadena	Sólo lectura Alias
BatchLoad	Long	Lectura/Escritura Marcar para indicar que el paquete es cargado por lotes durante la importación por lotes desde paquetes controlados. No utilizado actualmente.
BatchSave	Long	Lectura/Escritura Valor Booleano que indica si el paquete está incluido en la lista de exportación XMI por lote o no.
CodePath	Cadena	Lectura/Escritura La ruta donde se encuentra el código fuente asociado. No utilizado actualmente.
Conectores	Colección	Sólo lectura La colección de conectores.
Creado	Fecha	Lectura/Escritura Fecha en que fue creado el paquete.
Diagramas	Colección	Sólo lectura Una colección de diagramas contenidos en este paquete.
Elemento	Elemento	Sólo lectura El objeto de elemento asociado; utilizado para obtener/establecer información común tal como Estereotipo, Complejidad, Alias, Autor, Restricciones, Valores Etiquetados y Escenarios.
Elementos	Colección	Sólo lectura Una colección de elementos que pertenecen a ese paquete.
Banderas	Cadena	Lectura/Escritura Información extendida sobre el paquete.
IsControlled	Booleano	Lectura/Escritura Indica si el paquete ha sido marcado como Controlado.
IsModel	Booleano	Sólo lectura Indica si el paquete es un modelo o un paquete.
IsNamespace	Booleano	Lectura/Escritura Verdadero indica que ese 'paquete es una raíz del Espacio de Nombre'. Utilice 0 y 1 para establecer Falso y Verdadero.
IsProtected	Booleano	Lectura/Escritura Indica si el paquete ha sido marcado como Protegido.
IsVersionControlled	Booleano	Sólo lectura Indica si este paquete está o no bajo el control de versiones.
LastLoadDate	Fecha	Lectura/Escritura La última fecha en que XML fue cargado en el paquete.
LastSaveDate	Fecha	Lectura/Escritura La última fecha en que XML fue guardado del paquete.
LogXML	Booleano	Lectura/Escritura Indica si la información de exportación XMI debe registrarse.
Modificado	Fecha	Lectura/Escritura Fecha en la que el paquete fue modificado por última vez.
Nombre	Cadena	Lectura/Escritura El nombre del paquete.
Notas	Cadena	Lectura/Escritura Notas sobre este paquete.
ObjectType	ObjectType	Sólo lectura Distingue objetos referidos a través de una interfaz de Envío.
Dueño	Cadena	Lectura/Escritura El dueño del paquete cuando se utilizan paquetes controlados.
PackageGUID	Variante	Sólo lectura El ID global del Paquete; válido en distintos modelos.
PackageID	Long	Sólo lectura El número de ID del Paquete local. Válido sólo en este archivo modelo.
Paquetes	Colección	Sólo lectura Una colección de paquetes contenidos que puede ser recorrida.
ParentID	Long	Lectura/Escritura El ID del paquete en el que está en el padre de este. 0 indica que este paquete es un modelo (es decir, que no tiene padre).
TreePos	Long	Lectura/Escritura La posición relativa en el árbol comparada con otros paquetes (utilizada para ordenar paquetes).
UMLVersion	Cadena	Lectura/Escritura La versión UML para fines de exportación XMI.
UseDTD	Booleano	Lectura/Escritura Indica si un DTD debe utilizarse al exportar XMI.
Versión	Cadena	Lectura/Escritura La versión del paquete.
XMLPath	Cadena	Lectura/Escritura La ruta en la que se guarda el XML cuando se utilizan paquetes controlados.

Método

Tipo

Notas

ApplyGroupLock (

string aGroupName)

Booleano

Aplica un bloqueo de grupo para el objeto de paquete, para el grupo especificado, de parte del usuario actual.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error.

Parámetros:

•	aGroupName: Cadena - El nombre del grupo de seguridad para el cual aplicar el bloqueo

ApplyGroupLockRecursive (

string aGroupName)

Booleano

Aplica un bloqueo de grupo para el objeto de paquete, objeto y todos los del paquete, diagramas y elementos contenidos dentro de ese paquete, para el grupo especificado en nombre del usuario actual.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error.

Parámetros:

•	aGroupName: Cadena - El nombre del grupo de seguridad para el cual aplicar el bloqueo

ApplyUserLock ()

Booleano

Aplica un bloqueo de usuario para el objeto de paquete, para el usuario actual.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error.

ApplyUserLockRecursive ()

Booleano

Aplica bloqueos de usuario para el objeto de paquete, y todos los paquetes, diagramas y elementos contenidos dentro de ese paquete.

Devuelve verdadero si la operación es exitosa; devuelvefalso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error.

Clonar

LDISPATCH

Inserta una copia del paquete en el mismo padre que el paquete original.

Devuelve el paquete recién creado.

FindObject (

string DottedID)

LPDISPATCH

Devuelve un paquete, elemento, atributo u operación que coincide con el parámetroDottedID.

Si el DottedID no se encuentra, devuelve un error: No puede encontrar el objeto coincidente.

Parámetros:

•	DottedID: String - se encuentra en forma de object.object.object donde el objeto se reemplaza por el nombre de un paquete, elemento, atributo u operación; los ejemplos incluyen MyNamespace.Class1, CStudent.m_Name, MathClass.DoubleIt(int).

GetLastError ()

Cadena

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

ReleaseUserLock ()

Booleano

Elimina un bloqueo de usuario o grupo existente del objeto del paquete.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error.

ReleaseUserLockRecursive ()

Booleano

Libera los bloqueos de usuario y grupo del objeto de paquete, y todos los paquetes, diagramas y elementos contenidos dentro de ese paquete.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error

SetReadOnly (

boolean ReadOnly,

boolean IncludeSubPkgs)

Void

Establece una Bandera del Paquete para marcar un paquete como ReadOnly=1.

Si la Seguridad del Proyecto está habilitad, el usuario debe tener permiso de Configurar Paquetes para utilizar este método.

Lanza una excepción si se produce un error en la operación debido a que el usuario no tiene permiso de Configurar Paquetes; utilice GetLastError () para recuperar información del error.

Parámetros;

•	ReadOnly: Booleano - Establece o elimina la bandera de Sólo Lectura en el paquete(s); si es:

•	Falso, cualquier bandera de Sólo Lectura es eliminada del paquete

•	Verdadero, una bandera de Sólo Lectura se aplica al paquete

•	IncludeSubPkgs: Booleano - Indica si para establecer/restablecer la bandera de Sólo Lectura sólo en el paquete de objeto, o en el paquete de objeto y todos los sub-paquetes anidados que contiene; si es:

•	Falso, sólo la bandera en el paquete de objeto se establece o borra

•	Verdadero, las banderas se establecen (o borran, según el parámetro de ReadOnly) para el paquete de objeto, además de todos los sub-paquetes anidados que contiene

Cuando está trabajando con paquetes controlados por versiones, el marcador Sólo Lectura puede ser aplicado a paquetes ya sea si están protegidos o desprotegidos.

Se aplica la seguridad de usuario para configurar esta bandera - si se le impide la edición del paquete, también se impide la configuración de la bandera.

Update ()

Booleano

Actualiza el objeto de paquete actual después de modificar o anexar un nuevo ítem.

Si se devuelve falso, revise la función GetLastError () para más información.

Note que un objeto del paquete también tiene un componente del elemento que debe tomarse en cuenta; el objeto del paquete contiene información acerca de los atributos del paquete tal como jerarquía o contenidos.

El atributo de elemento contiene información sobre, por ejemplo, Estereotipos, Restricciones o Archivos - todos los atributos de un elemento típico.

VersionControlAdd (

string ConfigGuid,

string XMLFile,

string Comment,

boolean KeepCheckedOut)

Void

Coloca el paquete bajo control de versión, utilizando la Configuración de Control de Versiones y el nombre de archivo XMI especificado.

Lanza una excepción si la operación falla; utilice GetLastError () para recuperar información del error.

Se recomienda que el paquete se guarde utilizando Update() antes de llamar a VersionControlAdd (), por lo que los cambios pendientes no se pierden.

Parámetros:

•	ConfigGuid: String - Nombre que corresponde al ID único de la configuración del control de versiones a utilizar

•	XMLFile: String - Nombre del archivo XML a utilizar para este paquete; este nombre de archivo es relativo a la carpeta de Copia de Trabajo especificado para la Configuración

•	Comentario: String - Mensaje de registro que se agrega al historial del archivo controlado por versiones (donde sea aplicable)

•	KeepCheckedOut: Booleano - Especificar Verdadero para agregar al control de versiones y mantener el paquete desprotegido.

VersionControlCheckin (

string Comment)

Void

Realizar la protección del paquete controlado por versiones (vea también abajo VersionControlCheckinEx).

Lanza una excepción si la operación falla; utilice GetLastError ( ) para recuperar información del error.

Parámetros:

•	Comentario: String - Mensaje de registro que se agrega al historial del archivo controlado por versiones (donde sea aplicable)

VersionControlCheckinEx (

string Comment,

boolean PreserveCrossPkgRefs)

Void

Realizar la protección del paquete controlado por versiones.

Lanza una excepción si la operación falla; utilice GetLastError ( ) para recuperar información del error.

Parámetros:

•	Comentario: String - Mensaje de registro que se agrega al historial del archivo controlado por versiones (donde sea aplicable)

•

PreserveCrossPkgRefs: Booleano - Bandera para indicar si conservar o descartar Referencias Cruzadas de Paquetes pre-existentes al proteger; este parámetro anula la configuración en la ventana Opciones, la página de Especificaciones XML

Las Referencias Cruzadas de Paquete insatisfechas se conservan o descartan según esta configuración, sin preguntar al usuario; vea Aprender Más abajo

VersionControlCheckout (

string Comment)

Void

Realizar la desprotección del paquete controlado por versiones.

Lanza una excepción si la operación falla; utilice GetLastError ( ) para recuperar información del error.

Parámetros:

•	Comentario: String - Mensaje de registro que se agrega al historial del archivo controlado por versiones (donde sea aplicable)

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 el método Repository.ScanXMIAndReconcile ( ) de momento a momento, siguiendo la re-importación de Paquetes controlados - por ejemplo, después de utilizar Package.VersionControlGetLatest ( ) para actualizar varios Paquetes - o después de realizar varias protecciones del Paquete.

VersionControlGetLatest (

boolean ForceImport)

Void

Actualiza la copia local de trabajo del archivo del paquete asociado con el objeto de paquete, antes de volver a importar los datos del paquete desde un archivo de paquete.

Parámetros:

•	ForceImport: Booleano - Utilizado si los datos del paquete en el modelo se encuentran actualizados con respecto al archivo de paquete controlado por versiones; si es:

•	Falso, los datos del paquete que existen en el modelo se acepta como actualizados y no se hace ningún intento de volver a importar los datos desde el archivo de paquete.

•	Verdadero, Enterprise Architect vuelve a importar el paquete desde el archivo del paquete independientemente

Vea también la opción del menú de control de versión Obtener Último.

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 el métodoRepository.ScanXMIAndReconcile ( ) de momento a momento, siguiendo la re-importación de Paquetes controlados - por ejemplo, después de utilizar Package.VersionControlGetLatest ( ) para actualizar varios Paquetes - o después de realizar varias protecciones del Paquete.

VersionControlGetStatus ()

Long

Devuelve el estado de control de versión del paquete, tal y como se registró en la base de datos del proyecto de Enterprise Architect actual.

Lanza una excepción si la operación falla; utilice GetLastError ( ) para recuperar información del error.

Devolver mapas de valor para el tipo enumerado siguiente:

enum EnumCheckOutStatus

{

csUncontrolled = 0,

csCheckedIn,

csCheckedOutToThisUser,

csReadOnlyVersion,

csCheckedOutToAnotherUser,

csOfflineCheckedIn,

csCheckedOutOfflineByUser,

csCheckedOutOfflineByOther,

csDeleted,

};

csUncontrolled - Ya sea que es incapaz de comunicarse con el proveedor de control de versión asociado con el paquete o que el archivo de paquete es desconocido para el proveedor.

csCheckedIn - El paquete no está desprotegido para nadie de la base de datos actual del proyecto.

csCheckedOutToThisUser - El paquete no está marcado como desprotegido para el usuario actual, en la base de datos actual del proyecto.

csReadOnlyVersion - El paquete está marcado como de sólo lectura; una revisión anterior del paquete se ha recuperado del control de versiones.

csCheckedOutToAnotherUser - El paquete está marcado como desprotegido en la base de datos actual del proyecto, por un usuario distinto al usuario actual.

csOfflineCheckedIn - El paquete no está desprotegido para nadie en la base de datos actual del proyecto; sin embargo, la configuración del control de versiones asociada con el paquete no ha podido conectarse al servidor de VC.

csCheckedOutOfflineByUser - Indica que el paquete fue 'desprotegido' en esta base de datos, por este usuario, mientras está desconectado del control de versiones.

csCheckedOutOfflineByOther - Indica que el paquete fue desprotegido en la base de datos de este proyecto, por otro usuario, mientras está desconectado del control de versiones.

csDeleted - El archivo de paquete se ha eliminado del control de versiones.

VersionControlPutLatest (

string CheckInComment)

Void

Realizar una protección del paquete controlado por versiones, manteniendo el paquete desprotegido.

Lanza una excepción si la operación falla; utilice GetLastError ( ) para recuperar información del error.

Cuando un paquete que se marcó anteriormente como Desprotegido Fuera de Línea, Se 'Pone' (protege) correctamente para el control de versiones, esas banderas del paquete se actualizan para borrar el indicador Desprotegido Fuera de Línea.

Parámetros:

•	Comentario: String - Mensaje de registro agregado al historial del archivo controlado por versiones (donde sea aplicable)

VersionControlRemove ()

Void

Elimina el control de versión del paquete.

Lanza una excepción si la operación falla; utilice GetLastError ( ) para recuperar información del error.

VersionControlResynchPkgStatus (

boolean ClearSettings)

Sincroniza el estatus de control de versión de el único paquete de objeto registrado en su modelo actual con el estado del paquete informado por su proveedor de control de versiones.

Parámetros:

•	ClearSettings: Booleano - utilizado si el archivo del paquete asociado con el paquete especificado es reportado por el proveedor de control de versiones como descontrolado; si ClearSettings es:

•	Verdadero, las configuraciones del control de versiones se borran del paquete

•	Falso, las configuraciones del control de versiones permanecen inalteradas