/ 
DTS-0.04
/ DTS::Assignment

NAME

DTS::Assignment - a Perl base class to represent a DTS Dynamic Properties task Assignment object

SYNOPSIS

package DTS::Assignment::SomethingWeird;
use base (DTS::Assignment);

#and goes on defining the child class

DESCRIPTION

DTS::Assignment is a base class that should be inherited by a specialized class that defines one type of Assignment object that is part of a DTS Dynamic Property task.

This class defines some common attributes that a subclass of DTS::Assignment. Some methods must be override too, and are explained in the next sections.

EXPORT

None by default.

METHODS

new

Instantiates a new DTS::Assigment object. Expects as parameter a DynamicPropertiesTaskAssignment object. Unless you want to extend the DTS::Assignment class, you will want to fetch DTS::Assignment objects using the get_properties method from DTS::Task::DynamicProperty class.

get_type

Returns the type as a numeric code for a instantied object of a subclass of DTS::Assignment.

get_type_name

Returns a type as a string converted from the original numeric code using DTS::AssignmentTypes abstract class to make the convertion.

get_source

This method should be override by any subclass of DTS::Assignment. If invoked but not overrided, it will abort program execution with an error message.

get_destination

Returns a DTS::Assignment::Destination object. See DTS::Assignment::Destination for more details about how to use Destination objects.

A DTS::Assignment::Destination object is not part of the official MS SQL Server DTS API, but is easier to use and do not use Win32::OLE directly (so there are no great performance penalties).

set_destination

Sets the Destination string in the assignment (in other words, it writes directly in the DTS package). To be able to invoke this method, the DTS::Assignment should not have invoke the kill_sibling method before, since writing the DTS package requires having the _sibling attribute defined.

The method will check such condition and will abort program execution in such cases.

Once the string is modified successfully in the package, the DTS::Assignment::Destination will be modified as well (a new instance will be created).

get_properties

Returns all properties from an assignment object as a hash reference, having the following keys:

  • type

  • source

  • destination

Since the method get_source must be overrided by subclasses of DTS::Assignment, get_properties will fail unless invoked thru one of those subclasses.

to_string

Returns a string with the type, source and destination of an assignment. Useful for debugging or reporting.

SEE ALSO

  • Win32::OLE at perldoc.

  • DTS::AssignmentFactory at perldoc.

  • DTS::Assignment::Destination and all subclasses of it at perldoc.

  • MSDN on Microsoft website and MS SQL Server 2000 Books Online are a reference about using DTS' object hierarchy, but one will need to convert examples written in VBScript to Perl code.

AUTHOR

Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2006 by Alceu Rodrigues de Freitas Junior

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.