Bundesamt für Sicherheit in der Informationstechnik > Dicop-Server-3.04 > Dicop::Data::Result

Download:
dicop/Dicop-Server-3.04.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Module Version: 1.03   Source  

NAME ^

Dicop::Data::Result - a result for a job

SYNOPSIS ^

    use Dicop::Data::Result;

REQUIRES ^

perl5.005, Exporter, Dicop, Dicop::Item

EXPORTS ^

Exports nothing on default.

DESCRIPTION ^

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

METHODS ^

get_as_string

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

        $result->get_as_string('client_name');

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:

        $result->get_as_hex('client_name');

get

Return the value of a specified field of the object:

        $result->geT('client_name');

change

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 ^

(c) Bundesamt fuer Sicherheit in der Informationstechnik 1998-2006

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.