com.taleo.integration.client.customstep
Class BaseCustomStep

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
All Implemented Interfaces:
com.taleo.integration.client.step.CustomStep, com.taleo.integration.client.step.Step
Direct Known Subclasses:
AbstractXslStep, BaseCustomCsvStep, BaseFtpStep, BaseSftpStep, ConvertToCountPreStep, DailyCountPreStep, ExportCountPostStep, ExtractAttachedFilePostStep, ExtractFilesPostStep, FilterExportErrorPostStep, HttpPostPostStep, LRDPostStep, LRDPreStep, PagingPostStep, PagingPreStep, RaiseExportErrorPostStep, ReplaceSymbolsInQueryPreStep, SelectPreStep, SendEmailPostStep, SendEmailsPostStep, SplitFilePostStep, StripInvalidXMLCharsStep, ZipPostStep

public abstract class BaseCustomStep
extends com.taleo.integration.client.step.BaseCustomStep

Abstract custom step.

This step takes three parameters:

Author:
Romain Guay, Taleo Corporation

Field Summary
protected  java.util.List parameterNames
          The list of valid parameter names.
 
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
BaseCustomStep()
          Constructor without arguments.
 
Method Summary
protected  java.io.File createTempFile()
          Create a temporary file with the default "IntegrationClient" prefix.
protected  java.io.File createTempFile(java.lang.String prefix)
          Create a temporary file with the specified prefix.
 java.lang.String getEncoding()
          Get the encoding.
protected  java.io.File getTempFolder()
          Get the temporary folder, defaulting to User temp folder.
 void init(com.taleo.ws.integration.client.GlobalConfig config)
           
 boolean isActive()
          Get the active flag.
protected  void registerParameterName(java.lang.String name)
          Register a valid parameter name.
 void setActive(boolean active)
          Set the active flag.
 void setEncoding(java.lang.String encoding)
          Set the encoding.
protected  void validateParameterNames()
          Validate the parameters names.
 
Methods inherited from class com.taleo.integration.client.step.BaseCustomStep
getDescription, getIdentifier, getName, getSupportedPipeline, 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
execute, validatePipeline
 

Field Detail

parameterNames

protected java.util.List parameterNames
The list of valid parameter names.

Constructor Detail

BaseCustomStep

public BaseCustomStep()
Constructor without arguments.

Method Detail

isActive

public boolean isActive()
Get the active flag.

Returns:

setActive

public void setActive(boolean active)
Set the active flag.

Parameters:
active -

getEncoding

public java.lang.String getEncoding()
Get the encoding.

Returns:

setEncoding

public void setEncoding(java.lang.String encoding)
Set the encoding.

Parameters:
encoding -

init

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

registerParameterName

protected void registerParameterName(java.lang.String name)
Register a valid parameter name.

Parameters:
name - The name of a valid parameter.

validateParameterNames

protected void validateParameterNames()
Validate the parameters names.


createTempFile

protected java.io.File createTempFile()
                               throws java.io.IOException
Create a temporary file with the default "IntegrationClient" prefix.

Returns:
Throws:
java.io.IOException

createTempFile

protected java.io.File createTempFile(java.lang.String prefix)
                               throws java.io.IOException
Create a temporary file with the specified prefix.

Parameters:
prefix -
Returns:
Throws:
java.io.IOException

getTempFolder

protected java.io.File getTempFolder()
Get the temporary folder, defaulting to User temp folder.

Returns: