The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Data-Conveyor-0.06
River stage zero No dependents
++
/ Data::Conveyor::Service::Interface::Shell

$method

$description

$param_help

$example_pod

NAME

Data::Conveyor::Service::Interface::Shell - stage-based conveyor-belt-like ticket handling system

SYNOPSIS

    Data::Conveyor::Service::Interface::Shell->new;

DESCRIPTION

None yet. This is an early release; fully functional, but undocumented. The next release will have more documentation.

METHODS

base
    my $value = $obj->base;
    $obj->base($value);

A basic getter/setter method. If called without an argument, it returns the value. If called with a single argument, it sets the value.

base_clear
    $obj->base_clear;

Clears the value.

clear_base
    $obj->clear_base;

Clears the value.

clear_hostname
    $obj->clear_hostname;

Clears the value.

clear_limit
    $obj->clear_limit;

Clears the value.

clear_log
    $obj->clear_log;

Clears the value.

clear_name
    $obj->clear_name;

Clears the value.

clear_pager
    $obj->clear_pager;

Clears the value.

clear_prompt_spec
    $obj->clear_prompt_spec;

Clears the value.

clear_sth
    $obj->clear_sth;

Deletes all keys and values from the hash.

clear_ticket_no
    $obj->clear_ticket_no;

Clears the value.

dec_num
    $obj->dec_num;

Decreases the value by 1.

delete_sth
    $obj->delete_sth(@keys);

Takes a list of keys and deletes those keys from the hash.

exists_sth
    if ($obj->exists_sth($key)) { ... }

Takes a key and returns a true value if the key exists in the hash, and a false value otherwise.

hostname
    my $value = $obj->hostname;
    $obj->hostname($value);

A basic getter/setter method. If called without an argument, it returns the value. If called with a single argument, it sets the value.

hostname_clear
    $obj->hostname_clear;

Clears the value.

inc_num
    $obj->inc_num;

Increases the value by 1.

keys_sth
    my @keys = $obj->keys_sth;

Returns a list of all hash keys in no particular order.

limit
    my $value = $obj->limit;
    $obj->limit($value);

A basic getter/setter method. If called without an argument, it returns the value. If called with a single argument, it sets the value.

limit_clear
    $obj->limit_clear;

Clears the value.

log
    my $value = $obj->log;
    $obj->log($value);

A basic getter/setter method. If called without an argument, it returns the value. If called with a single argument, it sets the value.

log_clear
    $obj->log_clear;

Clears the value.

name
    my $value = $obj->name;
    $obj->name($value);

A basic getter/setter method. If called without an argument, it returns the value. If called with a single argument, it sets the value.

name_clear
    $obj->name_clear;

Clears the value.

num
    $obj->num($value);
    my $value = $obj->num;

A basic getter/setter method. If called without an argument, it returns the value, or 0 if there is no previous value. If called with a single argument, it sets the value.

num_dec
    $obj->num_dec;

Decreases the value by 1.

num_inc
    $obj->num_inc;

Increases the value by 1.

num_reset
    $obj->num_reset;

Resets the value to 0.

pager
    my $value = $obj->pager;
    $obj->pager($value);

A basic getter/setter method. If called without an argument, it returns the value. If called with a single argument, it sets the value.

pager_clear
    $obj->pager_clear;

Clears the value.

prompt_spec
    my $value = $obj->prompt_spec;
    $obj->prompt_spec($value);

A basic getter/setter method. If called without an argument, it returns the value. If called with a single argument, it sets the value.

prompt_spec_clear
    $obj->prompt_spec_clear;

Clears the value.

reset_num
    $obj->reset_num;

Resets the value to 0.

sth
    my %hash     = $obj->sth;
    my $hash_ref = $obj->sth;
    my $value    = $obj->sth($key);
    my @values   = $obj->sth([ qw(foo bar) ]);
    $obj->sth(%other_hash);
    $obj->sth(foo => 23, bar => 42);

Get or set the hash values. If called without arguments, it returns the hash in list context, or a reference to the hash in scalar context. If called with a list of key/value pairs, it sets each key to its corresponding value, then returns the hash as described before.

If called with exactly one key, it returns the corresponding value.

If called with exactly one array reference, it returns an array whose elements are the values corresponding to the keys in the argument array, in the same order. The resulting list is returned as an array in list context, or a reference to the array in scalar context.

If called with exactly one hash reference, it updates the hash with the given key/value pairs, then returns the hash in list context, or a reference to the hash in scalar context.

sth_clear
    $obj->sth_clear;

Deletes all keys and values from the hash.

sth_delete
    $obj->sth_delete(@keys);

Takes a list of keys and deletes those keys from the hash.

sth_exists
    if ($obj->sth_exists($key)) { ... }

Takes a key and returns a true value if the key exists in the hash, and a false value otherwise.

sth_keys
    my @keys = $obj->sth_keys;

Returns a list of all hash keys in no particular order.

sth_values
    my @values = $obj->sth_values;

Returns a list of all hash values in no particular order.

ticket_no
    my $value = $obj->ticket_no;
    $obj->ticket_no($value);

A basic getter/setter method. If called without an argument, it returns the value. If called with a single argument, it sets the value.

ticket_no_clear
    $obj->ticket_no_clear;

Clears the value.

values_sth
    my @values = $obj->values_sth;

Returns a list of all hash values in no particular order.

Data::Conveyor::Service::Interface::Shell inherits from Term::Shell::Enhanced and Data::Conveyor::Service::Interface.

The superclass Term::Shell::Enhanced defines these methods and functions:

    catch_run(), clear_opt(), cmd(), delete_opt(), exists_opt(), expand(),
    fini(), get_history_filename(), getopt(), help_alias(), help_apropos(),
    help_cd(), help_echo(), help_eval(), help_pwd(), help_quit(),
    help_set(), keys_opt(), opt(), opt_clear(), opt_delete(), opt_exists(),
    opt_keys(), opt_values(), postloop(), precmd(), print_greeting(),
    prompt_str(), run_(), run_alias(), run_apropos(), run_cd(), run_echo(),
    run_pwd(), run_quit(), run_set(), smry_alias(), smry_apropos(),
    smry_cd(), smry_echo(), smry_eval(), smry_pwd(), smry_quit(),
    smry_set(), values_opt()

The superclass Data::Inherited defines these methods and functions:

    every_hash(), every_list(), flush_every_cache_by_key()

The superclass Term::Shell defines these methods and functions:

    new(), DESTROY(), add_commands(), add_handlers(), cmd_prefix(),
    cmd_suffix(), cmdloop(), comp_(), comp_help(), complete(),
    completions(), do_action(), exact_action(), find_handlers(),
    format_pairs(), get_aliases(), handler(), has_aliases(),
    have_readkey(), help(), help_exit(), help_help(), idle(), is_alias(),
    line(), line_args(), line_parsed(), msg_ambiguous_cmd(),
    msg_unknown_cmd(), page(), page_internal(), parse_quoted(),
    possible_actions(), postcmd(), preloop(), print_pairs(), process_esc(),
    prompt(), readkey(), readline(), remove_commands(), remove_handlers(),
    rl_complete(), run_exit(), run_help(), smry_exit(), smry_help(),
    stoploop(), summary(), term(), termsize(), unalias(), uniq()

The superclass Class::Accessor::Complex defines these methods and functions:

    mk_abstract_accessors(), mk_array_accessors(), mk_boolean_accessors(),
    mk_class_array_accessors(), mk_class_hash_accessors(),
    mk_class_scalar_accessors(), mk_concat_accessors(),
    mk_forward_accessors(), mk_hash_accessors(), mk_integer_accessors(),
    mk_new(), mk_object_accessors(), mk_scalar_accessors(),
    mk_set_accessors(), mk_singleton()

The superclass Class::Accessor defines these methods and functions:

    _carp(), _croak(), _mk_accessors(), accessor_name_for(),
    best_practice_accessor_name_for(), best_practice_mutator_name_for(),
    follow_best_practice(), get(), make_accessor(), make_ro_accessor(),
    make_wo_accessor(), mk_accessors(), mk_ro_accessors(),
    mk_wo_accessors(), mutator_name_for(), set()

The superclass Class::Accessor::Installer defines these methods and functions:

    install_accessor()

The superclass Data::Conveyor::Service::Interface defines these methods and functions:

    args(), args_clear(), args_delete(), args_exists(), args_keys(),
    args_values(), clear_args(), clear_svc(), delete_args(), exists_args(),
    keys_args(), svc(), svc_clear(), values_args()

The superclass Class::Scaffold::Storable defines these methods and functions:

    MUNGE_CONSTRUCTOR_ARGS(), clear_storage_info(), clear_storage_type(),
    delete_storage_info(), exists_storage_info(), id(),
    keys_storage_info(), storage(), storage_info(), storage_info_clear(),
    storage_info_delete(), storage_info_exists(), storage_info_keys(),
    storage_info_values(), storage_type(), storage_type_clear(),
    values_storage_info()

The superclass Class::Scaffold::Base defines these methods and functions:

    FIRST_CONSTRUCTOR_ARGS(), add_autoloaded_package()

The superclass Data::Comparable defines these methods and functions:

    comparable(), comparable_scalar(), dump_comparable(),
    prepare_comparable(), yaml_dump_comparable()

The superclass Class::Scaffold::Delegate::Mixin defines these methods and functions:

    delegate()

The superclass Class::Scaffold::Accessor defines these methods and functions:

    mk_framework_object_accessors(), mk_framework_object_array_accessors(),
    mk_readonly_accessors()

The superclass Class::Accessor::Constructor defines these methods and functions:

    _make_constructor(), mk_constructor(), mk_constructor_with_dirty(),
    mk_singleton_constructor()

The superclass Class::Accessor::FactoryTyped defines these methods and functions:

    clear_factory_typed_accessors(), clear_factory_typed_array_accessors(),
    count_factory_typed_accessors(), count_factory_typed_array_accessors(),
    factory_typed_accessors(), factory_typed_accessors_clear(),
    factory_typed_accessors_count(), factory_typed_accessors_index(),
    factory_typed_accessors_pop(), factory_typed_accessors_push(),
    factory_typed_accessors_set(), factory_typed_accessors_shift(),
    factory_typed_accessors_splice(), factory_typed_accessors_unshift(),
    factory_typed_array_accessors(), factory_typed_array_accessors_clear(),
    factory_typed_array_accessors_count(),
    factory_typed_array_accessors_index(),
    factory_typed_array_accessors_pop(),
    factory_typed_array_accessors_push(),
    factory_typed_array_accessors_set(),
    factory_typed_array_accessors_shift(),
    factory_typed_array_accessors_splice(),
    factory_typed_array_accessors_unshift(),
    index_factory_typed_accessors(), index_factory_typed_array_accessors(),
    mk_factory_typed_accessors(), mk_factory_typed_array_accessors(),
    pop_factory_typed_accessors(), pop_factory_typed_array_accessors(),
    push_factory_typed_accessors(), push_factory_typed_array_accessors(),
    set_factory_typed_accessors(), set_factory_typed_array_accessors(),
    shift_factory_typed_accessors(), shift_factory_typed_array_accessors(),
    splice_factory_typed_accessors(),
    splice_factory_typed_array_accessors(),
    unshift_factory_typed_accessors(),
    unshift_factory_typed_array_accessors()

The superclass Class::Scaffold::Factory::Type defines these methods and functions:

    factory_log()

The superclass Class::Factory::Enhanced defines these methods and functions:

    add_factory_type(), make_object_for_type(), register_factory_type()

The superclass Class::Factory defines these methods and functions:

    factory_error(), get_factory_class(), get_factory_type_for(),
    get_loaded_classes(), get_loaded_types(), get_my_factory(),
    get_my_factory_type(), get_registered_class(),
    get_registered_classes(), get_registered_types(),
    remove_factory_type(), unregister_factory_type()

The superclass Class::Accessor::Constructor::Base defines these methods and functions:

    STORE(), clear_dirty(), clear_hygienic(), clear_unhygienic(),
    contains_hygienic(), contains_unhygienic(), delete_hygienic(),
    delete_unhygienic(), dirty(), dirty_clear(), dirty_set(),
    elements_hygienic(), elements_unhygienic(), hygienic(),
    hygienic_clear(), hygienic_contains(), hygienic_delete(),
    hygienic_elements(), hygienic_insert(), hygienic_is_empty(),
    hygienic_size(), insert_hygienic(), insert_unhygienic(),
    is_empty_hygienic(), is_empty_unhygienic(), set_dirty(),
    size_hygienic(), size_unhygienic(), unhygienic(), unhygienic_clear(),
    unhygienic_contains(), unhygienic_delete(), unhygienic_elements(),
    unhygienic_insert(), unhygienic_is_empty(), unhygienic_size()

The superclass Tie::StdHash defines these methods and functions:

    CLEAR(), DELETE(), EXISTS(), FETCH(), FIRSTKEY(), NEXTKEY(), SCALAR(),
    TIEHASH()

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests through the web interface at http://rt.cpan.org.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHORS

Florian Helmberger <fh@univie.ac.at>

Achim Adam <ac@univie.ac.at>

Mark Hofstetter <mh@univie.ac.at>

Heinz Ekker <ek@univie.ac.at>

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2004-2008 by the authors.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.