Maxscape::ServerObject Package

Synopsis

use Maxscape::ServerObject;

Description

The Maxscape::ServerObject package implements a base class to be inherited. It provides some generic features that can be reused by other classes.

List of Member Functions

1. Error
2. ErrorState
3. printError
4. resetError
5. setError
6. setErrorCalltype

Member Functions

Error

Synopsis

my $ErrorText = $ServerObject->Error (@Parameter);

Description

Returns an error text.

Examples

my $ErrorText = $ServerObject->Error ("Can't create class ($ClassName): $@.");

setError

Synopsis

my $ErrorText = $ServerObject->setError (%Parameter);

Description

Stores information and returns an error text.

Examples

my $ErrorText = $ServerObject->setError('Process.initialise',
                                        'Can't initialise system.');

ErrorState

Synopsis

my $ErrorText = $ServerObject->ErrorState ();

Description

Returns the error state.

printError

Synopsis

my $ErrorText = $ServerObject->printError ();

Description

Returns an error text and prints it to STDOUT.

resetError

Synopsis

my $ErrorText = $ServerObject->resetError ();

Description

Resets and return an error and prints it to STDOUT.

setErrorCalltype

Synopsis

$ServerObject->setErrorCalltype(ClassType => 'Position', Function  => 'inFunctionName');

Description

Sets the error's call type.

1