com.paypal.api.payments

Class Template

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.Template

public class Template
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
Template() Default Constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
Template	create(APIContext apiContext) Creates a template.
void	delete(APIContext apiContext) Delete a particular template by passing the template ID to the request URI.
boolean	equals(java.lang.Object o)
static Template	get(APIContext apiContext, java.lang.String templateId) Retrieve the details for a particular template by passing the template ID to the request URI.
static Templates	getAll(APIContext apiContext) Retrieves the template information of the merchant.
java.lang.Boolean	getCustom() Indicates whether this is a custom template created by the merchant.
java.lang.Boolean	getIsDefault() Indicates that this template is merchant's default.
java.lang.String	getName() Name of the template.
java.util.List<TemplateSettings>	getSettings() Settings for each template
TemplateData	getTemplateData() Customized invoice data which is saved as template
java.lang.String	getTemplateId() Unique identifier id of the template.
java.lang.String	getUnitOfMeasure() Unit of measure for the template, possible values are Quantity, Hours, Amount.
int	hashCode()
Template	setCustom(java.lang.Boolean custom) Indicates whether this is a custom template created by the merchant.
Template	setIsDefault(java.lang.Boolean isDefault) Indicates that this template is merchant's default.
Template	setName(java.lang.String name) Name of the template.
Template	setSettings(java.util.List<TemplateSettings> settings) Settings for each template
Template	setTemplateData(TemplateData templateData) Customized invoice data which is saved as template
Template	setTemplateId(java.lang.String templateId) Unique identifier id of the template.
Template	setUnitOfMeasure(java.lang.String unitOfMeasure) Unit of measure for the template, possible values are Quantity, Hours, Amount.
Template	update(APIContext apiContext) Update an existing template by passing the template ID to the request URI.

Methods inherited from class com.paypal.base.rest.PayPalResource

configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefault

Methods inherited from class com.paypal.base.rest.PayPalModel

toJSON, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Template

public Template()

Default Constructor

Method Detail

get

public static Template get(APIContext apiContext,
                           java.lang.String templateId)
                    throws PayPalRESTException

Retrieve the details for a particular template by passing the template ID to the request URI.

Parameters:

apiContext - APIContext used for the API call.

templateId - String

Returns:

Template

Throws:

PayPalRESTException

getAll

public static Templates getAll(APIContext apiContext)
                        throws PayPalRESTException

Retrieves the template information of the merchant.

Parameters:

apiContext - APIContext used for the API call.

Returns:

Templates

Throws:

PayPalRESTException

delete

public void delete(APIContext apiContext)
            throws PayPalRESTException

Delete a particular template by passing the template ID to the request URI.

Parameters:

apiContext - APIContext used for the API call.

Throws:

PayPalRESTException

create

public Template create(APIContext apiContext)
                throws PayPalRESTException

Creates a template.

Parameters:

apiContext - APIContext used for the API call.

Returns:

Template

Throws:

PayPalRESTException

update

public Template update(APIContext apiContext)
                throws PayPalRESTException

Update an existing template by passing the template ID to the request URI. In addition, pass a complete template object in the request JSON. Partial updates are not supported.

Parameters:

apiContext - APIContext used for the API call. Template

Returns:

Template

Throws:

PayPalRESTException

getTemplateId

public java.lang.String getTemplateId()

Unique identifier id of the template.

getName

public java.lang.String getName()

Name of the template.

getIsDefault

public java.lang.Boolean getIsDefault()

Indicates that this template is merchant's default. There can be only one template which can be a default.

getTemplateData

public TemplateData getTemplateData()

Customized invoice data which is saved as template

getSettings

public java.util.List<TemplateSettings> getSettings()

Settings for each template

getUnitOfMeasure

public java.lang.String getUnitOfMeasure()

Unit of measure for the template, possible values are Quantity, Hours, Amount.

getCustom

public java.lang.Boolean getCustom()

Indicates whether this is a custom template created by the merchant. Non custom templates are system generated

setTemplateId

public Template setTemplateId(java.lang.String templateId)

Unique identifier id of the template.

Returns:

this

setName

public Template setName(java.lang.String name)

Name of the template.

Returns:

this

setIsDefault

public Template setIsDefault(java.lang.Boolean isDefault)

Indicates that this template is merchant's default. There can be only one template which can be a default.

Returns:

this

setTemplateData

public Template setTemplateData(TemplateData templateData)

Customized invoice data which is saved as template

Returns:

this

setSettings

public Template setSettings(java.util.List<TemplateSettings> settings)

Settings for each template

Returns:

this

setUnitOfMeasure

public Template setUnitOfMeasure(java.lang.String unitOfMeasure)

Unit of measure for the template, possible values are Quantity, Hours, Amount.

Returns:

this

setCustom

public Template setCustom(java.lang.Boolean custom)

Indicates whether this is a custom template created by the merchant. Non custom templates are system generated

Returns:

this

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class PayPalModel

canEqual

protected boolean canEqual(java.lang.Object other)

Overrides:

canEqual in class PayPalModel

hashCode

public int hashCode()

Overrides:

hashCode in class PayPalModel