Package org.xwiki.annotation.rest.model.jaxb

Class AnnotationRequest

java.lang.Object

org.xwiki.annotation.rest.model.jaxb.AnnotationRequest

Direct Known Subclasses:

AnnotationUpdateRequest

public class AnnotationRequest
extends Object

Stores the information about an annotations request: what annotations should be returned with the annotated content and the annotations stubs. Such information are the annotations filter (which annotations should be displayed) and the annotation additional fields that should be added in the stubs.

Java class for AnnotationRequest complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="AnnotationRequest">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="request" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="fields" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="filter" type="{http://www.xwiki.org}AnnotationFieldCollection" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnnotationRequest.Request	Java class for anonymous complex type.

Field Summary

Fields

Modifier and Type	Field	Description
protected AnnotationFieldCollection	filter
protected AnnotationRequest.Request	request

Constructor Summary

Constructors

Constructor	Description
AnnotationRequest()

Method Summary

Modifier and Type	Method	Description
AnnotationFieldCollection	getFilter()	Gets the value of the filter property.
AnnotationRequest.Request	getRequest()	Gets the value of the request property.
void	setFilter(AnnotationFieldCollection value)	Sets the value of the filter property.
void	setRequest(AnnotationRequest.Request value)	Sets the value of the request property.
AnnotationRequest	withFilter(AnnotationFieldCollection value)
AnnotationRequest	withRequest(AnnotationRequest.Request value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

request

protected AnnotationRequest.Request request

filter

protected AnnotationFieldCollection filter

Constructor Detail

AnnotationRequest

public AnnotationRequest()

Method Detail

getRequest

public AnnotationRequest.Request getRequest()

Gets the value of the request property.

Returns:

possible object is AnnotationRequest.Request

setRequest

public void setRequest(AnnotationRequest.Request value)

Sets the value of the request property.

Parameters:

value - allowed object is AnnotationRequest.Request

getFilter

public AnnotationFieldCollection getFilter()

Gets the value of the filter property.

Returns:

possible object is AnnotationFieldCollection

setFilter

public void setFilter(AnnotationFieldCollection value)

Sets the value of the filter property.

Parameters:

value - allowed object is AnnotationFieldCollection

withRequest

public AnnotationRequest withRequest(AnnotationRequest.Request value)

withFilter

public AnnotationRequest withFilter(AnnotationFieldCollection value)