NAME

HTC.pm - Utilities and methods for the Grid::Request modules.

DESCRIPTION

Overview

This method provides several functions and methods that are useful to the Grid modules.

Class and object methods

$obj->new([%arg]);

Description: This is the object contructor. A hash with arguments may be passed.

Parameters: %arg.

Returns: $self, a blessed hash reference.

$obj->_init();

Description: _init in this class is an abstract method and is not implemented. In fact, it will die with an error message if you somehow call this method in this class.

Parameters: None.

Returns: None.

$obj->debug([$debug]);

Description: The debug method allows the user to set or get the debug level. If an optional argument is sent, it will be used to set the debug level. The default level is "error". When passing a string debug level, case is ignored.

Parameters: Optional integer argument to set debug level. The debug level can be either numeric or a string as follows:

Name     Code
----     ----
DEBUG       5
INFO        4
WARN        3
ERROR       2
FATAL       1

Returns: The current debug level in numeric form.

$obj->project([$project]);

Description: Used to set or get the project that the job is to be associated with. The project is necessary to track usage patterns of the infrastructure and to provide useful management information.

Parameters: $project, optional project argument.

Returns: $project, the currently set project.

ENVIRONMENT

If the user sets the GRID_CONFIG environment variable, it will be interpreted as the path to an alternate configuration file that will override the default.

BUGS

Description of known bugs (and any workarounds). Usually also includes an invitation to send the author bug reports.