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.