org.bimserver.longaction

Class LongAction<T extends LongActionKey>

java.lang.Object

org.bimserver.longaction.LongAction<T>

All Implemented Interfaces:

ProgressListener, org.bimserver.plugins.Reporter

Direct Known Subclasses:

LongBranchAction, LongCheckinAction, LongDownloadOrCheckoutAction, LongGenericAction, LongStreamingCheckinAction, LongStreamingDownloadAction

public abstract class LongAction<T extends LongActionKey>
extends Object
implements org.bimserver.plugins.Reporter, ProgressListener

Constructor Summary

Constructors

Constructor and Description
LongAction(BimServer bimServer, String username, String userUsername, Authorization authorization)

Method Summary

Modifier and Type	Method and Description
protected void	changeActionState(org.bimserver.models.store.ActionState actiontState, String title, int progress)
protected void	done()
void	error(Throwable error)
abstract void	execute()
void	fillState(org.bimserver.models.store.LongActionState ds)
org.bimserver.models.store.ActionState	getActionState()
Authorization	getAuthorization()
BimServer	getBimServer()
abstract String	getDescription()
List<String>	getErrors()
int	getProgress()
ProgressTopic	getProgressTopic()
GregorianCalendar	getStart()
org.bimserver.models.store.LongActionState	getState()
GregorianCalendar	getStop()
String	getUserName()
String	getUserUsername()
void	info(String info)
void	init()
void	setProgressTopic(ProgressTopic progressTopic)
void	stop()
void	terminate()
void	updateProgress(String title, int progress)
void	waitForCompletion()
void	warning(String warning)

Methods inherited from class java.lang.Object

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

Constructor Detail

LongAction

public LongAction(BimServer bimServer,
                  String username,
                  String userUsername,
                  Authorization authorization)

Method Detail

init

public void init()

setProgressTopic

public void setProgressTopic(ProgressTopic progressTopic)

getProgressTopic

public ProgressTopic getProgressTopic()

changeActionState

protected void changeActionState(org.bimserver.models.store.ActionState actiontState,
                                 String title,
                                 int progress)

getStop

public GregorianCalendar getStop()

getActionState

public org.bimserver.models.store.ActionState getActionState()

getUserUsername

public String getUserUsername()

getAuthorization

public Authorization getAuthorization()

getBimServer

public BimServer getBimServer()

getDescription

public abstract String getDescription()

execute

public abstract void execute()

getUserName

public String getUserName()

done

protected void done()

waitForCompletion

public void waitForCompletion()

getStart

public GregorianCalendar getStart()

updateProgress

public void updateProgress(String title,
                           int progress)

Specified by:

updateProgress in interface ProgressListener

terminate

public void terminate()

getProgress

public int getProgress()

fillState

public void fillState(org.bimserver.models.store.LongActionState ds)

getState

public org.bimserver.models.store.LongActionState getState()

getErrors

public List<String> getErrors()

error

public void error(Throwable error)

Specified by:

error in interface org.bimserver.plugins.Reporter

warning

public void warning(String warning)

Specified by:

warning in interface org.bimserver.plugins.Reporter

info

public void info(String info)

Specified by:

info in interface org.bimserver.plugins.Reporter

stop

public void stop()