com.taleo.integration.client.customstep.count
Class DailyCountPreStep

java.lang.Object
  extended by com.taleo.integration.client.step.BaseStep
      extended by com.taleo.integration.client.step.BaseCustomStep
          extended by com.taleo.integration.client.customstep.BaseCustomStep
              extended by com.taleo.integration.client.customstep.count.DailyCountPreStep
All Implemented Interfaces:
com.taleo.integration.client.step.CustomStep, com.taleo.integration.client.step.Step

public class DailyCountPreStep
extends BaseCustomStep

Pre-processing step interrupt execution when a given maximum of records has been extracted on the current day.

The record count is not global to the zone, it is specific to this instance and the count filename provided as parameter.

This pre-processing step works in pair with ExportCountPostStep. It uses the count that this step has stored on disk to determine if the maximum has been reached.

This step takes all parameters from its base class BaseCustomStep and the following additional parameters:

When the maximum is reached, the process exits abruptly with code 1. All subsequent steps are then ignored. The exit code can be set differently using the system property named com.taleo.client.customstep.DailyCountPreStep.MaximumExitCode.

Note: Exiting with a specific code is currently the only option to end TCC on demand. The down side is that the monitoring file remains incomplete and some temporary files for that run are not deleted.

Here is an example of how to define this custom step in the TCC configuration file:

Author:
Romain Guay, Taleo Corporation

Field Summary
protected  int maximumCount
          The maximum count.
 
Fields inherited from class com.taleo.integration.client.customstep.BaseCustomStep
parameterNames
 
Fields inherited from class com.taleo.integration.client.step.BaseCustomStep
parameters
 
Fields inherited from class com.taleo.integration.client.step.BaseStep
commType, ERROR_NULL_GLOBAL_CONFIG, ERROR_NULL_PIPELINE, ERROR_NULL_STEP_CONFIG, productCode, tempFolder, type, version
 
Constructor Summary
DailyCountPreStep()
          Constructor without arguments.
 
Method Summary
 void execute(com.taleo.ws.integration.client.Pipeline pipeline)
           
 java.lang.String getCountFilename()
          Get the count filename.
 java.lang.String getDescription()
           
 java.lang.String getIdentifier()
           
 int getMaximumCount()
          Get the maximum count.
 java.lang.String getName()
           
 com.taleo.ws.integration.client.SupportedPipeline getSupportedPipeline()
           
 void init(com.taleo.ws.integration.client.GlobalConfig config)
           
 void setCountFilename(java.lang.String countFilename)
          Set the count filename.
 void setMaximumCount(int maximumCount)
          Set the maximum count.
 
Methods inherited from class com.taleo.integration.client.customstep.BaseCustomStep
createTempFile, createTempFile, getEncoding, getTempFolder, isActive, registerParameterName, setActive, setEncoding, validateParameterNames
 
Methods inherited from class com.taleo.integration.client.step.BaseCustomStep
getType, init
 
Methods inherited from class com.taleo.integration.client.step.BaseStep
getAllProcessSupportPipeline, getCurrentFile, getCurrentFile, getCurrentMessage, getPostProcessSupportPipeline, getPreProcessSupportPipeline, isOriginalFile, validateLastStepType, validateMessageType, validatePipeline
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.taleo.integration.client.step.Step
validatePipeline
 

Field Detail

maximumCount

protected int maximumCount
The maximum count.

Constructor Detail

DailyCountPreStep

public DailyCountPreStep()
Constructor without arguments.

Method Detail

getIdentifier

public java.lang.String getIdentifier()
Specified by:
getIdentifier in interface com.taleo.integration.client.step.CustomStep
Specified by:
getIdentifier in interface com.taleo.integration.client.step.Step
Specified by:
getIdentifier in class com.taleo.integration.client.step.BaseCustomStep

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface com.taleo.integration.client.step.CustomStep
Specified by:
getDescription in interface com.taleo.integration.client.step.Step
Specified by:
getDescription in class com.taleo.integration.client.step.BaseCustomStep

getName

public java.lang.String getName()
Specified by:
getName in interface com.taleo.integration.client.step.CustomStep
Specified by:
getName in interface com.taleo.integration.client.step.Step
Specified by:
getName in class com.taleo.integration.client.step.BaseCustomStep

getMaximumCount

public int getMaximumCount()
Get the maximum count.

Returns:

setMaximumCount

public void setMaximumCount(int maximumCount)
Set the maximum count.


getCountFilename

public java.lang.String getCountFilename()
Get the count filename.

Returns:

setCountFilename

public void setCountFilename(java.lang.String countFilename)
Set the count filename.

Parameters:
countFilename -

getSupportedPipeline

public com.taleo.ws.integration.client.SupportedPipeline getSupportedPipeline()
Specified by:
getSupportedPipeline in interface com.taleo.integration.client.step.Step
Overrides:
getSupportedPipeline in class com.taleo.integration.client.step.BaseCustomStep

init

public void init(com.taleo.ws.integration.client.GlobalConfig config)
Overrides:
init in class BaseCustomStep

execute

public void execute(com.taleo.ws.integration.client.Pipeline pipeline)
             throws com.taleo.integration.client.step.StepException
Throws:
com.taleo.integration.client.step.StepException