Métodos del objeto Session

En la lista siguiente se resumen los métodos del objeto Session:

Nombre de método
Descripción
AddListMember
Añade un miembro de lista a la lista denominada.
Build
(Sólo Perl) Crea un objeto Session.
BuildEntity
Crea un nuevo registro del tipo especificado e inicia una acción de enviar.
BuildPermission
Compila y devuelve un objeto Permission.
BuildPermissions
Compila y devuelve un objeto Permissions.
BuildQuery
Crea y devuelve un nuevo objeto QueryDef para el tipo de registro especificado.
BuildResultSet
Crea y devuelve un conjunto de resultados que se puede utilizar para ejecutar una consulta.
BuildSQLQuery
Crea y devuelve un objeto ResultSet utilizando una serie de SQL sin formato.
CanSubmit
Devuelve True si el usuario actual tiene permiso para enviar el tipo de registro denominado.
CQDataCodePageIsSet
Devuelve si se ha establecido la página de códigos de datos de Rational ClearQuest.
ClearNameValues
Borra todos los valores de nombre para la sesión actual.
DbIdToStringId
Devuelve la serie IDid convertida de dbid.
DeleteEntity
Suprime el registro especificado de la base de datos actual.
DeleteListMember
Suprime un miembro de una lista denominada.
EditEntity
Realiza la acción especificada en un registro y hace que el registro esté disponible para la edición.
EntityVisible
Devuelve una indicación sobre si la entidad existe y está oculta.
EntityVisibleByDbId
Devuelve una indicación sobre si la entidad existe y está oculta.
FireRecordScriptAlias
Llama a la acción que llama al script de enganche; se utiliza para simular un usuario que elige una acción que inicia un enganche.
GetAccessibleDatabases
Devuelve una lista de las bases de datos que están disponibles para que el usuario especificado inicie la sesión.
GetAllGroups
Devuelve los nombres de todos los grupos que el usuario actual puede ver.
GetAllUsers
Devuelve los nombres de todos los usuarios que el usuario actual puede ver.
GetAuthenticationLoginName
Devuelve el nombre de inicio de sesión (es decir, el nombre de usuario) que entra el usuario como nombre de inicio de sesión cuando se autentica.
GetAuxEntityDefNames
Devuelve una matriz de series, y cada una de ellas corresponde al nombre de uno de los tipos de registro sin estado del schema.
GetBasicReturnStringMode
Devuelve la modalidad de ejecución para el modo de devolución de cadenas de caracteres para scripts y enganches de VBScript.
GetBuildNumber
Devuelve el número de build del producto.
GetClearQuestAPIVersionMajor
Devuelve un número de versión para la API.
GetClearQuestAPIVersionMinor
Devuelve un número de versión para la API.
GetClientCodePage
Devuelve un valor String que describe la página de códigos del cliente.
GetCompanyEmailAddress
Devuelve la dirección de correo electrónico de la empresa para el entorno local actual.
GetCompanyFullName
Devuelve el nombre completo de la empresa en el entorno local actual.
GetCompanyName
Devuelve el nombre de la empresa en el entorno local actual.
GetCompanyWebAddress
Devuelve la dirección web de la empresa para el entorno local actual.
GetCQDataCodePage
Devuelve un valor String que describe la página de códigos de datos de Rational ClearQuest.
GetDefaultDbSetName
Devuelve el nombre del conjunto de bases de datos predeterminado.
GetDefaultEntityDef
Devuelve el objeto EntityDef predeterminado del esquema.
GetDisplayNamesNeedingSiteExtension
Obtiene los nombres de los objetos que necesitan una extensión de sitio.
GetEnabledEntityDefs
Devuelve el objeto de recopilación EntityDefs habilitado en el esquema actual para una revisión de paquete determinada.
GetEnabledPackageRevs
Devuelve un objeto de recopilación que representa el conjunto PackageRev que está habilitado para la revisión actual del esquema.
GetEntity
Devuelve el registro especificado.
GetEntityByDbId
Devuelve el registro con el ID de base de datos especificado.
GetEntityDef
Devuelve el objeto EntityDef especificado.
GetEntityDefFamilyName
Devuelve el objeto EntityDef solicitado si es una familia.
GetEntityDefFamilyNames
Devuelve una matriz que contiene los nombres de familia de EntityDef solicitados.
GetEntityDefNames
Devuelve una matriz que contiene los nombres de los tipos de registro del schema de la base de datos actual.
GetEntityDefNamesForSubmit
Devuelve la lista de todos los tipos de registro que puede enviar el usuario.
GetEntityDefOfDbId
Proporciona funcionalidad de tipo ‘Buscar registro’. Devuelve el objeto EntityDef para el ID de base de datos de (DBID) de registro proporcionado.
GetEntityDefOfName
Proporciona funcionalidad de tipo ‘Buscar registro’. Devuelve el objeto EntityDef para el nombre de visualización de registro proporcionado.
GetEntityDefOrFamily
Devuelve el objeto EntityDef denominado.
GetEveryoneGroupName
Devuelve el nombre del grupo Everyone.
GetFullProductVersion
Devuelve la serie de versión completa del producto.
GetHookSeesAllRecords
Indica si el enganche actual ve todos los registros o únicamente los registros que el usuario actual está autorizado a ver.
GetHookSeesAllUsers
Indica si el enganche actual ve a todos los usuarios o únicamente a los usuarios que el usuario actual está autorizado a ver.
GetInstalledDbSets
Devuelve la lista de conjuntos de bases de datos registrados.
GetInstalledMasterDbs
Devuelve la lista de repositorios de esquemas registrados (bases de datos maestras).
GetInstalledMasters
Devuelve la lista de repositorios de esquema y conjuntos de bases de datos registrados (bases de datos maestras).
GetLicenseFeature
Devuelve el nombre de la característica FLEXlm que se ha utilizado para obtener una licencia.
GetLicenseVersion
Devuelve la versión de la característica FLEXlm que se ha utilizado para obtener una licencia.
GetListDefNames
Devuelve una lista de las listas dinámicas de la base de datos actual.
GetListMembers
Devuelve los valores de opción de una lista dinámica.
GetLocalReplica
Devuelve información sobre la creación de réplicas de bases de datos.
GetMaxCompatibleFeatureLevel
Obtiene el número de versión de base de datos máximo que admite el cliente de Rational ClearQuest en ejecución en esta máquina.
GetMinCompatibleFeatureLevel
Obtiene el número de versión de base de datos mínimo que admite el cliente de Rational ClearQuest en ejecución en esta máquina.
GetPatchVersion
Devuelve la versión de fixpack actual del producto.
GetProductInfo
(Sólo Perl) Devuelve un objeto CQProductInfo.
GetProductVersion
Devuelve la serie de versión del producto interna que está codificada en el archivo de cabecera.
GetQueryEntityDefFamilyNames
Devuelve los nombres de todas las consultas de familia de EntityDefs.
GetQueryEntityDefNames
Devuelve los nombres de los tipos de registro que son adecuados para utilizar en consultas.
GetReqEntityDefNames
Devuelve los nombres de los tipos de registro basados en estado en el schema de la base de datos actual.
GetServerInfo
Devuelve un valor String que identifica al servidor OLE de la sesión.
GetSessionDatabase
Devuelve información general sobre la base de datos a la que se accede en la sesión actual.
GetSessionFeatureLevel
Obtiene el número de versión del cliente de Rational ClearQuest que se ejecuta actualmente en la máquina.
GetSiteExtendedNames
Obtiene nombres con extensión de objetos Database.
GetSiteExtension
Obtiene la extensión del sitio para una base de datos.
GetStageLabel
Devuelve la etiqueta de fase utilizada para la compilación; la etiqueta de fase se genera de modo automático para cada compilación.
GetSubmitEntityDefNames
Devuelve una matriz que contiene los nombres de los tipos de registro que son adecuados para utilizar al crear un nuevo registro.
GetSuiteProductVersion
Devuelve la serie de versión del conjunto de aplicaciones.
GetSuiteVersion
Devuelve la serie de versión del conjunto de aplicaciones.
GetUnextendedName
Obtiene el nombre sin extensión de una base de datos.
GetUserEmail
Devuelve la dirección de correo electrónico del usuario que ha iniciado esta sesión.
GetUserFullName
Devuelve el nombre completo del usuario que ha iniciado esta sesión.
GetUserGroups
Devuelve una lista de los grupos a los que pertenece el usuario actual.
GetUserLoginName
Devuelve el nombre que se ha utilizado para iniciar esta sesión.
GetUserMiscInfo
Devuelve información varia sobre el usuario que ha iniciado esta sesión.
GetUserPhone
Devuelve el número de teléfono del usuario que ha iniciado esta sesión.
GetWebLicenseVersion
Devuelve la versión de la característica FLEXlm que se ha utilizado para obtener una licencia web.
GetWorkSpace
Devuelve el objeto Workspace de la sesión.
HasUserPrivilege
Prueba un nivel de privilegio de usuario en un contexto de seguridad.
HasValue
Devuelve un valor Bool que indica si existe la variable de sesión especificada.
IsClientCodePageCompatibleWithCQDataCodePage
Devuelve si la página de códigos del cliente es compatible con la página de códigos de datos de Rational ClearQuest.
IsEmailEnabled
Prueba si el usuario actual tiene habilitado el correo electrónico.
IsMetadataReadonly
Devuelve un valor Boolean que indica si los metadatos de la sesión son de sólo lectura.
IsMultisiteActivated
Devuelve un booleano que indica si la base de datos actual se ha activado para operaciones Multisite.
IsPackageUpgradeNeeded
Devuelve un valor Boolean que indica si la revisión de paquete actual que se ha aplicado al esquema es la revisión de paquete más reciente que está disponible para el paquete.
IsReplicated
Devuelve un booleano que indica si la base de datos actual tiene, como mínimo, dos sitios replicados.
IsRestrictedUser
Prueba si el usuario actual está trabajando bajo capacidad en modalidad restringida del cliente de ClearQuest Web.
IsSiteExtendedName
Prueba si un nombre de base de datos es un nombre con extensión.
IsStringInCQDataCodePage
Devuelve si la página de códigos de datos de Rational ClearQuest contiene un String determinado.
IsUnix
Devuelve un valor Boolean que indica si Rational ClearQuest está en ejecución en el sistema UNIX o la máquina Linux.
IsUnsupportedClientCodePage
Devuelve si no se ofrece soporte para la página de códigos del cliente.
IsUserAppBuilder
Prueba los privilegios de diseñador de esquemas en un contexto de seguridad.
IsUserSuperUser
Prueba los privilegios de superusuario en un contexto de seguridad.
IsWindows
Devuelve un valor Boolean que indica si IBM Rational ClearQuest está en ejecución en una máquina de Windows.
LoadEntity
Obtiene los valores más recientes de un registro.
LoadEntityByDbId
Obtiene los valores más recientes de un registro.
MarkEntityAsDuplicate
Modifica el registro especificado para indicar que es un duplicate de otro registro.
OpenQueryDef
Carga una consulta de un archivo.
OutputDebugString
Especifica un mensaje que se puede visualizar por medio de un depurador u otra herramienta similar.
ParseSiteExtendedName
Divide un nombre de base de datos en un nombre sin extensión y una extensión de sitio.
SetBasicReturnStringMode
Especifica la modalidad de ejecución para el modo de devolución de cadenas de caracteres para scripts y enganches de VBScript.
SetHookSeesAllRecords
Especifica si el enganche actual ve todos los registros o únicamente los registros que el usuario actual está autorizado a ver.
SetHookSeesAllUsers
Especifica si el enganche actual ve a todos los usuarios o únicamente a los usuarios que el usuario actual está autorizado a ver.
SetListMembers
Establece los miembros de una lista denominada.
StringIdToDbId
Devuelve el número de dbid convertido del ID de serie.
Unbuild
(Sólo Perl) Suprime un objeto Session, cuando ya no se necesita.
UnmarkEntityAsDuplicate
Elimina la indicación de que el registro especificado es un duplicate de otro registro.
UserLogon
Inicia la sesión como el usuario especificado para una sesión de base de datos.
ValidateStringInCQDataCodePage
Comprueba si un String determinado se encuentra en la página de códigos de datos de Rational ClearQuest para el repositorio de esquemas de la sesión.
ValidateUserCredentials
Valida las credenciales del usuario, dado un nombre de inicio de sesión y una contraseña de usuario.
Nota: Para los métodos Perl que se correlacionan con propiedades de Visual Basic, consulte la sección Propiedades correspondiente a este objeto.

En la lista siguiente se resumen los métodos del objeto Session de Perl adicionales:

Nombre de método
Descripción
GetNameValue
Obtiene el valor asociado a un nombre de variable determinado.
SetNameValue
Establece el valor asociado a un nombre de variable determinado.

Feedback