javax.activity
Interface UserActivity

All Known Subinterfaces:
ActivityManager
All Known Implementing Classes:
ActivityService

public interface UserActivity


Method Summary
 void begin(int timeout)
           
 Outcome broadcast(java.lang.String signalSetName)
           
 Outcome complete()
           
 Outcome completeWithStatus(int completionStatus)
           
 void forget(GlobalId globalId)
           
 int getCompletionStatus()
           
 ActivityCoordinator getCoordinator()
           
 GlobalId getGlobalId()
           
 java.lang.String getName()
           
 ActivityCoordinator getParentCoordinator()
           
 PropertyGroup getPropertyGroup(java.lang.String name)
           
 ServiceManager getService()
           
 int getStatus()
           
 int getTimeout()
           
 GlobalId[] recover()
           
 ActivityCoordinator recreate(GlobalId activity, GlobalId parent, boolean resume)
           
 void registerService(ServiceManager service)
           
 void setCompletionStatus(int completionStatus)
           
 void setTimeout(int timeout)
           
 

Method Detail

begin

public void begin(int timeout)
           throws InvalidStateException,
                  ServiceNotRegisteredException,
                  TimeoutRangeException,
                  SystemException
Throws:
InvalidStateException
ServiceNotRegisteredException
TimeoutRangeException
SystemException

complete

public Outcome complete()
                 throws NoActivityException,
                        ActivityPendingException,
                        ContextPendingException,
                        ServiceNotRegisteredException,
                        NotOriginatorException,
                        ActivityNotProcessedException,
                        SystemException
Throws:
NoActivityException
ActivityPendingException
ContextPendingException
ServiceNotRegisteredException
NotOriginatorException
ActivityNotProcessedException
SystemException

completeWithStatus

public Outcome completeWithStatus(int completionStatus)
                           throws NoActivityException,
                                  ActivityPendingException,
                                  ContextPendingException,
                                  ServiceNotRegisteredException,
                                  NotOriginatorException,
                                  InvalidStateException,
                                  ActivityNotProcessedException,
                                  SystemException
Throws:
NoActivityException
ActivityPendingException
ContextPendingException
ServiceNotRegisteredException
NotOriginatorException
InvalidStateException
ActivityNotProcessedException
SystemException

setCompletionStatus

public void setCompletionStatus(int completionStatus)
                         throws NoActivityException,
                                InvalidStateException,
                                ServiceNotRegisteredException,
                                SystemException
Throws:
NoActivityException
InvalidStateException
ServiceNotRegisteredException
SystemException

getCompletionStatus

public int getCompletionStatus()
                        throws ServiceNotRegisteredException,
                               NoActivityException,
                               SystemException
Throws:
ServiceNotRegisteredException
NoActivityException
SystemException

getStatus

public int getStatus()
              throws ServiceNotRegisteredException,
                     SystemException
Throws:
ServiceNotRegisteredException
SystemException

getName

public java.lang.String getName()
                         throws ServiceNotRegisteredException,
                                SystemException
Throws:
ServiceNotRegisteredException
SystemException

setTimeout

public void setTimeout(int timeout)
                throws ServiceNotRegisteredException,
                       TimeoutRangeException,
                       SystemException
Throws:
ServiceNotRegisteredException
TimeoutRangeException
SystemException

getTimeout

public int getTimeout()
               throws ServiceNotRegisteredException,
                      SystemException
Throws:
ServiceNotRegisteredException
SystemException

getGlobalId

public GlobalId getGlobalId()
                     throws ServiceNotRegisteredException,
                            SystemException
Throws:
ServiceNotRegisteredException
SystemException

broadcast

public Outcome broadcast(java.lang.String signalSetName)
                  throws NoActivityException,
                         SignalSetUnknownException,
                         ServiceNotRegisteredException,
                         InvalidActivityException,
                         ActivityNotProcessedException,
                         SystemException
Throws:
NoActivityException
SignalSetUnknownException
ServiceNotRegisteredException
InvalidActivityException
ActivityNotProcessedException
SystemException

getCoordinator

public ActivityCoordinator getCoordinator()
                                   throws ServiceNotRegisteredException,
                                          NoImplementException,
                                          SystemException
Throws:
ServiceNotRegisteredException
NoImplementException
SystemException

getParentCoordinator

public ActivityCoordinator getParentCoordinator()
                                         throws ServiceNotRegisteredException,
                                                NoImplementException,
                                                SystemException
Throws:
ServiceNotRegisteredException
NoImplementException
SystemException

getPropertyGroup

public PropertyGroup getPropertyGroup(java.lang.String name)
                               throws PropertyGroupUnknownException,
                                      ServiceNotRegisteredException,
                                      NoActivityException,
                                      SystemException
Throws:
PropertyGroupUnknownException
ServiceNotRegisteredException
NoActivityException
SystemException

registerService

public void registerService(ServiceManager service)
                     throws PropertyGroupUnknownException,
                            ServiceAlreadyRegisteredException,
                            SystemException
Throws:
PropertyGroupUnknownException
ServiceAlreadyRegisteredException
SystemException

getService

public ServiceManager getService()
                          throws SystemException
Throws:
SystemException

recreate

public ActivityCoordinator recreate(GlobalId activity,
                                    GlobalId parent,
                                    boolean resume)
                             throws ServiceNotRegisteredException,
                                    ActivityCompletedException,
                                    java.lang.IllegalArgumentException,
                                    SystemException
Throws:
ServiceNotRegisteredException
ActivityCompletedException
java.lang.IllegalArgumentException
SystemException

recover

public GlobalId[] recover()
                   throws ServiceNotRegisteredException,
                          SystemException
Throws:
ServiceNotRegisteredException
SystemException

forget

public void forget(GlobalId globalId)
            throws ServiceNotRegisteredException,
                   SystemException
Throws:
ServiceNotRegisteredException
SystemException