Package com.docusign.esign.model
Class PowerForm
- java.lang.Object
-
- com.docusign.esign.model.PowerForm
-
public class PowerForm extends Object
Contains details about a PowerForm..
-
-
Constructor Summary
Constructors Constructor Description PowerForm()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PowerFormaddEnvelopesItem(Envelope envelopesItem)addEnvelopesItem.PowerFormaddRecipientsItem(PowerFormRecipient recipientsItem)addRecipientsItem.PowerFormcreatedBy(String createdBy)createdBy.PowerFormcreatedDateTime(String createdDateTime)createdDateTime.PowerFormemailBody(String emailBody)emailBody.PowerFormemailSubject(String emailSubject)emailSubject.PowerFormenvelopes(List<Envelope> envelopes)envelopes.booleanequals(Object o)Compares objects.PowerFormerrorDetails(ErrorDetails errorDetails)errorDetails.StringgetCreatedBy().StringgetCreatedDateTime()Indicates the date and time the item was created..StringgetEmailBody()Specifies the email body of the message sent to the recipient.StringgetEmailSubject()Specifies the subject of the email that is sent to all recipients.List<Envelope>getEnvelopes().ErrorDetailsgetErrorDetails()This object describes errors that occur.StringgetInstructions().StringgetIsActive().StringgetLastUsed().StringgetLimitUseInterval().StringgetLimitUseIntervalEnabled().StringgetLimitUseIntervalUnits().StringgetMaxUseEnabled().StringgetName().StringgetPowerFormId().StringgetPowerFormUrl().List<PowerFormRecipient>getRecipients()An array of powerform recipients..StringgetSenderName().StringgetSenderUserId().StringgetSigningMode().StringgetTemplateId()The unique identifier of the template.StringgetTemplateName().StringgetTimesUsed().StringgetUri().StringgetUsesRemaining().inthashCode()Returns the HashCode.PowerForminstructions(String instructions)instructions.PowerFormisActive(String isActive)isActive.PowerFormlastUsed(String lastUsed)lastUsed.PowerFormlimitUseInterval(String limitUseInterval)limitUseInterval.PowerFormlimitUseIntervalEnabled(String limitUseIntervalEnabled)limitUseIntervalEnabled.PowerFormlimitUseIntervalUnits(String limitUseIntervalUnits)limitUseIntervalUnits.PowerFormmaxUseEnabled(String maxUseEnabled)maxUseEnabled.PowerFormname(String name)name.PowerFormpowerFormId(String powerFormId)powerFormId.PowerFormpowerFormUrl(String powerFormUrl)powerFormUrl.PowerFormrecipients(List<PowerFormRecipient> recipients)recipients.PowerFormsenderName(String senderName)senderName.PowerFormsenderUserId(String senderUserId)senderUserId.voidsetCreatedBy(String createdBy)setCreatedBy.voidsetCreatedDateTime(String createdDateTime)setCreatedDateTime.voidsetEmailBody(String emailBody)setEmailBody.voidsetEmailSubject(String emailSubject)setEmailSubject.voidsetEnvelopes(List<Envelope> envelopes)setEnvelopes.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetInstructions(String instructions)setInstructions.voidsetIsActive(String isActive)setIsActive.voidsetLastUsed(String lastUsed)setLastUsed.voidsetLimitUseInterval(String limitUseInterval)setLimitUseInterval.voidsetLimitUseIntervalEnabled(String limitUseIntervalEnabled)setLimitUseIntervalEnabled.voidsetLimitUseIntervalUnits(String limitUseIntervalUnits)setLimitUseIntervalUnits.voidsetMaxUseEnabled(String maxUseEnabled)setMaxUseEnabled.voidsetName(String name)setName.voidsetPowerFormId(String powerFormId)setPowerFormId.voidsetPowerFormUrl(String powerFormUrl)setPowerFormUrl.voidsetRecipients(List<PowerFormRecipient> recipients)setRecipients.voidsetSenderName(String senderName)setSenderName.voidsetSenderUserId(String senderUserId)setSenderUserId.voidsetSigningMode(String signingMode)setSigningMode.voidsetTemplateId(String templateId)setTemplateId.voidsetTemplateName(String templateName)setTemplateName.voidsetTimesUsed(String timesUsed)setTimesUsed.voidsetUri(String uri)setUri.voidsetUsesRemaining(String usesRemaining)setUsesRemaining.PowerFormsigningMode(String signingMode)signingMode.PowerFormtemplateId(String templateId)templateId.PowerFormtemplateName(String templateName)templateName.PowerFormtimesUsed(String timesUsed)timesUsed.StringtoString()Converts the given object to string.PowerFormuri(String uri)uri.PowerFormusesRemaining(String usesRemaining)usesRemaining.
-
-
-
Method Detail
-
getCreatedBy
public String getCreatedBy()
.- Returns:
- createdBy
-
setCreatedBy
public void setCreatedBy(String createdBy)
setCreatedBy.
-
createdDateTime
public PowerForm createdDateTime(String createdDateTime)
createdDateTime.- Returns:
- PowerForm
-
getCreatedDateTime
public String getCreatedDateTime()
Indicates the date and time the item was created..- Returns:
- createdDateTime
-
setCreatedDateTime
public void setCreatedDateTime(String createdDateTime)
setCreatedDateTime.
-
getEmailBody
public String getEmailBody()
Specifies the email body of the message sent to the recipient. Maximum length: 10000 characters. .- Returns:
- emailBody
-
setEmailBody
public void setEmailBody(String emailBody)
setEmailBody.
-
getEmailSubject
public String getEmailSubject()
Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject..- Returns:
- emailSubject
-
setEmailSubject
public void setEmailSubject(String emailSubject)
setEmailSubject.
-
addEnvelopesItem
public PowerForm addEnvelopesItem(Envelope envelopesItem)
addEnvelopesItem.- Returns:
- PowerForm
-
errorDetails
public PowerForm errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- PowerForm
-
getErrorDetails
public ErrorDetails getErrorDetails()
This object describes errors that occur. It is only valid for responses and ignored in requests..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
getInstructions
public String getInstructions()
.- Returns:
- instructions
-
setInstructions
public void setInstructions(String instructions)
setInstructions.
-
getIsActive
public String getIsActive()
.- Returns:
- isActive
-
setIsActive
public void setIsActive(String isActive)
setIsActive.
-
getLastUsed
public String getLastUsed()
.- Returns:
- lastUsed
-
setLastUsed
public void setLastUsed(String lastUsed)
setLastUsed.
-
limitUseInterval
public PowerForm limitUseInterval(String limitUseInterval)
limitUseInterval.- Returns:
- PowerForm
-
getLimitUseInterval
public String getLimitUseInterval()
.- Returns:
- limitUseInterval
-
setLimitUseInterval
public void setLimitUseInterval(String limitUseInterval)
setLimitUseInterval.
-
limitUseIntervalEnabled
public PowerForm limitUseIntervalEnabled(String limitUseIntervalEnabled)
limitUseIntervalEnabled.- Returns:
- PowerForm
-
getLimitUseIntervalEnabled
public String getLimitUseIntervalEnabled()
.- Returns:
- limitUseIntervalEnabled
-
setLimitUseIntervalEnabled
public void setLimitUseIntervalEnabled(String limitUseIntervalEnabled)
setLimitUseIntervalEnabled.
-
limitUseIntervalUnits
public PowerForm limitUseIntervalUnits(String limitUseIntervalUnits)
limitUseIntervalUnits.- Returns:
- PowerForm
-
getLimitUseIntervalUnits
public String getLimitUseIntervalUnits()
.- Returns:
- limitUseIntervalUnits
-
setLimitUseIntervalUnits
public void setLimitUseIntervalUnits(String limitUseIntervalUnits)
setLimitUseIntervalUnits.
-
maxUseEnabled
public PowerForm maxUseEnabled(String maxUseEnabled)
maxUseEnabled.- Returns:
- PowerForm
-
getMaxUseEnabled
public String getMaxUseEnabled()
.- Returns:
- maxUseEnabled
-
setMaxUseEnabled
public void setMaxUseEnabled(String maxUseEnabled)
setMaxUseEnabled.
-
getName
public String getName()
.- Returns:
- name
-
setName
public void setName(String name)
setName.
-
getPowerFormId
public String getPowerFormId()
.- Returns:
- powerFormId
-
setPowerFormId
public void setPowerFormId(String powerFormId)
setPowerFormId.
-
getPowerFormUrl
public String getPowerFormUrl()
.- Returns:
- powerFormUrl
-
setPowerFormUrl
public void setPowerFormUrl(String powerFormUrl)
setPowerFormUrl.
-
recipients
public PowerForm recipients(List<PowerFormRecipient> recipients)
recipients.- Returns:
- PowerForm
-
addRecipientsItem
public PowerForm addRecipientsItem(PowerFormRecipient recipientsItem)
addRecipientsItem.- Returns:
- PowerForm
-
getRecipients
public List<PowerFormRecipient> getRecipients()
An array of powerform recipients..- Returns:
- recipients
-
setRecipients
public void setRecipients(List<PowerFormRecipient> recipients)
setRecipients.
-
getSenderName
public String getSenderName()
.- Returns:
- senderName
-
setSenderName
public void setSenderName(String senderName)
setSenderName.
-
getSenderUserId
public String getSenderUserId()
.- Returns:
- senderUserId
-
setSenderUserId
public void setSenderUserId(String senderUserId)
setSenderUserId.
-
getSigningMode
public String getSigningMode()
.- Returns:
- signingMode
-
setSigningMode
public void setSigningMode(String signingMode)
setSigningMode.
-
getTemplateId
public String getTemplateId()
The unique identifier of the template. If this is not provided, DocuSign will generate a value. .- Returns:
- templateId
-
setTemplateId
public void setTemplateId(String templateId)
setTemplateId.
-
getTemplateName
public String getTemplateName()
.- Returns:
- templateName
-
setTemplateName
public void setTemplateName(String templateName)
setTemplateName.
-
getTimesUsed
public String getTimesUsed()
.- Returns:
- timesUsed
-
setTimesUsed
public void setTimesUsed(String timesUsed)
setTimesUsed.
-
getUri
public String getUri()
.- Returns:
- uri
-
setUri
public void setUri(String uri)
setUri.
-
usesRemaining
public PowerForm usesRemaining(String usesRemaining)
usesRemaining.- Returns:
- PowerForm
-
getUsesRemaining
public String getUsesRemaining()
.- Returns:
- usesRemaining
-
setUsesRemaining
public void setUsesRemaining(String usesRemaining)
setUsesRemaining.
-
equals
public boolean equals(Object o)
Compares objects.
-
-