com.technia.tif.enovia.job.executors.file

Class FileAction

java.lang.Object

com.technia.tif.core.util.LockSupport

com.technia.tif.enovia.job.executors.file.FileAction

All Implemented Interfaces:

com.technia.common.xml.XMLReadable, com.technia.tif.core.Lockable

@API
public abstract class FileAction
extends com.technia.tif.core.util.LockSupport
implements com.technia.common.xml.XMLReadable

Since:

2015.3.0

Constructor Summary

Constructors

Constructor and Description
FileAction()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFileName()
protected java.lang.String	getFileName(FileActionContext ctx)
java.lang.String	getFormat()
protected boolean	handleElement(com.technia.common.xml.XMLReader reader, java.lang.String elementName)
void	initialize(com.technia.common.xml.XMLReader reader)
protected void	initializeCheckin(com.technia.common.xml.XMLReader reader) Parses Checkin element.
boolean	isOverwritePreviousVersion()
protected abstract FileActionResult	process(FileActionContext ctx)
protected java.io.File	processCheckin(FileActionContext ctx, java.io.File fileToCheckin) This method will, if configured, check in the file to ENOVIA.
void	setCheckinAction(CheckinAction checkinAction)
void	setFileName(java.lang.String fileName)
void	setFormat(java.lang.String format)
void	setOverwritePreviousVersion(boolean overwritePreviousVersion)
java.lang.String	toString()

Methods inherited from class com.technia.tif.core.util.LockSupport

ensureModifiable, isLocked, lock

Methods inherited from class java.lang.Object

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

Constructor Detail

FileAction

public FileAction()

Method Detail

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

getFormat

public java.lang.String getFormat()

setFormat

public void setFormat(java.lang.String format)

isOverwritePreviousVersion

public boolean isOverwritePreviousVersion()

setOverwritePreviousVersion

public void setOverwritePreviousVersion(boolean overwritePreviousVersion)

setCheckinAction

public void setCheckinAction(CheckinAction checkinAction)

process

protected abstract FileActionResult process(FileActionContext ctx)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

processCheckin

protected java.io.File processCheckin(FileActionContext ctx,
                                      java.io.File fileToCheckin)
                               throws java.lang.Exception

This method will, if configured, check in the file to ENOVIA. If no checkin have been requested, the original file as given as input is returned.

Parameters:

ctx - The current context

Returns:

The file to be used for further processing

Throws:

java.lang.Exception

getFileName

protected java.lang.String getFileName(FileActionContext ctx)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

initializeCheckin

protected void initializeCheckin(com.technia.common.xml.XMLReader reader)
                          throws com.technia.common.xml.XMLException

Parses Checkin element.

Parameters:

reader - XML Reader

Throws:

com.technia.common.xml.XMLException

Since:

2015.3.0

initialize

public void initialize(com.technia.common.xml.XMLReader reader)
                throws com.technia.common.xml.XMLException

Specified by:

initialize in interface com.technia.common.xml.XMLReadable

Throws:

com.technia.common.xml.XMLException

handleElement

protected boolean handleElement(com.technia.common.xml.XMLReader reader,
                                java.lang.String elementName)
                         throws com.technia.common.xml.XMLException

Throws:

com.technia.common.xml.XMLException