The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
HH-Unispool-Config-0.2
River stage zero No dependents
++
/ HH::Unispool::Config::File::Token::Numbered::System

NAME

HH::Unispool::Config::File::Token::Numbered::System - abstract class for system S tokens

SYNOPSIS

Application programmers don't need to use this class and API programmers read code.

ABSTRACT

abstract class for system S tokens

DESCRIPTION

HH::Unispool::Config::File::Token::Numbered::System is an abstract class for system S tokens.

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new HH::Unispool::Config::File::Token::Numbered::System object. OPT_HASH_REF is a hash reference used to pass initialization options. OPT_HASH_REF is mandatory. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF may include:

acct

Passed to set_acct().

apass

Passed to set_apass().

block_delay

Passed to set_block_delay().

execution_priority

Passed to set_execution_priority().

high_priority_login

Passed to set_high_priority_login().

initially_open

Passed to set_initially_open().

remote_system_name

Passed to set_remote_system_name(). Mandatory option.

timeout

Passed to set_timeout().

upass

Passed to set_upass().

Options for OPT_HASH_REF inherited through package HH::Unispool::Config::File::Token may include:

input_line_number

Passed to set_input_line_number().

Options for OPT_HASH_REF inherited through package HH::Unispool::Config::File::Token::Numbered may include:

number

Passed to set_number().

new_from_string(LINE)

This method is inherited from package 'HH::Unispool::Config::File::Token'. Creates a new object from the specified Unispool config file line string.

METHODS

read_string(LINE)

This method is overloaded from package 'HH::Unispool::Config::File::Token::Numbered'. Reads the Unispool config file token from a line string. LINE is a plain line string. On error an exception Error::Simple is thrown.

write_string()

This method is overloaded from package 'HH::Unispool::Config::File::Token::Numbered'. Returns a Unispool config file token line string.

set_acct(VALUE)

Set the remote login account (is not available on development system used). VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^.*$
get_acct()

Returns the remote login account (is not available on development system used).

set_apass(VALUE)

Set the account password (is not available on development system used). VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^.*$
get_apass()

Returns the account password (is not available on development system used).

set_block_delay(VALUE)

Set the time in seconds UNISPOOL should pause between sending two blocks. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\d*$
get_block_delay()

Returns the time in seconds UNISPOOL should pause between sending two blocks.

set_execution_priority(VALUE)

Set the execution priority of the driver process on MPE hosts. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must be a (sub)class of:
HH::Unispool::Config::ExecPri
get_execution_priority()

Returns the execution priority of the driver process on MPE hosts.

set_high_priority_login(VALUE)

State that the login must be high priotity (is not available on development system used). VALUE is the value. On error an exception Error::Simple is thrown.

is_high_priority_login()

Returns whether the login must be high priotity (is not available on development system used) or not.

set_initially_open(VALUE)

State that the communication link should be opened at the moment UNISPOOL is started. VALUE is the value. On error an exception Error::Simple is thrown.

is_initially_open()

Returns whether the communication link should be opened at the moment UNISPOOL is started or not.

set_remote_system_name(VALUE)

Set the unique name for the remote system. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^.+$
get_remote_system_name()

Returns the unique name for the remote system.

set_timeout(VALUE)

Set the delay before closing the link after transfering the last request (in seconds) (is not available on development system used). VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\d*$
get_timeout()

Returns the delay before closing the link after transfering the last request (in seconds) (is not available on development system used).

set_upass(VALUE)

Set the user paccword (is not available on development system used). VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^.*$
get_upass()

Returns the user paccword (is not available on development system used).

INHERITED METHODS FROM HH::Unispool::Config::File::Token

To access attribute named input_line_number:

set_input_line_number(), get_input_line_number()

INHERITED METHODS FROM HH::Unispool::Config::File::Token::Numbered

To access attribute named number:

set_number(), get_number()

SEE ALSO

HH::Unispool::Config, HH::Unispool::Config::DateFormat, HH::Unispool::Config::Entry, HH::Unispool::Config::Entry::Device, HH::Unispool::Config::Entry::Device::0, HH::Unispool::Config::Entry::Device::1, HH::Unispool::Config::Entry::Device::2, HH::Unispool::Config::Entry::Device::3, HH::Unispool::Config::Entry::Device::4, HH::Unispool::Config::Entry::Device::5, HH::Unispool::Config::Entry::Device::6, HH::Unispool::Config::Entry::Device::7, HH::Unispool::Config::Entry::Filter, HH::Unispool::Config::Entry::Numbered, HH::Unispool::Config::Entry::RemoteSystem, HH::Unispool::Config::Entry::RemoteSystem::3, HH::Unispool::Config::Entry::RemoteSystem::6, HH::Unispool::Config::Entry::RemoteSystem::7, HH::Unispool::Config::Entry::RemoteSystem::8, HH::Unispool::Config::Entry::System, HH::Unispool::Config::ExecPri, HH::Unispool::Config::File::Token, HH::Unispool::Config::File::Token::Comment, HH::Unispool::Config::File::Token::Comment::Cs, HH::Unispool::Config::File::Token::Comment::Date, HH::Unispool::Config::File::Token::Comment::Device, HH::Unispool::Config::File::Token::Comment::Filter, HH::Unispool::Config::File::Token::Comment::Group, HH::Unispool::Config::File::Token::Comment::Head, HH::Unispool::Config::File::Token::Comment::Misc, HH::Unispool::Config::File::Token::Comment::NetDesc, HH::Unispool::Config::File::Token::Comment::RSys, HH::Unispool::Config::File::Token::Comment::Scope, HH::Unispool::Config::File::Token::Comment::Tail, HH::Unispool::Config::File::Token::Factory, HH::Unispool::Config::File::Token::Numbered, HH::Unispool::Config::File::Token::Numbered::Device, HH::Unispool::Config::File::Token::Numbered::Device::0, HH::Unispool::Config::File::Token::Numbered::Device::1, HH::Unispool::Config::File::Token::Numbered::Device::2, HH::Unispool::Config::File::Token::Numbered::Device::3, HH::Unispool::Config::File::Token::Numbered::Device::4, HH::Unispool::Config::File::Token::Numbered::Device::5, HH::Unispool::Config::File::Token::Numbered::Device::6, HH::Unispool::Config::File::Token::Numbered::Device::7, HH::Unispool::Config::File::Token::Numbered::Device::Group, HH::Unispool::Config::File::Token::Numbered::Device::Info, HH::Unispool::Config::File::Token::Numbered::Device::P, HH::Unispool::Config::File::Token::Numbered::Network, HH::Unispool::Config::File::Token::Numbered::System::3, HH::Unispool::Config::File::Token::Numbered::System::6, HH::Unispool::Config::File::Token::Numbered::System::7, HH::Unispool::Config::File::Token::Numbered::System::8, HH::Unispool::Config::File::Token::Numbered::System::Info, HH::Unispool::Config::File::Token::Numbered::X, HH::Unispool::Config::File::Token::Unnumbered, HH::Unispool::Config::File::Token::Unnumbered::Bcs, HH::Unispool::Config::File::Token::Unnumbered::CSN, HH::Unispool::Config::File::Token::Unnumbered::Cs, HH::Unispool::Config::File::Token::Unnumbered::CsBcs, HH::Unispool::Config::File::Token::Unnumbered::Filter, HH::Unispool::Config::File::Token::Unnumbered::Host, HH::Unispool::Config::File::Token::Unnumbered::Misc, HH::Unispool::Config::File::Tokenizer, HH::Unispool::Config::FilterType, HH::Unispool::Config::OS, HH::Unispool::Config::Scope

BUGS

None known (yet.)

HISTORY

First development: February 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2003 by Vincenzo Zocca

LICENSE

This file is part of the HH::Unispool::Config module hierarchy for Perl by Vincenzo Zocca.

The HH::Unispool::Config module hierarchy is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

The HH::Unispool::Config module hierarchy is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the HH::Unispool::Config module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA