/ 
Clearquest-2.23
/ Clearquest::Admin

NAME Admin.pm

Clearquest Admin - Provide access Clearquest AdminSession objects

VERSION

Author

Andrew DeFaria <Andrew@DeFaria.com>

Revision

$Revision: 1.3 $

Created

Wed Apr 18 09:59:47 PDT 2012

Modified

2012/11/09 06:53:11

SYNOPSIS

Provides an interface to the Clearquest AdminSession objects. These are for dealing with objects in the schema, not the user database.

DESCRIPTION

The Admin object allows you to create a session object associated with a schema repository. This allows you to retrieve and modify information in a schema repository. You must log into the Admin object as an admin user.

Functions are available to deal with users, groups, databases and schemas.

Note: Admin object needs to be filled out with more functions over time...

ROUTINES

The following methods are available:

getUser ($)

Returns a user object for the specified user or undef.

Parameters:

$username

The $loginname to retrieve the user object for

Returns:

User object

A user object

userActive ($)

Returns a true if user is active

Parameters:

$username

The $loginname to see if active

Returns:

1 if true, 0 if false

userActivate ($)

Activates a user if they were inactive

Parameters:

$username

The $loginname to activate

Returns:

nothing

userInactivate ($)

Inactivates a user if they were active

Parameters:

$username

The $loginname to inactivate

Returns:

nothing

connect (;$$$)

Connect to the Clearquest schema database. You can supply parameters such as username, password, etc and they will override any passed to Clearquest::Admin::new (or those coming from ../etc/cq.conf)

Parameters:

$username

Username to use to connect to the schema database

$password

Password to use to connect to the schema database

$dbset

Database set to connect to (Default: Connect to the default dbset)

Returns:

connected ()

Returns 1 if we are currently connected to a Clearquest Admin Schema Database

Parameters:

none

Returns:

1 if logged in - 0 if not

disconnect ()

Disconnect from Clearquest Admin Schema Database

Parameters:

none

Returns:

nothing

CONFIGURATION AND ENVIRONMENT

DEBUG: If set then $debug is set to this level.

VERBOSE: If set then $verbose is set to this level.

TRACE: If set then $trace is set to this level.

DEPENDENCIES

Perl Modules

Carp

File::Basename

FindBin

IO::Socket

Net::hostent

POSIX

BUGS AND LIMITATIONS

There are no known bugs in this module.

Please report problems to Andrew DeFaria <Andrew@DeFaria.com>.

LICENSE AND COPYRIGHT

Copyright (C) 2007-2026 Andrew DeFaria <Andrew@DeFaria.com>

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone else, you are strictly prohibited from removing any copyright notice from that Modified Version.

Copyright Holder makes no, and expressly disclaims any, representation or warranty, should the Package be used for any purpose. The liability of the Copyright Holder is limited to the maximum extent permitted by law.