Package com.docusign.esign.model
Class PowerForm
- java.lang.Object
-
- com.docusign.esign.model.PowerForm
-
public class PowerForm extends java.lang.ObjectPowerForm.
-
-
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(java.lang.String createdBy)createdBy.PowerFormcreatedDateTime(java.lang.String createdDateTime)createdDateTime.PowerFormemailBody(java.lang.String emailBody)emailBody.PowerFormemailSubject(java.lang.String emailSubject)emailSubject.PowerFormenvelopes(java.util.List<Envelope> envelopes)envelopes.booleanequals(java.lang.Object o)Compares objects.PowerFormerrorDetails(ErrorDetails errorDetails)errorDetails.java.lang.StringgetCreatedBy().java.lang.StringgetCreatedDateTime()Indicates the date and time the item was created..java.lang.StringgetEmailBody()Specifies the email body of the message sent to the recipient.java.lang.StringgetEmailSubject()Specifies the subject of the email that is sent to all recipients.java.util.List<Envelope>getEnvelopes().ErrorDetailsgetErrorDetails()Get errorDetails.java.lang.StringgetInstructions().java.lang.StringgetIsActive().java.lang.StringgetLastUsed().java.lang.StringgetLimitUseInterval().java.lang.StringgetLimitUseIntervalEnabled().java.lang.StringgetLimitUseIntervalUnits().java.lang.StringgetMaxUseEnabled().java.lang.StringgetName().java.lang.StringgetPowerFormId().java.lang.StringgetPowerFormUrl().java.util.List<PowerFormRecipient>getRecipients()An array of powerform recipients..java.lang.StringgetSenderName().java.lang.StringgetSenderUserId().java.lang.StringgetSigningMode().java.lang.StringgetTemplateId()The unique identifier of the template.java.lang.StringgetTemplateName().java.lang.StringgetTimesUsed().java.lang.StringgetUri().java.lang.StringgetUsesRemaining().inthashCode()Returns the HashCode.PowerForminstructions(java.lang.String instructions)instructions.PowerFormisActive(java.lang.String isActive)isActive.PowerFormlastUsed(java.lang.String lastUsed)lastUsed.PowerFormlimitUseInterval(java.lang.String limitUseInterval)limitUseInterval.PowerFormlimitUseIntervalEnabled(java.lang.String limitUseIntervalEnabled)limitUseIntervalEnabled.PowerFormlimitUseIntervalUnits(java.lang.String limitUseIntervalUnits)limitUseIntervalUnits.PowerFormmaxUseEnabled(java.lang.String maxUseEnabled)maxUseEnabled.PowerFormname(java.lang.String name)name.PowerFormpowerFormId(java.lang.String powerFormId)powerFormId.PowerFormpowerFormUrl(java.lang.String powerFormUrl)powerFormUrl.PowerFormrecipients(java.util.List<PowerFormRecipient> recipients)recipients.PowerFormsenderName(java.lang.String senderName)senderName.PowerFormsenderUserId(java.lang.String senderUserId)senderUserId.voidsetCreatedBy(java.lang.String createdBy)setCreatedBy.voidsetCreatedDateTime(java.lang.String createdDateTime)setCreatedDateTime.voidsetEmailBody(java.lang.String emailBody)setEmailBody.voidsetEmailSubject(java.lang.String emailSubject)setEmailSubject.voidsetEnvelopes(java.util.List<Envelope> envelopes)setEnvelopes.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetInstructions(java.lang.String instructions)setInstructions.voidsetIsActive(java.lang.String isActive)setIsActive.voidsetLastUsed(java.lang.String lastUsed)setLastUsed.voidsetLimitUseInterval(java.lang.String limitUseInterval)setLimitUseInterval.voidsetLimitUseIntervalEnabled(java.lang.String limitUseIntervalEnabled)setLimitUseIntervalEnabled.voidsetLimitUseIntervalUnits(java.lang.String limitUseIntervalUnits)setLimitUseIntervalUnits.voidsetMaxUseEnabled(java.lang.String maxUseEnabled)setMaxUseEnabled.voidsetName(java.lang.String name)setName.voidsetPowerFormId(java.lang.String powerFormId)setPowerFormId.voidsetPowerFormUrl(java.lang.String powerFormUrl)setPowerFormUrl.voidsetRecipients(java.util.List<PowerFormRecipient> recipients)setRecipients.voidsetSenderName(java.lang.String senderName)setSenderName.voidsetSenderUserId(java.lang.String senderUserId)setSenderUserId.voidsetSigningMode(java.lang.String signingMode)setSigningMode.voidsetTemplateId(java.lang.String templateId)setTemplateId.voidsetTemplateName(java.lang.String templateName)setTemplateName.voidsetTimesUsed(java.lang.String timesUsed)setTimesUsed.voidsetUri(java.lang.String uri)setUri.voidsetUsesRemaining(java.lang.String usesRemaining)setUsesRemaining.PowerFormsigningMode(java.lang.String signingMode)signingMode.PowerFormtemplateId(java.lang.String templateId)templateId.PowerFormtemplateName(java.lang.String templateName)templateName.PowerFormtimesUsed(java.lang.String timesUsed)timesUsed.java.lang.StringtoString()Converts the given object to string.PowerFormuri(java.lang.String uri)uri.PowerFormusesRemaining(java.lang.String usesRemaining)usesRemaining.
-
-
-
Method Detail
-
createdBy
public PowerForm createdBy(java.lang.String createdBy)
createdBy.- Returns:
- PowerForm
-
getCreatedBy
public java.lang.String getCreatedBy()
.- Returns:
- createdBy
-
setCreatedBy
public void setCreatedBy(java.lang.String createdBy)
setCreatedBy.
-
createdDateTime
public PowerForm createdDateTime(java.lang.String createdDateTime)
createdDateTime.- Returns:
- PowerForm
-
getCreatedDateTime
public java.lang.String getCreatedDateTime()
Indicates the date and time the item was created..- Returns:
- createdDateTime
-
setCreatedDateTime
public void setCreatedDateTime(java.lang.String createdDateTime)
setCreatedDateTime.
-
emailBody
public PowerForm emailBody(java.lang.String emailBody)
emailBody.- Returns:
- PowerForm
-
getEmailBody
public java.lang.String getEmailBody()
Specifies the email body of the message sent to the recipient. Maximum length: 10000 characters. .- Returns:
- emailBody
-
setEmailBody
public void setEmailBody(java.lang.String emailBody)
setEmailBody.
-
emailSubject
public PowerForm emailSubject(java.lang.String emailSubject)
emailSubject.- Returns:
- PowerForm
-
getEmailSubject
public java.lang.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(java.lang.String emailSubject)
setEmailSubject.
-
envelopes
public PowerForm envelopes(java.util.List<Envelope> envelopes)
envelopes.- Returns:
- PowerForm
-
addEnvelopesItem
public PowerForm addEnvelopesItem(Envelope envelopesItem)
addEnvelopesItem.- Returns:
- PowerForm
-
getEnvelopes
public java.util.List<Envelope> getEnvelopes()
.- Returns:
- envelopes
-
setEnvelopes
public void setEnvelopes(java.util.List<Envelope> envelopes)
setEnvelopes.
-
errorDetails
public PowerForm errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- PowerForm
-
getErrorDetails
public ErrorDetails getErrorDetails()
Get errorDetails.- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
instructions
public PowerForm instructions(java.lang.String instructions)
instructions.- Returns:
- PowerForm
-
getInstructions
public java.lang.String getInstructions()
.- Returns:
- instructions
-
setInstructions
public void setInstructions(java.lang.String instructions)
setInstructions.
-
isActive
public PowerForm isActive(java.lang.String isActive)
isActive.- Returns:
- PowerForm
-
getIsActive
public java.lang.String getIsActive()
.- Returns:
- isActive
-
setIsActive
public void setIsActive(java.lang.String isActive)
setIsActive.
-
lastUsed
public PowerForm lastUsed(java.lang.String lastUsed)
lastUsed.- Returns:
- PowerForm
-
getLastUsed
public java.lang.String getLastUsed()
.- Returns:
- lastUsed
-
setLastUsed
public void setLastUsed(java.lang.String lastUsed)
setLastUsed.
-
limitUseInterval
public PowerForm limitUseInterval(java.lang.String limitUseInterval)
limitUseInterval.- Returns:
- PowerForm
-
getLimitUseInterval
public java.lang.String getLimitUseInterval()
.- Returns:
- limitUseInterval
-
setLimitUseInterval
public void setLimitUseInterval(java.lang.String limitUseInterval)
setLimitUseInterval.
-
limitUseIntervalEnabled
public PowerForm limitUseIntervalEnabled(java.lang.String limitUseIntervalEnabled)
limitUseIntervalEnabled.- Returns:
- PowerForm
-
getLimitUseIntervalEnabled
public java.lang.String getLimitUseIntervalEnabled()
.- Returns:
- limitUseIntervalEnabled
-
setLimitUseIntervalEnabled
public void setLimitUseIntervalEnabled(java.lang.String limitUseIntervalEnabled)
setLimitUseIntervalEnabled.
-
limitUseIntervalUnits
public PowerForm limitUseIntervalUnits(java.lang.String limitUseIntervalUnits)
limitUseIntervalUnits.- Returns:
- PowerForm
-
getLimitUseIntervalUnits
public java.lang.String getLimitUseIntervalUnits()
.- Returns:
- limitUseIntervalUnits
-
setLimitUseIntervalUnits
public void setLimitUseIntervalUnits(java.lang.String limitUseIntervalUnits)
setLimitUseIntervalUnits.
-
maxUseEnabled
public PowerForm maxUseEnabled(java.lang.String maxUseEnabled)
maxUseEnabled.- Returns:
- PowerForm
-
getMaxUseEnabled
public java.lang.String getMaxUseEnabled()
.- Returns:
- maxUseEnabled
-
setMaxUseEnabled
public void setMaxUseEnabled(java.lang.String maxUseEnabled)
setMaxUseEnabled.
-
name
public PowerForm name(java.lang.String name)
name.- Returns:
- PowerForm
-
getName
public java.lang.String getName()
.- Returns:
- name
-
setName
public void setName(java.lang.String name)
setName.
-
powerFormId
public PowerForm powerFormId(java.lang.String powerFormId)
powerFormId.- Returns:
- PowerForm
-
getPowerFormId
public java.lang.String getPowerFormId()
.- Returns:
- powerFormId
-
setPowerFormId
public void setPowerFormId(java.lang.String powerFormId)
setPowerFormId.
-
powerFormUrl
public PowerForm powerFormUrl(java.lang.String powerFormUrl)
powerFormUrl.- Returns:
- PowerForm
-
getPowerFormUrl
public java.lang.String getPowerFormUrl()
.- Returns:
- powerFormUrl
-
setPowerFormUrl
public void setPowerFormUrl(java.lang.String powerFormUrl)
setPowerFormUrl.
-
recipients
public PowerForm recipients(java.util.List<PowerFormRecipient> recipients)
recipients.- Returns:
- PowerForm
-
addRecipientsItem
public PowerForm addRecipientsItem(PowerFormRecipient recipientsItem)
addRecipientsItem.- Returns:
- PowerForm
-
getRecipients
public java.util.List<PowerFormRecipient> getRecipients()
An array of powerform recipients..- Returns:
- recipients
-
setRecipients
public void setRecipients(java.util.List<PowerFormRecipient> recipients)
setRecipients.
-
senderName
public PowerForm senderName(java.lang.String senderName)
senderName.- Returns:
- PowerForm
-
getSenderName
public java.lang.String getSenderName()
.- Returns:
- senderName
-
setSenderName
public void setSenderName(java.lang.String senderName)
setSenderName.
-
senderUserId
public PowerForm senderUserId(java.lang.String senderUserId)
senderUserId.- Returns:
- PowerForm
-
getSenderUserId
public java.lang.String getSenderUserId()
.- Returns:
- senderUserId
-
setSenderUserId
public void setSenderUserId(java.lang.String senderUserId)
setSenderUserId.
-
signingMode
public PowerForm signingMode(java.lang.String signingMode)
signingMode.- Returns:
- PowerForm
-
getSigningMode
public java.lang.String getSigningMode()
.- Returns:
- signingMode
-
setSigningMode
public void setSigningMode(java.lang.String signingMode)
setSigningMode.
-
templateId
public PowerForm templateId(java.lang.String templateId)
templateId.- Returns:
- PowerForm
-
getTemplateId
public java.lang.String getTemplateId()
The unique identifier of the template. If this is not provided, DocuSign will generate a value. .- Returns:
- templateId
-
setTemplateId
public void setTemplateId(java.lang.String templateId)
setTemplateId.
-
templateName
public PowerForm templateName(java.lang.String templateName)
templateName.- Returns:
- PowerForm
-
getTemplateName
public java.lang.String getTemplateName()
.- Returns:
- templateName
-
setTemplateName
public void setTemplateName(java.lang.String templateName)
setTemplateName.
-
timesUsed
public PowerForm timesUsed(java.lang.String timesUsed)
timesUsed.- Returns:
- PowerForm
-
getTimesUsed
public java.lang.String getTimesUsed()
.- Returns:
- timesUsed
-
setTimesUsed
public void setTimesUsed(java.lang.String timesUsed)
setTimesUsed.
-
uri
public PowerForm uri(java.lang.String uri)
uri.- Returns:
- PowerForm
-
getUri
public java.lang.String getUri()
.- Returns:
- uri
-
setUri
public void setUri(java.lang.String uri)
setUri.
-
usesRemaining
public PowerForm usesRemaining(java.lang.String usesRemaining)
usesRemaining.- Returns:
- PowerForm
-
getUsesRemaining
public java.lang.String getUsesRemaining()
.- Returns:
- usesRemaining
-
setUsesRemaining
public void setUsesRemaining(java.lang.String usesRemaining)
setUsesRemaining.
-
equals
public boolean equals(java.lang.Object o)
Compares objects.- Overrides:
equalsin classjava.lang.Object- Returns:
- true or false depending on comparison result.
-
hashCode
public int hashCode()
Returns the HashCode.- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
Converts the given object to string.- Overrides:
toStringin classjava.lang.Object
-
-