Package net.webpdf.wsclient.openapi

Class OperationAppearanceAdd

java.lang.Object

net.webpdf.wsclient.openapi.OperationAppearanceAdd

public class OperationAppearanceAdd
extends Object

Used to define the signature's visual appearance.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_IDENTIFIER
static String	JSON_PROPERTY_IDENTIFIER_ELEMENTS
static String	JSON_PROPERTY_IMAGE
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_PAGE
static String	JSON_PROPERTY_POSITION
static String	JSON_PROPERTY_SHOW_COMMON_NAME

Constructor Summary

Constructors

Constructor	Description
OperationAppearanceAdd()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Nullable String	getIdentifier()	Text that should be displayed in the signature's right-hand side text field.
@Nullable OperationSignatureIdentifier	getIdentifierElements()	Get identifierElements
@Nullable OperationSignatureImage	getImage()	Get image
@Nullable String	getName()	Name that will be displayed in the signature's left-hand side area.
@Nullable Integer	getPage()	Defines the page on which the signature is to be displayed.
@Nullable OperationSignaturePosition	getPosition()	Get position
@Nullable Boolean	getShowCommonName()	Displays or hides the certificate name (CN) of the certificate in the signature's left-hand side area.
int	hashCode()
OperationAppearanceAdd	identifier(String identifier)
OperationAppearanceAdd	identifierElements(OperationSignatureIdentifier identifierElements)
OperationAppearanceAdd	image(OperationSignatureImage image)
OperationAppearanceAdd	name(String name)
OperationAppearanceAdd	page(Integer page)
OperationAppearanceAdd	position(OperationSignaturePosition position)
void	setIdentifier(String identifier)
void	setIdentifierElements(OperationSignatureIdentifier identifierElements)
void	setImage(OperationSignatureImage image)
void	setName(String name)
void	setPage(Integer page)
void	setPosition(OperationSignaturePosition position)
void	setShowCommonName(Boolean showCommonName)
OperationAppearanceAdd	showCommonName(Boolean showCommonName)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_IDENTIFIER

public static final String JSON_PROPERTY_IDENTIFIER

See Also:

Constant Field Values

JSON_PROPERTY_IDENTIFIER_ELEMENTS

public static final String JSON_PROPERTY_IDENTIFIER_ELEMENTS

See Also:

Constant Field Values

JSON_PROPERTY_IMAGE

public static final String JSON_PROPERTY_IMAGE

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_POSITION

public static final String JSON_PROPERTY_POSITION

See Also:

Constant Field Values

JSON_PROPERTY_SHOW_COMMON_NAME

public static final String JSON_PROPERTY_SHOW_COMMON_NAME

See Also:

Constant Field Values

Constructor Detail

OperationAppearanceAdd

public OperationAppearanceAdd()

Method Detail

identifier

public OperationAppearanceAdd identifier(String identifier)

getIdentifier

@Nullable
public @Nullable String getIdentifier()

Text that should be displayed in the signature's right-hand side text field. If a value is not specified, the field will display the name of the signatory and the name parts of the certificate (please refer to `<identifierElements>` further below).

Returns:

identifier

setIdentifier

public void setIdentifier(String identifier)

identifierElements

public OperationAppearanceAdd identifierElements(OperationSignatureIdentifier identifierElements)

getIdentifierElements

@Nullable
public @Nullable OperationSignatureIdentifier getIdentifierElements()

Get identifierElements

Returns:

identifierElements

setIdentifierElements

public void setIdentifierElements(OperationSignatureIdentifier identifierElements)

image

public OperationAppearanceAdd image(OperationSignatureImage image)

getImage

@Nullable
public @Nullable OperationSignatureImage getImage()

Get image

Returns:

image

setImage

public void setImage(OperationSignatureImage image)

name

public OperationAppearanceAdd name(String name)

getName

@Nullable
public @Nullable String getName()

Name that will be displayed in the signature's left-hand side area. If no value is specified, the name of the signer is displayed in this area (CN name part from the certificate) if `showCommonName` is enabled.

Returns:

name

setName

public void setName(String name)

page

public OperationAppearanceAdd page(Integer page)

getPage

@Nullable
public @Nullable Integer getPage()

Defines the page on which the signature is to be displayed. minimum: 1

Returns:

page

setPage

public void setPage(Integer page)

position

public OperationAppearanceAdd position(OperationSignaturePosition position)

getPosition

@Nullable
public @Nullable OperationSignaturePosition getPosition()

Get position

Returns:

position

setPosition

public void setPosition(OperationSignaturePosition position)

showCommonName

public OperationAppearanceAdd showCommonName(Boolean showCommonName)

getShowCommonName

@Nullable
public @Nullable Boolean getShowCommonName()

Displays or hides the certificate name (CN) of the certificate in the signature's left-hand side area. A set `name` always has priority over the setting of this option.

Returns:

showCommonName

setShowCommonName

public void setShowCommonName(Boolean showCommonName)

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