NAME

Dicop::Data::Case - a container to group jobs in the Dicop system

SYNOPSIS

        use Dicop::Data::Case;
        use Dicop::Data::Job;

        my $case = Dicop::Data::Case->new ( $case_options );
        my $job = Dicop::Data::Job->new ( $job_options );

REQUIRES

perl5.008001, Exporter, Data::Item

EXPORTS

Exports nothing.

DESCRIPTION

Each job belongs to exactly one case. After loading the case number on the job is converted to a reference to the case itself.

For a description of the fields a case has, see doc/Objects.pod.

METHODS

get_as_string

Return a field of the object as an ASCII string suitable for HTML output:

        $object->get_as_string('foo');

get_as_hex

Return a field of the object as an hexified string, or as a fallback, as normal string via get_as_string. The hexify happens only for certain special fields, all other are returned as simple strings:

        $object->get_as_hex('foo');

get

Return the value of a specified field of the object:

        $object->get('foo');

Change a field's value after checking that the field can be changed (via can_change) and checking the new value. If the new value does not conform to the expected format, it will be silently modifed (f.i. invalid characters might be removed) and then the change will happen:

        $object->change('foo','bar');   # will change $object->{foo} to bar
                                        # if foo can be changed

can_change

Return true if the field's value can be changed.

        die ("Can not change field $field\n") if !$object->can_change($field);

BUGS

None known yet.

AUTHOR

DiCoP is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

See http://www.bsi.de/ for more information.

CPAN RT