org.kuali.ole.sys.context

Class BatchStepFileDescriptor

java.lang.Object

org.kuali.ole.sys.context.BatchStepFileDescriptor

public class BatchStepFileDescriptor
extends Object

BatchStepFileDescriptor contains the properties of a batch step file (name of the job, name of the step, and the file type extension). The index of the step, the start time/date, and the completion time/date of the step can also be stored.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STEP_FILE_EXTENSION_SEPARATOR
static String	STEP_FILE_NAME_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
BatchStepFileDescriptor(File stepFile)
BatchStepFileDescriptor(String jobName, String stepName, String extension) Create a descriptor using the properties provided.

Method Summary

Methods

Modifier and Type	Method and Description
Date	getCompletedDate()
String	getExtension()
static String	getFileExtensionError()
static String	getFileExtensionRun()
static String	getFileExtensionSuccess()
String	getJobName()
String	getName()
String	getNameNoExtension()
Date	getStartedDate()
File	getStepFile()
Integer	getStepIndex()
String	getStepName()
boolean	isStepFileAnErrorResultFile()
void	setCompletedDate(Date completedDate)
void	setStartedDate(Date startedDate)
void	setStepIndex(Integer stepIndex)
String	toString() Return a representation of the step file descriptor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STEP_FILE_EXTENSION_SEPARATOR

public static final String STEP_FILE_EXTENSION_SEPARATOR

See Also:

Constant Field Values

STEP_FILE_NAME_SEPARATOR

public static final String STEP_FILE_NAME_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

BatchStepFileDescriptor

public BatchStepFileDescriptor(String jobName,
                       String stepName,
                       String extension)

Create a descriptor using the properties provided. getStepFile() will return null when this constructor is used. This constructor is used to provide the details about a semaphore file to look for in the directory.

Parameters:

jobName - the name of the job in which the step is running

stepName - the name of the step to be executed

extension - the type of file to work with (RUN, SUCCESS, or ERROR)

BatchStepFileDescriptor

public BatchStepFileDescriptor(File stepFile)

Parameters:

stepFile - the semaphore file in the directory. The jobName, stepName, and extension are retrieved from the semaphore file name.

Method Detail

getJobName

public String getJobName()

Returns:

the name of the job in which the step is running

getStepName

public String getStepName()

Returns:

the name of the step being executed

getExtension

public String getExtension()

Returns:

the extension of the semaphore file

getStepFile

public File getStepFile()

Returns:

the semaphore file in the directory

getName

public String getName()

Returns:

the name of the file with the extension (jobName~stepName.extension)

getNameNoExtension

public String getNameNoExtension()

Returns:

the name of the file without an extension (jobName~stepName)

toString

public String toString()

Return a representation of the step file descriptor. STEP and the stepIndex are only printed if the stepIndex is not null.

Overrides:

toString in class Object

Returns:

[jobName] STEP[stepIndex]-[stepName] or [jobName] [stepName]

isStepFileAnErrorResultFile

public boolean isStepFileAnErrorResultFile()

Returns:

true if the semaphore file is an ERROR file, false otherwise

getStepIndex

public Integer getStepIndex()

Returns:

the index of the step in its job

setStepIndex

public void setStepIndex(Integer stepIndex)

Parameters:

stepIndex - the index of the step in its job

getStartedDate

public Date getStartedDate()

Returns:

the time the step started

setStartedDate

public void setStartedDate(Date startedDate)

Parameters:

startedDate - the time the step started

getCompletedDate

public Date getCompletedDate()

Returns:

the time the step completed

setCompletedDate

public void setCompletedDate(Date completedDate)

Parameters:

completedDate - the time the step completed

getFileExtensionRun

public static String getFileExtensionRun()

Returns:

the extension for the RUN file

getFileExtensionSuccess

public static String getFileExtensionSuccess()

Returns:

the extension for the SUCCESS file

getFileExtensionError

public static String getFileExtensionError()

Returns:

the extension for the ERROR file