Vincenzo Zocca > HH-Unispool-Config-0.3 > HH::Unispool::Config::File::Token::Unnumbered::Misc

Download:
HH-Unispool-Config-0.3.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.3   Source  

NAME ^

HH::Unispool::Config::File::Token::Unnumbered::Misc - class for miscellaneous M tokens

SYNOPSIS ^

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

ABSTRACT ^

class for miscellaneous M tokens

DESCRIPTION ^

HH::Unispool::Config::File::Token::Unnumbered::Misc is a class for miscellaneous M tokens.

CONSTRUCTOR ^

new(OPT_HASH_REF)

Creates a new HH::Unispool::Config::File::Token::Unnumbered::Misc 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:

clean_on_weekdays_only

Passed to set_clean_on_weekdays_only(). Defaults to 0.

date_format

Passed to set_date_format().

default_printer

Passed to set_default_printer().

local_system_name

Passed to set_local_system_name(). Mandatory option.

maximum_delay_time

Passed to set_maximum_delay_time(). Defaults to 15.

maximum_print_file_space

Passed to set_maximum_print_file_space(). Defaults to 0.

maximum_save_file_space

Passed to set_maximum_save_file_space(). Defaults to 0.

save_groups

Passed to set_save_groups(). Defaults to ''.

save_time_in_days

Passed to set_save_time_in_days(). Defaults to 3.

start_time_clean_job_hour

Passed to set_start_time_clean_job_hour(). Defaults to 0.

start_time_clean_job_minute

Passed to set_start_time_clean_job_minute(). Defaults to 0.

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

input_line_number

Passed to set_input_line_number().

new_from_string(LINE)

Creates a new object from the specified Unispool config file line string.

METHODS ^

get_date_format()

Returns the format in which UNISPOOL will show and accept date information.

get_default_printer()

Returns the printer to be used when no other one is specified.

get_input_line_number()

This method is inherited from package HH::Unispool::Config::File::Token. Returns the line number from from which the token is read.

get_local_system_name()

Returns the name of the system UNISPOOL is running on.

get_maximum_delay_time()

Returns the number of seconds the UNISPOOL main process is allowed to sleep between consecutive scans for printfiles.

get_maximum_print_file_space()

Returns the maximum number of bytes available to store UNISPOOL printfiles.

get_maximum_save_file_space()

Returns the maximum number of bytes available to store saved printfiles.

get_save_groups()

Returns the number of savegroups (not found in UNISPOOL config -screen).

get_save_time_in_days()

Returns the number of days saved printfiles will be kept on disk before they are automatically removed.

get_start_time_clean_job_hour()

Returns the hour part of the time that the clean job must be started on a 24-hour clock.

get_start_time_clean_job_minute()

Returns the minute part of the time that the clean job must be started on a 24-hour clock.

is_clean_on_weekdays_only()

Returns whether saved printfiles are deleted on weekdays only or not.

read_string(LINE)

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

set_clean_on_weekdays_only(VALUE)

State that saved printfiles are deleted on weekdays only. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

set_date_format(VALUE)

Set the format in which UNISPOOL will show and accept date information. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must be a (sub)class of:
HH::Unispool::Config::DateFormat
set_default_printer(VALUE)

Set the printer to be used when no other one is specified. VALUE is the value. On error an exception Error::Simple is thrown.

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

This method is inherited from package HH::Unispool::Config::File::Token. Set the line number from from which the token is read. VALUE is the value. On error an exception Error::Simple is thrown.

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

Set the name of the system UNISPOOL is running on. VALUE is the value. VALUE may not be undef. On error an exception Error::Simple is thrown.

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

Set the number of seconds the UNISPOOL main process is allowed to sleep between consecutive scans for printfiles. VALUE is the value. Default value at initialization is 15. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\d+$
set_maximum_print_file_space(VALUE)

Set the maximum number of bytes available to store UNISPOOL printfiles. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\d+$
set_maximum_save_file_space(VALUE)

Set the maximum number of bytes available to store saved printfiles. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\d+$
set_save_groups(VALUE)

Set the number of savegroups (not found in UNISPOOL config -screen). VALUE is the value. Default value at initialization is ''. On error an exception Error::Simple is thrown.

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

Set the number of days saved printfiles will be kept on disk before they are automatically removed. VALUE is the value. Default value at initialization is 3. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\d+$
set_start_time_clean_job_hour(VALUE)

Set the hour part of the time that the clean job must be started on a 24-hour clock. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\d+$
set_start_time_clean_job_minute(VALUE)

Set the minute part of the time that the clean job must be started on a 24-hour clock. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\d+$
write_string()

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

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, 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::Tokenizer, HH::Unispool::Config::FilterType, HH::Unispool::Config::OS, HH::Unispool::Config::Scope

BUGS ^

None known (yet.)

HISTORY ^

First development: February 2003 Last update: September 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

syntax highlighting: