Package org.yamcs.activities

Class Activity

java.lang.Object

org.yamcs.activities.Activity

All Implemented Interfaces:

Comparable<Activity>

public class Activity
extends Object
implements Comparable<Activity>

Constructor Summary

Constructors

Constructor	Description
Activity(UUID id, long start, int seq, String type, Map<String,Object> args, User startedBy)
Activity(Tuple tuple)

Method Summary

Modifier and Type	Method	Description
void	cancel(User user)
int	compareTo(Activity other)
void	complete(User user)	Stop a successful activity
void	completeExceptionally(String failureReason, User user)	Stop an activity.
Map<String,Object>	getArgs()
String	getComment()
String	getDetail()
String	getFailureReason()
UUID	getId()
int	getSeq()
long	getStart()
String	getStartedBy()
ActivityStatus	getStatus()
long	getStop()
String	getStoppedBy()
String	getType()
boolean	isStopped()
void	setComment(String comment)
void	setDetail(String detail)
void	setFailureReason(String failureReason)
void	setStatus(ActivityStatus status)
Tuple	toTuple()

Methods inherited from class java.lang.Object

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

Constructor Details

Activity

public Activity(UUID id,
 long start,
 int seq,
 String type,
 Map<String,Object> args,
 User startedBy)

Activity

public Activity(Tuple tuple)

Method Details

getId

public UUID getId()

getStatus

public ActivityStatus getStatus()

setStatus

public void setStatus(ActivityStatus status)

getStart

public long getStart()

getSeq

public int getSeq()

getType

public String getType()

getArgs

public Map<String,Object> getArgs()

getStartedBy

public String getStartedBy()

getStoppedBy

public String getStoppedBy()

getComment

public String getComment()

setComment

public void setComment(String comment)

getDetail

public String getDetail()

setDetail

public void setDetail(String detail)

getStop

public long getStop()

getFailureReason

public String getFailureReason()

setFailureReason

public void setFailureReason(String failureReason)

isStopped

public boolean isStopped()

cancel

public void cancel(User user)

complete

public void complete(User user)

Stop a successful activity

completeExceptionally

public void completeExceptionally(String failureReason,
 User user)

Stop an activity. If failureReason is null, the activity is considered successful.

toTuple

public Tuple toTuple()

compareTo

public int compareTo(Activity other)

Specified by:

compareTo in interface Comparable<Activity>