org.xwiki.job
Interface Request

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractRequest, DefaultRequest

public interface Request
extends Serializable

A Job request.

Since:
4.0M1
Version:
$Id$

Field Summary
static String PROPERTY_REMOTE
           
 
Method Summary
 String getId()
           
<T> T
getProperty(String key)
           
<T> T
getProperty(String key, T def)
           
 Collection<String> getPropertyNames()
           
 boolean isRemote()
           
 

Field Detail

PROPERTY_REMOTE

static final String PROPERTY_REMOTE
See Also:
isRemote(), Constant Field Values
Method Detail

getId

String getId()
Returns:
identifier used to access the job. If none is provided the job will not be accessible by id and the status of the job will not be stored.

isRemote

boolean isRemote()
Returns:
indicate if the job has been triggered by a remote event

getProperty

<T> T getProperty(String key)
Type Parameters:
T - the type of the value
Parameters:
key - the name of the property
Returns:
the value of the property

getProperty

<T> T getProperty(String key,
                  T def)
Type Parameters:
T - the type of the value
Parameters:
key - the name of the property
def - the default value of the property
Returns:
the value of the property

getPropertyNames

Collection<String> getPropertyNames()
Returns:
the names of all the properties


Copyright © 2004-2012 XWiki. All Rights Reserved.