com.simplifiedlogic.nitro.util

Class WorkspaceFileLooper

java.lang.Object

com.simplifiedlogic.nitro.util.WorkspaceFileLooper

public abstract class WorkspaceFileLooper
extends java.lang.Object

This is an abstract class which loops over the files in a Windchill workspace.

Field Summary

Fields

Modifier and Type	Field and Description
static com.ptc.pfc.pfcSession.FileListOpt	LIST_OPT

Constructor Summary

Constructors

Constructor and Description
WorkspaceFileLooper()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getNamePattern()
java.lang.String	getServerAlias()
CallSession	getSession()
java.lang.String	getWorkspace()
void	loop()
abstract boolean	loopAction(java.lang.String fileName) Abstract function which is called for each file which matches the filters.
void	setNamePattern(java.lang.String namePattern)
void	setServerAlias(java.lang.String serverAlias)
void	setSession(CallSession session)
void	setWorkspace(java.lang.String workspace)

Methods inherited from class java.lang.Object

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

Field Detail

LIST_OPT

public static final com.ptc.pfc.pfcSession.FileListOpt LIST_OPT

Constructor Detail

WorkspaceFileLooper

public WorkspaceFileLooper()

Method Detail

loop

public void loop()
          throws JLIException,
                 com.ptc.cipjava.jxthrowable

Throws:

JLIException

com.ptc.cipjava.jxthrowable

loopAction

public abstract boolean loopAction(java.lang.String fileName)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

Abstract function which is called for each file which matches the filters. This must be implemented by a class extending this looper class.

Parameters:

fileName - The file name which matched the filters

Returns:

True to abort the loop, false to continue it

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getSession

public CallSession getSession()

Returns:

The Creo session

setSession

public void setSession(CallSession session)

Parameters:

session - The Creo session

getServerAlias

public java.lang.String getServerAlias()

Returns:

The Windchill server alias

setServerAlias

public void setServerAlias(java.lang.String serverAlias)

Parameters:

serverAlias - The Windchill server alias

getWorkspace

public java.lang.String getWorkspace()

Returns:

The Windchill workspace

setWorkspace

public void setWorkspace(java.lang.String workspace)

Parameters:

workspace - The Windchill workspace

getNamePattern

public java.lang.String getNamePattern()

setNamePattern

public void setNamePattern(java.lang.String namePattern)