Skip navigation links

Thor.API.Operations
Interface tcSchedulerOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcSchedulerOperationsIntf

extends tcUtilityOperationsIntf

Method Summary

long	addScheduleTaskAttribute(long scheduledTaskKey, java.util.Map attributes) Adds schedule task attribute against a give task key with information based on the attribute that are passed to this method
long	createScheduleTask(java.util.Map phAttributes) Create a schedule task with the list of specified attributes.
void	deleteScheduleTask(long scheduleTaskKey) Deletes a specified schedule task.
void	deleteScheduleTaskAttribute(long taskAttributeKey) Deletes a specified schedule task attribute
Thor.API.tcResultSet	findScheduleTaskAttributes(java.util.Map phAttributeList) Returns a list of schedule task attributes with detail (in the form of a tcResultSet) that matches the provided attribute list.
Thor.API.tcResultSet	findScheduleTaskClassesFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) Returns a list of scheduled task classes (in the form of a list of tcDataRecord) in ascending order that matches the provided attribute list.
Thor.API.tcResultSet	findScheduleTasks(java.util.Map phAttributeList) Returns a list of schedule task with detail (in the form of a tcResultSet) that matches the provided attribute list.
Thor.API.tcResultSet	getScheduleTaskAttributes(long scheduleTaskKey) Returns a list of Schedule Task Attributes (in the form of a tcResultSet) that are associated with the specified Schedule Task
void	updateScheduleTask(long scheduledTaskKey, java.util.Map attributes) Updates schedule task information based on the attribute that are passed to this method
void	updateScheduleTaskAttribute(long scheduledTaskKey, long taskAttributeKey, java.util.Map attributes) Updates schedule task attribute information based on the attribute that are passed to this method

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Detail

updateScheduleTask

void updateScheduleTask(long scheduledTaskKey,
                        java.util.Map attributes)
                        throws tcAPIException,
                               tcScheduledTaskNotFoundException,
                               tcInvalidAttributeException,
                               tcAttributeMissingException,
                               tcAPIException

Updates schedule task information based on the attribute that are passed to this method

Parameters:

scheduledTaskKey - the scheduled task key

attributes - a map of updated attributes valid attributes

• Task Scheduler.ClassName
• Task Scheduler.Disable
• Task Scheduler.Frequency Type
• Task Scheduler.Interval
• Task Scheduler.Key
• Task Scheduler.Last Start Time
• Task Scheduler.Last Stop Time
• Task Scheduler.Max Retries
• Task Scheduler.Name
• Task Scheduler.Next Start Time
• Task Scheduler.Retry Count
• Task Scheduler.Start Time
• Task Scheduler.Status

Throws:

tcAPIException

tcScheduledTaskNotFoundException

tcInvalidAttributeException

tcAttributeMissingException

Since:

9.1

updateScheduleTaskAttribute

void updateScheduleTaskAttribute(long scheduledTaskKey,
                                 long taskAttributeKey,
                                 java.util.Map attributes)
                                 throws tcAPIException,
                                        tcScheduledTaskNotFoundException,
                                        tcNoSuchTaskAttributeException,
                                        tcAPIException

Updates schedule task attribute information based on the attribute that are passed to this method

Parameters:

scheduledTaskKey - the scheduled task key

taskAttributeKey - the scheduled task attribute key

attributes - a map of updated attributes valid attributes

• Task Scheduler.Task Attributes.Name
• Task Scheduler.Task Attributes.Value

Throws:

tcAPIException

tcScheduledTaskNotFoundException

tcNoSuchTaskAttributeException

Since:

9.1

getScheduleTaskAttributes

Thor.API.tcResultSet getScheduleTaskAttributes(long scheduleTaskKey)
                                               throws tcAPIException,
                                                      tcScheduledTaskNotFoundException,
                                                      tcAPIException

Returns a list of Schedule Task Attributes (in the form of a tcResultSet) that are associated with the specified Schedule Task

Parameters:

scheduleTaskName - The name of the schedule task whose Task Attributes are to be retrieved

Returns:

A tcResultSet in which each row holds details about the Task Attributes

Throws:

tcAPIException

tcScheduledTaskNotFoundException

Since:

9.1.0.0

createScheduleTask

long createScheduleTask(java.util.Map phAttributes)
                        throws tcAPIException,
                               tcAttributeMissingException,
                               DuplicateScheduleTaskException,
                               tcInvalidAttributeException,
                               tcAPIException

Create a schedule task with the list of specified attributes.

Parameters:

phAttributes - - The attributes to set for the new schedule task being created valid attributes

