/ 
DTS-0.01-1
/ DTS::Task

NAME

DTS::Task - a Perl base class to access Microsoft SQL Server 2000 DTS tasks

SYNOPSIS

use DTS::Task;

# $task is an already instantied class using Win32::OLE
my $custom_task = DTS::Task->new( $task->CustomTaskID, $task->CustomTask );

# prints the custom task name
print $custom_task->get_name, "\n";

DESCRIPTION

DTS::Task is an base class to be subclassed: one should not use it directly (although it may work). See SEE ALSO for more information about the classed that uses DTS::Task as part of their inheritance.

EXPORT

None by default.

METHODS

new

Creates a new DTS::Task object. It should be overrided by subclasses, since it defines only general attributes. Expects a DTS Task object. Returns a new DTS::Task object.

One should not invoke this method directly, unless wants to extended the DTS API. See DTS::Package for more information about how to fetch DTS::Task objects easialy.

get_name

Returns a string with the name of the task.

get_description

Returns a string with the description of the task.

get_type

Returns a string of type of the task.

get_properties

Not implemented. Some tasks fetch their properties in a different manner. Use this method only in subclasses from DTS::Task.

If this method is not override in subclasses it will cause the application to die.

Once overrided this method should return an array reference with all properties from the respective DTS::Task subclass.

to_string

Not implemented. Some tasks fetch their properties in a different manner. Use this method only in subclasses from DTS::Task.

If this method is not override in subclasses it will cause the application to die. Once overrided, it will fetch and return a string with all properties in a nicely manner for printing.

SEE ALSO

  • Win32::OLE at perldoc.

  • DTS::Package at perldoc to see how to fetch DTS::Task objects.

  • DTS::TaskFactory at perldoc to see how to instantiate new objects from DTS::Task subclasses in a polymorphic way.

  • 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, <glasswalk3r@yahoo.com.br>

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.