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: dc2b075b9d40edfdcf3c04ed2bf032474f1b0d6b $
PROPERTY_REMOTE
static final String PROPERTY_REMOTE
- See Also:
isRemote()
,
Constant Field Values
PROPERTY_INTERACTIVE
static final String PROPERTY_INTERACTIVE
- See Also:
isInteractive()
,
Constant Field Values
getId
List<String> getId()
- Returns:
- list based 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.
- Since:
- 4.1M2
isRemote
boolean isRemote()
- Returns:
- indicate if the job has been triggered by a remote event
isInteractive
boolean isInteractive()
- Returns:
- indicate if the job is allowed to ask questions if it it should be fully automated (i.e. use default
answers)
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 propertydef
- the default value of the property
- Returns:
- the value of the property
getPropertyNames
Collection<String> getPropertyNames()
- Returns:
- the names of all the properties
containsProperty
boolean containsProperty(String key)
- Parameters:
key
- the name of the property
- Returns:
- true if this map contains a property for the specified key
- Since:
- 4.2M2
removeProperty
<T> T removeProperty(String key)
- Type Parameters:
T
- the type of the value- Parameters:
key
- the name of the property
- Returns:
- the previous value associated to the passed key
- Since:
- 4.2M2
Copyright © 2004-2012 XWiki. All Rights Reserved.