Package net.webpdf.wsclient.openapi

Class OperationReplyToAnnotation

java.lang.Object

net.webpdf.wsclient.openapi.OperationReplyToAnnotation

public class OperationReplyToAnnotation
extends Object

An annotation, that represents a textual reply to another annotation.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_COMMENT
static String	JSON_PROPERTY_CREATOR
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_PAGE
static String	JSON_PROPERTY_REPLY_TO
static String	JSON_PROPERTY_SUBJECT

Constructor Summary

Constructors

Constructor	Description
OperationReplyToAnnotation()

Method Summary

Modifier and Type	Method	Description
OperationReplyToAnnotation	comment(String comment)
OperationReplyToAnnotation	creator(String creator)
boolean	equals(Object o)
@Nullable String	getComment()	This value is used to set the textual comment/reply to display.
@Nullable String	getCreator()	Used to specify the author of the annotation.
@Nullable String	getName()	Used to specify the name of the annotation.
@Nullable Integer	getPage()	Set the number of the page, the annotation shall be placed on.
@Nullable String	getReplyTo()	Selects the object id of the annotation, that this annotation shall be a reply to.
@Nullable String	getSubject()	Used to specify the subject of the annotation.
int	hashCode()
OperationReplyToAnnotation	name(String name)
OperationReplyToAnnotation	page(Integer page)
OperationReplyToAnnotation	replyTo(String replyTo)
void	setComment(String comment)
void	setCreator(String creator)
void	setName(String name)
void	setPage(Integer page)
void	setReplyTo(String replyTo)
void	setSubject(String subject)
OperationReplyToAnnotation	subject(String subject)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_COMMENT

public static final String JSON_PROPERTY_COMMENT

See Also:

Constant Field Values

JSON_PROPERTY_CREATOR

public static final String JSON_PROPERTY_CREATOR

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_PAGE

public static final String JSON_PROPERTY_PAGE

See Also:

Constant Field Values

JSON_PROPERTY_REPLY_TO

public static final String JSON_PROPERTY_REPLY_TO

See Also:

Constant Field Values

JSON_PROPERTY_SUBJECT

public static final String JSON_PROPERTY_SUBJECT

See Also:

Constant Field Values

Constructor Detail

OperationReplyToAnnotation

public OperationReplyToAnnotation()

Method Detail

comment

public OperationReplyToAnnotation comment(String comment)

getComment

@Nullable
public @Nullable String getComment()

This value is used to set the textual comment/reply to display.

Returns:

comment

setComment

public void setComment(String comment)

creator

public OperationReplyToAnnotation creator(String creator)

getCreator

@Nullable
public @Nullable String getCreator()

Used to specify the author of the annotation.

Returns:

creator

setCreator

public void setCreator(String creator)

name

public OperationReplyToAnnotation name(String name)

getName

@Nullable
public @Nullable String getName()

Used to specify the name of the annotation.

Returns:

name

setName

public void setName(String name)

page

public OperationReplyToAnnotation page(Integer page)

getPage

@Nullable
public @Nullable Integer getPage()

Set the number of the page, the annotation shall be placed on. **Important:** A reply shall always be placed on the same page as it's target annotation. This is mostly providing a hint where to find the selected annotation. minimum: 1

Returns:

page

setPage

public void setPage(Integer page)

replyTo

public OperationReplyToAnnotation replyTo(String replyTo)

getReplyTo

@Nullable
public @Nullable String getReplyTo()

Selects the object id of the annotation, that this annotation shall be a reply to. The object id shall be given as a String that may contain either: * The numeric object ID itself * The object ID followed by the generation number, separated by a space

Returns:

replyTo

setReplyTo

public void setReplyTo(String replyTo)

subject

public OperationReplyToAnnotation subject(String subject)

getSubject

@Nullable
public @Nullable String getSubject()

Used to specify the subject of the annotation.

Returns:

subject

setSubject

public void setSubject(String subject)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object