Show
Ignore:
Timestamp:
07/25/08 23:01:37 (5 years ago)
Author:
hanekomu
Message:

continued to update distribution to standard style

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • lang/perl/Data-Conveyor/trunk/lib/Data/Conveyor/Environment.pm

    r10092 r16458  
    531531__END__ 
    532532 
    533 {% USE p = PodGenerated %} 
     533 
    534534 
    535535=head1 NAME 
    536536 
    537 {% p.package %} - stage-based conveyor-belt-like ticket handling system 
     537Data::Conveyor::Environment - stage-based conveyor-belt-like ticket handling system 
    538538 
    539539=head1 SYNOPSIS 
    540540 
    541     {% p.package %}->new; 
     541    Data::Conveyor::Environment->new; 
    542542 
    543543=head1 DESCRIPTION 
     
    550550=over 4 
    551551 
    552 {% p.write_methods %} 
     552=item clear_configurator 
     553 
     554    $obj->clear_configurator; 
     555 
     556Deletes the object. 
     557 
     558=item clear_control 
     559 
     560    $obj->clear_control; 
     561 
     562Deletes the object. 
     563 
     564=item configurator 
     565 
     566    my $object = $obj->configurator; 
     567    $obj->configurator($object); 
     568    $obj->configurator(@args); 
     569 
     570If called with an argument object of type Class::Scaffold::Environment::Configurator it sets the object; further 
     571arguments are discarded. If called with arguments but the first argument is 
     572not an object of type Class::Scaffold::Environment::Configurator, a new object of type Class::Scaffold::Environment::Configurator is constructed and the 
     573arguments are passed to the constructor. 
     574 
     575If called without arguments, it returns the Class::Scaffold::Environment::Configurator object stored in this slot; 
     576if there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     577are passed to the constructor in this case - and stored in the configurator slot 
     578before returning it. 
     579 
     580=item configurator_clear 
     581 
     582    $obj->configurator_clear; 
     583 
     584Deletes the object. 
     585 
     586=item control 
     587 
     588    my $object = $obj->control; 
     589    $obj->control($object); 
     590    $obj->control(@args); 
     591 
     592If called with an argument object of type Data::Conveyor::Control::File it sets the object; further 
     593arguments are discarded. If called with arguments but the first argument is 
     594not an object of type Data::Conveyor::Control::File, a new object of type Data::Conveyor::Control::File is constructed and the 
     595arguments are passed to the constructor. 
     596 
     597If called without arguments, it returns the Data::Conveyor::Control::File object stored in this slot; 
     598if there is no such object, a new Data::Conveyor::Control::File object is constructed - no arguments 
     599are passed to the constructor in this case - and stored in the control slot 
     600before returning it. 
     601 
     602=item control_clear 
     603 
     604    $obj->control_clear; 
     605 
     606Deletes the object. 
     607 
     608=item control_filename 
     609 
     610    $obj->control_filename(@args); 
     611    $obj->control_filename; 
     612 
     613Calls control_filename() with the given arguments on the object stored in the configurator slot. 
     614If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     615are passed to the constructor - and stored in the configurator slot before forwarding 
     616control_filename() onto it. 
     617 
     618=item default_object_limit 
     619 
     620    $obj->default_object_limit(@args); 
     621    $obj->default_object_limit; 
     622 
     623Calls default_object_limit() with the given arguments on the object stored in the configurator slot. 
     624If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     625are passed to the constructor - and stored in the configurator slot before forwarding 
     626default_object_limit() onto it. 
     627 
     628=item dispatcher_sleep 
     629 
     630    $obj->dispatcher_sleep(@args); 
     631    $obj->dispatcher_sleep; 
     632 
     633Calls dispatcher_sleep() with the given arguments on the object stored in the configurator slot. 
     634If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     635are passed to the constructor - and stored in the configurator slot before forwarding 
     636dispatcher_sleep() onto it. 
     637 
     638=item ignore_locks 
     639 
     640    $obj->ignore_locks(@args); 
     641    $obj->ignore_locks; 
     642 
     643Calls ignore_locks() with the given arguments on the object stored in the configurator slot. 
     644If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     645are passed to the constructor - and stored in the configurator slot before forwarding 
     646ignore_locks() onto it. 
     647 
     648=item lockpath 
     649 
     650    $obj->lockpath(@args); 
     651    $obj->lockpath; 
     652 
     653Calls lockpath() with the given arguments on the object stored in the configurator slot. 
     654If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     655are passed to the constructor - and stored in the configurator slot before forwarding 
     656lockpath() onto it. 
     657 
     658=item max_tickets_per_dispatcher 
     659 
     660    $obj->max_tickets_per_dispatcher(@args); 
     661    $obj->max_tickets_per_dispatcher; 
     662 
     663Calls max_tickets_per_dispatcher() with the given arguments on the object stored in the configurator slot. 
     664If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     665are passed to the constructor - and stored in the configurator slot before forwarding 
     666max_tickets_per_dispatcher() onto it. 
     667 
     668=item modular_config 
     669 
     670    $obj->modular_config(@args); 
     671    $obj->modular_config; 
     672 
     673Calls modular_config() with the given arguments on the object stored in the configurator slot. 
     674If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     675are passed to the constructor - and stored in the configurator slot before forwarding 
     676modular_config() onto it. 
     677 
     678=item mutex_storage_args 
     679 
     680    $obj->mutex_storage_args(@args); 
     681    $obj->mutex_storage_args; 
     682 
     683Calls mutex_storage_args() with the given arguments on the object stored in the configurator slot. 
     684If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     685are passed to the constructor - and stored in the configurator slot before forwarding 
     686mutex_storage_args() onto it. 
     687 
     688=item mutex_storage_name 
     689 
     690    $obj->mutex_storage_name(@args); 
     691    $obj->mutex_storage_name; 
     692 
     693Calls mutex_storage_name() with the given arguments on the object stored in the configurator slot. 
     694If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     695are passed to the constructor - and stored in the configurator slot before forwarding 
     696mutex_storage_name() onto it. 
     697 
     698=item respect_mutex 
     699 
     700    $obj->respect_mutex(@args); 
     701    $obj->respect_mutex; 
     702 
     703Calls respect_mutex() with the given arguments on the object stored in the configurator slot. 
     704If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     705are passed to the constructor - and stored in the configurator slot before forwarding 
     706respect_mutex() onto it. 
     707 
     708=item should_send_mail 
     709 
     710    $obj->should_send_mail(@args); 
     711    $obj->should_send_mail; 
     712 
     713Calls should_send_mail() with the given arguments on the object stored in the configurator slot. 
     714If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     715are passed to the constructor - and stored in the configurator slot before forwarding 
     716should_send_mail() onto it. 
     717 
     718=item soap_path 
     719 
     720    $obj->soap_path(@args); 
     721    $obj->soap_path; 
     722 
     723Calls soap_path() with the given arguments on the object stored in the configurator slot. 
     724If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     725are passed to the constructor - and stored in the configurator slot before forwarding 
     726soap_path() onto it. 
     727 
     728=item soap_server 
     729 
     730    $obj->soap_server(@args); 
     731    $obj->soap_server; 
     732 
     733Calls soap_server() with the given arguments on the object stored in the configurator slot. 
     734If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     735are passed to the constructor - and stored in the configurator slot before forwarding 
     736soap_server() onto it. 
     737 
     738=item soap_uri 
     739 
     740    $obj->soap_uri(@args); 
     741    $obj->soap_uri; 
     742 
     743Calls soap_uri() with the given arguments on the object stored in the configurator slot. 
     744If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     745are passed to the constructor - and stored in the configurator slot before forwarding 
     746soap_uri() onto it. 
     747 
     748=item ticket_provider_clause 
     749 
     750    $obj->ticket_provider_clause(@args); 
     751    $obj->ticket_provider_clause; 
     752 
     753Calls ticket_provider_clause() with the given arguments on the object stored in the configurator slot. 
     754If there is no such object, a new Class::Scaffold::Environment::Configurator object is constructed - no arguments 
     755are passed to the constructor - and stored in the configurator slot before forwarding 
     756ticket_provider_clause() onto it. 
    553757 
    554758=back 
    555759 
    556 {% p.write_inheritance %} 
    557  
    558 {% PROCESS standard_pod %} 
     760Data::Conveyor::Environment inherits from L<Class::Scaffold::Environment>. 
     761 
     762The superclass L<Class::Scaffold::Environment> defines these methods and 
     763functions: 
     764 
     765    all_storages_are_implemented(), clear_context(), 
     766    clear_multiplex_transaction_omit(), clear_rollback_mode(), 
     767    clear_storage_cache(), clear_test_mode(), commit(), context(), 
     768    context_clear(), core_storage(), core_storage_args(), 
     769    core_storage_name(), delete_multiplex_transaction_omit(), 
     770    delete_storage_cache(), disconnect(), 
     771    exists_multiplex_transaction_omit(), exists_storage_cache(), 
     772    gen_class_hash_accessor(), get_class_name_for(), 
     773    get_storage_type_for(), getenv(), isa_type(), 
     774    keys_multiplex_transaction_omit(), keys_storage_cache(), 
     775    load_cached_class_for_type(), make_delegate(), make_obj(), 
     776    make_storage_object(), memory_storage(), memory_storage_name(), 
     777    multiplex_transaction_omit(), multiplex_transaction_omit_clear(), 
     778    multiplex_transaction_omit_delete(), 
     779    multiplex_transaction_omit_exists(), multiplex_transaction_omit_keys(), 
     780    multiplex_transaction_omit_values(), rollback(), rollback_mode(), 
     781    rollback_mode_clear(), rollback_mode_set(), set_rollback_mode(), 
     782    setenv(), storage_cache(), storage_cache_clear(), 
     783    storage_cache_delete(), storage_cache_exists(), storage_cache_keys(), 
     784    storage_cache_values(), storage_for_type(), test_mode(), 
     785    test_mode_clear(), values_multiplex_transaction_omit(), 
     786    values_storage_cache() 
     787 
     788The superclass L<Class::Scaffold::Base> defines these methods and 
     789functions: 
     790 
     791    new(), FIRST_CONSTRUCTOR_ARGS(), MUNGE_CONSTRUCTOR_ARGS(), 
     792    add_autoloaded_package(), log() 
     793 
     794The superclass L<Data::Inherited> defines these methods and functions: 
     795 
     796    every_hash(), every_list(), flush_every_cache_by_key() 
     797 
     798The superclass L<Data::Comparable> defines these methods and functions: 
     799 
     800    comparable(), comparable_scalar(), dump_comparable(), 
     801    prepare_comparable(), yaml_dump_comparable() 
     802 
     803The superclass L<Class::Scaffold::Delegate::Mixin> defines these methods 
     804and functions: 
     805 
     806    delegate() 
     807 
     808The superclass L<Class::Scaffold::Accessor> defines these methods and 
     809functions: 
     810 
     811    mk_framework_object_accessors(), mk_framework_object_array_accessors(), 
     812    mk_readonly_accessors() 
     813 
     814The superclass L<Class::Accessor::Complex> defines these methods and 
     815functions: 
     816 
     817    mk_abstract_accessors(), mk_array_accessors(), mk_boolean_accessors(), 
     818    mk_class_array_accessors(), mk_class_hash_accessors(), 
     819    mk_class_scalar_accessors(), mk_concat_accessors(), 
     820    mk_forward_accessors(), mk_hash_accessors(), mk_integer_accessors(), 
     821    mk_new(), mk_object_accessors(), mk_scalar_accessors(), 
     822    mk_set_accessors(), mk_singleton() 
     823 
     824The superclass L<Class::Accessor> defines these methods and functions: 
     825 
     826    _carp(), _croak(), _mk_accessors(), accessor_name_for(), 
     827    best_practice_accessor_name_for(), best_practice_mutator_name_for(), 
     828    follow_best_practice(), get(), make_accessor(), make_ro_accessor(), 
     829    make_wo_accessor(), mk_accessors(), mk_ro_accessors(), 
     830    mk_wo_accessors(), mutator_name_for(), set() 
     831 
     832The superclass L<Class::Accessor::Installer> defines these methods and 
     833functions: 
     834 
     835    install_accessor() 
     836 
     837The superclass L<Class::Accessor::Constructor> defines these methods and 
     838functions: 
     839 
     840    _make_constructor(), mk_constructor(), mk_constructor_with_dirty(), 
     841    mk_singleton_constructor() 
     842 
     843The superclass L<Class::Accessor::FactoryTyped> defines these methods and 
     844functions: 
     845 
     846    clear_factory_typed_accessors(), clear_factory_typed_array_accessors(), 
     847    count_factory_typed_accessors(), count_factory_typed_array_accessors(), 
     848    factory_typed_accessors(), factory_typed_accessors_clear(), 
     849    factory_typed_accessors_count(), factory_typed_accessors_index(), 
     850    factory_typed_accessors_pop(), factory_typed_accessors_push(), 
     851    factory_typed_accessors_set(), factory_typed_accessors_shift(), 
     852    factory_typed_accessors_splice(), factory_typed_accessors_unshift(), 
     853    factory_typed_array_accessors(), factory_typed_array_accessors_clear(), 
     854    factory_typed_array_accessors_count(), 
     855    factory_typed_array_accessors_index(), 
     856    factory_typed_array_accessors_pop(), 
     857    factory_typed_array_accessors_push(), 
     858    factory_typed_array_accessors_set(), 
     859    factory_typed_array_accessors_shift(), 
     860    factory_typed_array_accessors_splice(), 
     861    factory_typed_array_accessors_unshift(), 
     862    index_factory_typed_accessors(), index_factory_typed_array_accessors(), 
     863    mk_factory_typed_accessors(), mk_factory_typed_array_accessors(), 
     864    pop_factory_typed_accessors(), pop_factory_typed_array_accessors(), 
     865    push_factory_typed_accessors(), push_factory_typed_array_accessors(), 
     866    set_factory_typed_accessors(), set_factory_typed_array_accessors(), 
     867    shift_factory_typed_accessors(), shift_factory_typed_array_accessors(), 
     868    splice_factory_typed_accessors(), 
     869    splice_factory_typed_array_accessors(), 
     870    unshift_factory_typed_accessors(), 
     871    unshift_factory_typed_array_accessors() 
     872 
     873The superclass L<Class::Scaffold::Factory::Type> defines these methods and 
     874functions: 
     875 
     876    factory_log() 
     877 
     878The superclass L<Class::Factory::Enhanced> defines these methods and 
     879functions: 
     880 
     881    add_factory_type(), make_object_for_type(), register_factory_type() 
     882 
     883The superclass L<Class::Factory> defines these methods and functions: 
     884 
     885    factory_error(), get_factory_class(), get_factory_type_for(), 
     886    get_loaded_classes(), get_loaded_types(), get_my_factory(), 
     887    get_my_factory_type(), get_registered_class(), 
     888    get_registered_classes(), get_registered_types(), 
     889    remove_factory_type(), unregister_factory_type() 
     890 
     891The superclass L<Class::Accessor::Constructor::Base> defines these methods 
     892and functions: 
     893 
     894    STORE(), clear_dirty(), clear_hygienic(), clear_unhygienic(), 
     895    contains_hygienic(), contains_unhygienic(), delete_hygienic(), 
     896    delete_unhygienic(), dirty(), dirty_clear(), dirty_set(), 
     897    elements_hygienic(), elements_unhygienic(), hygienic(), 
     898    hygienic_clear(), hygienic_contains(), hygienic_delete(), 
     899    hygienic_elements(), hygienic_insert(), hygienic_is_empty(), 
     900    hygienic_size(), insert_hygienic(), insert_unhygienic(), 
     901    is_empty_hygienic(), is_empty_unhygienic(), set_dirty(), 
     902    size_hygienic(), size_unhygienic(), unhygienic(), unhygienic_clear(), 
     903    unhygienic_contains(), unhygienic_delete(), unhygienic_elements(), 
     904    unhygienic_insert(), unhygienic_is_empty(), unhygienic_size() 
     905 
     906The superclass L<Tie::StdHash> defines these methods and functions: 
     907 
     908    CLEAR(), DELETE(), EXISTS(), FETCH(), FIRSTKEY(), NEXTKEY(), SCALAR(), 
     909    TIEHASH() 
     910 
     911=head1 BUGS AND LIMITATIONS 
     912 
     913No bugs have been reported. 
     914 
     915Please report any bugs or feature requests through the web interface at 
     916L<http://rt.cpan.org>. 
     917 
     918=head1 INSTALLATION 
     919 
     920See perlmodinstall for information and options on installing Perl modules. 
     921 
     922=head1 AVAILABILITY 
     923 
     924The latest version of this module is available from the Comprehensive Perl 
     925Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN 
     926site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>. 
     927 
     928=head1 AUTHORS 
     929 
     930Florian Helmberger C<< <fh@univie.ac.at> >> 
     931 
     932Achim Adam C<< <ac@univie.ac.at> >> 
     933 
     934Mark Hofstetter C<< <mh@univie.ac.at> >> 
     935 
     936Heinz Ekker C<< <ek@univie.ac.at> >> 
     937 
     938Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >> 
     939 
     940=head1 COPYRIGHT AND LICENSE 
     941 
     942Copyright 2004-2008 by the authors. 
     943 
     944This library is free software; you can redistribute it and/or modify 
     945it under the same terms as Perl itself. 
     946 
    559947 
    560948=cut