Package net.webpdf.wsclient.openapi
Class OperationReplyStateAnnotation
- java.lang.Object
-
- net.webpdf.wsclient.openapi.OperationReplyStateAnnotation
-
public class OperationReplyStateAnnotation extends Object
An annotation, that provides a \"reply state\" for a selected annotation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationReplyStateAnnotation.ReplyStateEnumAdds a mark for further processing suggestions/instructions to a commenting annotation
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_CREATORstatic StringJSON_PROPERTY_NAMEstatic StringJSON_PROPERTY_PAGEstatic StringJSON_PROPERTY_REPLY_STATEstatic StringJSON_PROPERTY_REPLY_TOstatic StringJSON_PROPERTY_SUBJECT
-
Constructor Summary
Constructors Constructor Description OperationReplyStateAnnotation()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationReplyStateAnnotationcreator(String creator)booleanequals(Object o)@Nullable StringgetCreator()Used to specify the author of the annotation.@Nullable StringgetName()Used to specify the name of the annotation.@Nullable IntegergetPage()Set the number of the page, the annotation shall be placed on.@Nullable OperationReplyStateAnnotation.ReplyStateEnumgetReplyState()Adds a mark for further processing suggestions/instructions to a commenting annotation@Nullable StringgetReplyTo()Selects the object id of the annotation, that this annotation shall be a reply to.@Nullable StringgetSubject()Used to specify the subject of the annotation.inthashCode()OperationReplyStateAnnotationname(String name)OperationReplyStateAnnotationpage(Integer page)OperationReplyStateAnnotationreplyState(OperationReplyStateAnnotation.ReplyStateEnum replyState)OperationReplyStateAnnotationreplyTo(String replyTo)voidsetCreator(String creator)voidsetName(String name)voidsetPage(Integer page)voidsetReplyState(OperationReplyStateAnnotation.ReplyStateEnum replyState)voidsetReplyTo(String replyTo)voidsetSubject(String subject)OperationReplyStateAnnotationsubject(String subject)StringtoString()
-
-
-
Field Detail
-
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_STATE
public static final String JSON_PROPERTY_REPLY_STATE
- 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
-
-
Method Detail
-
creator
public OperationReplyStateAnnotation 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 OperationReplyStateAnnotation 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 OperationReplyStateAnnotation 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)
-
replyState
public OperationReplyStateAnnotation replyState(OperationReplyStateAnnotation.ReplyStateEnum replyState)
-
getReplyState
@Nullable public @Nullable OperationReplyStateAnnotation.ReplyStateEnum getReplyState()
Adds a mark for further processing suggestions/instructions to a commenting annotation. * accepted = The user agrees with the change. * rejected = The user disagrees with the change. * cancelled = The change has been cancelled. * completed = The change has been completed. * none = The user did not set a state.- Returns:
- replyState
-
setReplyState
public void setReplyState(OperationReplyStateAnnotation.ReplyStateEnum replyState)
-
replyTo
public OperationReplyStateAnnotation 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 OperationReplyStateAnnotation 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)
-
-