Package net.webpdf.wsclient.openapi

Class OperationHeaderFooter

java.lang.Object

net.webpdf.wsclient.openapi.OperationHeaderFooter

public class OperationHeaderFooter
extends Object

Used to define the header and footer that will be added to a document.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_DATE
static String	JSON_PROPERTY_FIRST_PAGE_NUMBER
static String	JSON_PROPERTY_FONT
static String	JSON_PROPERTY_FOOTER
static String	JSON_PROPERTY_HEADER
static String	JSON_PROPERTY_MARGIN
static String	JSON_PROPERTY_PAGES
static String	JSON_PROPERTY_REPLACE_EXISTING

Constructor Summary

Constructors

Constructor	Description
OperationHeaderFooter()

Method Summary

Modifier and Type	Method	Description
OperationHeaderFooter	date(OperationHeaderFooterDate date)
boolean	equals(Object o)
OperationHeaderFooter	firstPageNumber(Integer firstPageNumber)
OperationHeaderFooter	font(OperationOptionsFont font)
OperationHeaderFooter	footer(OperationHeaderFooterPositions footer)
@Nullable OperationHeaderFooterDate	getDate()	Get date
@Nullable Integer	getFirstPageNumber()	Used to specify the starting page for page number formats.
@Nullable OperationOptionsFont	getFont()	Get font
@Nullable OperationHeaderFooterPositions	getFooter()	Get footer
@Nullable OperationHeaderFooterPositions	getHeader()	Get header
@Nullable OperationOptionsMargin	getMargin()	Get margin
@Nullable OperationPagesHeaderFooter	getPages()	Get pages
@Nullable Boolean	getReplaceExisting()	If true, an existing header and footer definition will be automatically deleted and replaced with the new one.
int	hashCode()
OperationHeaderFooter	header(OperationHeaderFooterPositions header)
OperationHeaderFooter	margin(OperationOptionsMargin margin)
OperationHeaderFooter	pages(OperationPagesHeaderFooter pages)
OperationHeaderFooter	replaceExisting(Boolean replaceExisting)
void	setDate(OperationHeaderFooterDate date)
void	setFirstPageNumber(Integer firstPageNumber)
void	setFont(OperationOptionsFont font)
void	setFooter(OperationHeaderFooterPositions footer)
void	setHeader(OperationHeaderFooterPositions header)
void	setMargin(OperationOptionsMargin margin)
void	setPages(OperationPagesHeaderFooter pages)
void	setReplaceExisting(Boolean replaceExisting)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_DATE

public static final String JSON_PROPERTY_DATE

See Also:

Constant Field Values

JSON_PROPERTY_FIRST_PAGE_NUMBER

public static final String JSON_PROPERTY_FIRST_PAGE_NUMBER

See Also:

Constant Field Values

JSON_PROPERTY_FONT

public static final String JSON_PROPERTY_FONT

See Also:

Constant Field Values

JSON_PROPERTY_FOOTER

public static final String JSON_PROPERTY_FOOTER

See Also:

Constant Field Values

JSON_PROPERTY_HEADER

public static final String JSON_PROPERTY_HEADER

See Also:

Constant Field Values

JSON_PROPERTY_MARGIN

public static final String JSON_PROPERTY_MARGIN

See Also:

Constant Field Values

JSON_PROPERTY_PAGES

public static final String JSON_PROPERTY_PAGES

See Also:

Constant Field Values

JSON_PROPERTY_REPLACE_EXISTING

public static final String JSON_PROPERTY_REPLACE_EXISTING

See Also:

Constant Field Values

Constructor Detail

OperationHeaderFooter

public OperationHeaderFooter()

Method Detail

date

public OperationHeaderFooter date(OperationHeaderFooterDate date)

getDate

@Nullable
public @Nullable OperationHeaderFooterDate getDate()

Get date

Returns:

date

setDate

public void setDate(OperationHeaderFooterDate date)

firstPageNumber

public OperationHeaderFooter firstPageNumber(Integer firstPageNumber)

getFirstPageNumber

@Nullable
public @Nullable Integer getFirstPageNumber()

Used to specify the starting page for page number formats. minimum: 1

Returns:

firstPageNumber

setFirstPageNumber

public void setFirstPageNumber(Integer firstPageNumber)

font

public OperationHeaderFooter font(OperationOptionsFont font)

getFont

@Nullable
public @Nullable OperationOptionsFont getFont()

Get font

Returns:

font

setFont

public void setFont(OperationOptionsFont font)

footer

public OperationHeaderFooter footer(OperationHeaderFooterPositions footer)

getFooter

@Nullable
public @Nullable OperationHeaderFooterPositions getFooter()

Get footer

Returns:

footer

setFooter

public void setFooter(OperationHeaderFooterPositions footer)

header

public OperationHeaderFooter header(OperationHeaderFooterPositions header)

getHeader

@Nullable
public @Nullable OperationHeaderFooterPositions getHeader()

Get header

Returns:

header

setHeader

public void setHeader(OperationHeaderFooterPositions header)

margin

public OperationHeaderFooter margin(OperationOptionsMargin margin)

getMargin

@Nullable
public @Nullable OperationOptionsMargin getMargin()

Get margin

Returns:

margin

setMargin

public void setMargin(OperationOptionsMargin margin)

pages

public OperationHeaderFooter pages(OperationPagesHeaderFooter pages)

getPages

@Nullable
public @Nullable OperationPagesHeaderFooter getPages()

Get pages

Returns:

pages

setPages

public void setPages(OperationPagesHeaderFooter pages)

replaceExisting

public OperationHeaderFooter replaceExisting(Boolean replaceExisting)

getReplaceExisting

@Nullable
public @Nullable Boolean getReplaceExisting()

If true, an existing header and footer definition will be automatically deleted and replaced with the new one. If false, an existing definition will cause the operation to be aborted.

Returns:

replaceExisting

setReplaceExisting

public void setReplaceExisting(Boolean replaceExisting)

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