• Task Scheduler.ClassName
• Task Scheduler.Disable
• Task Scheduler.Frequency Type
• Task Scheduler.Interval
• Task Scheduler.Key
• Task Scheduler.Last Start Time
• Task Scheduler.Last Stop Time
• Task Scheduler.Max Retries
• Task Scheduler.Name
• Task Scheduler.Next Start Time
• Task Scheduler.Retry Count
• Task Scheduler.Start Time
• Task Scheduler.Status

Returns:

A long containing the key of the created schedule task

Throws:

tcAPIException - thrown if errors occur while saving

DuplicateScheduleTaskException - thrown if schedule task Name already exists

tcInvalidAttributeException - thrown if a schedule task key is provided as an attribute

tcAttributeMissingException

Since:

9.1

addScheduleTaskAttribute

long addScheduleTaskAttribute(long scheduledTaskKey,
                              java.util.Map attributes)
                              throws tcAPIException,
                                     tcInvalidAttributeException,
                                     DuplicateScheduleTaskAttributeException,
                                     tcAPIException

Adds schedule task attribute against a give task key with information based on the attribute that are passed to this method

Parameters:

scheduledTaskKey - the scheduled task key

attributes - a map of updated attributes

• Task Scheduler.Task Attributes.Name
• Task Scheduler.Task Attributes.Value

Returns:

A long containing the key of the created schedule task attribute

Throws:

tcAPIException

tcInvalidAttributeException

DuplicateScheduleTaskAttributeException

Since:

9.1

findScheduleTasks

Thor.API.tcResultSet findScheduleTasks(java.util.Map phAttributeList)
                                       throws tcAPIException,
                                              tcAPIException

Returns a list of schedule task with detail (in the form of a tcResultSet) that matches the provided attribute list.

Parameters:

phAttributeList - The map of schedule task search criteria valid attributes

• Task Scheduler.Key
• Task Scheduler.ClassName
• Task Scheduler.Disable
• Task Scheduler.Frequency Type
• Task Scheduler.Interval
• Task Scheduler.Key
• Task Scheduler.Last Start Time
• Task Scheduler.Last Stop Time
• Task Scheduler.Max Retries
• Task Scheduler.Name
• Task Scheduler.Next Start Time
• Task Scheduler.Retry Count
• Task Scheduler.Start Time
• Task Scheduler.Status

Returns:

A tcResultSet in which each row holds details about the schedule task that were found

Throws:

tcAPIException

Since:

9.1

findScheduleTaskAttributes

Thor.API.tcResultSet findScheduleTaskAttributes(java.util.Map phAttributeList)
                                                throws tcAPIException,
                                                       tcAPIException

Returns a list of schedule task attributes with detail (in the form of a tcResultSet) that matches the provided attribute list.

Parameters:

phAttributeList - The map of attribute to be search

• Task Scheduler.Task Attributes.Key
• Task Scheduler.Task Attributes.Name
• Task Scheduler.Task Attributes.Value

Returns:

A tcResultSet in which each row holds details about the schedule task attribute that were found

Throws:

tcAPIException

Since:

9.1

deleteScheduleTaskAttribute

void deleteScheduleTaskAttribute(long taskAttributeKey)
                                 throws tcAPIException,
                                        tcNoSuchTaskAttributeException,
                                        tcAPIException

Deletes a specified schedule task attribute

Parameters:

taskAttributeKey - the task attribute key to delete

Throws:

tcAPIException

tcNoSuchTaskAttributeException

Since:

9.1

deleteScheduleTask

void deleteScheduleTask(long scheduleTaskKey)
                        throws tcAPIException,
                               tcScheduledTaskNotFoundException,
                               tcAPIException

Deletes a specified schedule task.

Parameters:

scheduleTaskKey - the task attribute key to delete

Throws:

tcAPIException

tcScheduledTaskNotFoundException

Since:

9.1

findScheduleTaskClassesFiltered

Thor.API.tcResultSet findScheduleTaskClassesFiltered(java.util.Map phAttributeList,
                                                     java.lang.String[] pasFieldList)
                                                     throws tcAPIException,
                                                            tcInvalidAttributeException,
                                                            tcAPIException

Returns a list of scheduled task classes (in the form of a list of tcDataRecord) in ascending order that matches the provided attribute list.

Parameters:

phAttributeList - An array of tcMapping objects, each object holding the attribute-value pairs to match the group against. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes to base the search on. The values could include wild cards (*). valid attributes

• Task Scheduler.ClassName

pasFieldList - The list of fields (specified as column codes from the Xellerate metadata) that should be in the returned result set.

Returns:

A tcResultSet in which each row holds details about the scheduled task classes that were found

Throws:

tcAPIException

tcInvalidAttributeException

Since:

9.1

Skip navigation links