CreateRequest (XWiki Platform - Refactoring - API 15.4 API)

java.lang.Object
- org.xwiki.job.AbstractRequest
- - org.xwiki.job.api.AbstractCheckRightsRequest
  - - org.xwiki.refactoring.job.EntityRequest
    - - org.xwiki.refactoring.job.CreateRequest

All Implemented Interfaces:

Serializable, org.xwiki.job.Request
```
public class CreateRequest
extends EntityRequest
```
A job request that can be used to create a collection of entities using a specified template.

Since:

7.4M2

Version:

$Id: 4cee515e653aa333e48af684f88cbe882b3fd19d $

See Also:

Serialized Form

Field Summary
- Fields inherited from interface org.xwiki.job.Request
  PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors
Constructor Description

CreateRequest()
Default constructor.

CreateRequest(org.xwiki.job.Request request)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<org.xwiki.model.reference.EntityReference>`	`getSkippedEntities()`
`org.xwiki.model.reference.EntityReference`	`getTemplateReference()`
`void`	`setSkippedEntities(List<org.xwiki.model.reference.EntityReference> skippedEntities)`
`void`	`setTemplateReference(org.xwiki.model.reference.EntityReference templateReference)`

Methods inherited from class org.xwiki.refactoring.job.EntityRequest
getEntityParameters, getEntityReferences, getJobType, isDeep, setDeep, setEntityParameters, setEntityReferences, setJobType

Methods inherited from class org.xwiki.job.api.AbstractCheckRightsRequest
getAuthorReference, getUserReference, isCheckAuthorRights, isCheckRights, setAuthorReference, setCheckAuthorRights, setCheckRights, setUserReference

Methods inherited from class org.xwiki.job.AbstractRequest
containsProperty, equals, getContext, getId, getProperties, getProperty, getProperty, getPropertyNames, hashCode, isInteractive, isRemote, isStatusLogIsolated, isStatusSerialized, isVerbose, removeProperty, setContext, setId, setId, setId, setInteractive, setProperty, setRemote, setStatusLogIsolated, setStatusSerialized, setVerbose

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

- Constructor Detail
  - CreateRequest
```
public CreateRequest()
```
    Default constructor.
  - CreateRequest
```
public CreateRequest(org.xwiki.job.Request request)
```
    Parameters:
    
    request - the request to copy
    
    Since:
    
    14.7RC1, 14.4.4, 13.10.9
- Method Detail
  - setTemplateReference
```
public void setTemplateReference(org.xwiki.model.reference.EntityReference templateReference)
```
    Parameters:
    
    templateReference - the reference of the entity to use as template
  - getTemplateReference
```
public org.xwiki.model.reference.EntityReference getTemplateReference()
```
    Returns:
    
    the reference of the entity to use as template
  - getSkippedEntities
```
public List<org.xwiki.model.reference.EntityReference> getSkippedEntities()
```
    Returns:
    
    the list of entities that are to be skipped by the job's execution
  - setSkippedEntities
```
public void setSkippedEntities(List<org.xwiki.model.reference.EntityReference> skippedEntities)
```
    Parameters:
    
    skippedEntities - the list of entities that to skip in the job's execution