Task (Ambit 2 4.0.1-SNAPSHOT API)

java.lang.Object
- ambit2.rest.task.Task<REFERENCE,USERID>

All Implemented Interfaces:: Serializable, net.idea.restnet.i.task.ITask<REFERENCE,USERID>

public abstract class Task<REFERENCE,USERID>
extends Object
implements Serializable, net.idea.restnet.i.task.ITask<REFERENCE,USERID>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Task.TaskProperty

Nested Classes
Modifier and Type	Class and Description
`static class`	`Task.TaskProperty`

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`completed`
`protected org.restlet.resource.ResourceException`	`error`
`protected boolean`	`internal`
`protected String`	`name`
`protected float`	`percentCompleted`
`protected Exception`	`policyError`
`protected REFERENCE`	`result`
`protected long`	`started`
`protected net.idea.restnet.i.task.TaskStatus`	`status`
`protected USERID`	`userid`
`protected UUID`	`uuid`

Constructor Summary

Constructors
Constructor and Description

Task(USERID user)

Constructors
Constructor and Description
`Task(USERID user)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`org.restlet.resource.ResourceException`	`getError()`
`String`	`getName()`
`abstract float`	`getPercentCompleted()`
`Exception`	`getPolicyError()`
`long`	`getStarted()`
`net.idea.restnet.i.task.TaskStatus`	`getStatus()`
`long`	`getTimeCompleted()`
`REFERENCE`	`getUri()`
`USERID`	`getUserid()`
`UUID`	`getUuid()`
`boolean`	`isDone()`
`boolean`	`isExpired(long lifetime)`
`boolean`	`isInternal()`
`void`	`setError(org.restlet.resource.ResourceException error)`
`void`	`setInternal(boolean internal)`
`void`	`setName(String name)`
`void`	`setPolicy()` Does nothing so far, but should register the result URI to the policy server
`void`	`setPolicyError(Exception policyError)`
`void`	`setStatus(net.idea.restnet.i.task.TaskStatus status)`
`void`	`setTimeCompleted(long completed)`
`void`	`setUri(REFERENCE uri)`
`void`	`setUserid(USERID userid)`
`void`	`setUuid(UUID uuid)`
`String`	`toJSON()`
`String`	`toString()`
`void`	`update()` does nothing, should be autoupdated by ExecutableTask

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - result
```
protected REFERENCE result
```
  - name
```
protected String name
```
  - started
```
protected long started
```
  - completed
```
protected long completed
```
  - internal
```
protected boolean internal
```
  - percentCompleted
```
protected float percentCompleted
```
  - userid
```
protected USERID userid
```
  - uuid
```
protected UUID uuid
```
  - error
```
protected org.restlet.resource.ResourceException error
```
  - policyError
```
protected Exception policyError
```
  - status
```
protected net.idea.restnet.i.task.TaskStatus status
```
- Constructor Detail
  - Task
```
public Task(USERID user)
```
- Method Detail
  - isInternal
```
public boolean isInternal()
```
    Specified by:
    
    isInternal in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - setInternal
```
public void setInternal(boolean internal)
```
    Specified by:
    
    setInternal in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - getTimeCompleted
```
public long getTimeCompleted()
```
    Specified by:
    
    getTimeCompleted in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - setTimeCompleted
```
public void setTimeCompleted(long completed)
```
    Specified by:
    
    setTimeCompleted in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - getPolicyError
```
public Exception getPolicyError()
```
    Specified by:
    
    getPolicyError in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - setPolicyError
```
public void setPolicyError(Exception policyError)
```
    Specified by:
    
    setPolicyError in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - setError
```
public void setError(org.restlet.resource.ResourceException error)
```
    Specified by:
    
    setError in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - getError
```
public org.restlet.resource.ResourceException getError()
```
    Specified by:
    
    getError in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - setStatus
```
public void setStatus(net.idea.restnet.i.task.TaskStatus status)
```
    Specified by:
    
    setStatus in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - getUuid
```
public UUID getUuid()
```
    Specified by:
    
    getUuid in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - setUuid
```
public void setUuid(UUID uuid)
```
  - getUserid
```
public USERID getUserid()
```
    Specified by:
    
    getUserid in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - setUserid
```
public void setUserid(USERID userid)
```
  - isExpired
```
public boolean isExpired(long lifetime)
```
    Specified by:
    
    isExpired in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - getStatus
```
public net.idea.restnet.i.task.TaskStatus getStatus()
```
    Specified by:
    
    getStatus in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - getPercentCompleted
```
public abstract float getPercentCompleted()
```
    Specified by:
    
    getPercentCompleted in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - getStarted
```
public long getStarted()
```
    Specified by:
    
    getStarted in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - getUri
```
public REFERENCE getUri()
```
    Specified by:
    
    getUri in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - setUri
```
public void setUri(REFERENCE uri)
```
    Specified by:
    
    setUri in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - isDone
```
public boolean isDone()
```
    Specified by:
    
    isDone in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - update
```
public void update()
```
    does nothing, should be autoupdated by ExecutableTask
    
    Specified by:
    
    update in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
  - setPolicy
```
public void setPolicy()
               throws Exception
```
    Does nothing so far, but should register the result URI to the policy server
    
    Specified by:
    
    setPolicy in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>
    
    Throws:
    
    Exception
  - toJSON
```
public String toJSON()
```
    Specified by:
    
    toJSON in interface net.idea.restnet.i.task.ITask<REFERENCE,USERID>

Class Task<REFERENCE,USERID>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

result

name

started

completed

internal

percentCompleted

userid

uuid

error

policyError

status

Constructor Detail

Task

Method Detail

isInternal

setInternal

getTimeCompleted

setTimeCompleted

getPolicyError

setPolicyError

setError

getError

setStatus

getUuid

setUuid

getUserid

setUserid

isExpired

getStatus

getPercentCompleted

getStarted

getName

setName

getUri

setUri

isDone

toString

update

setPolicy

toJSON