Signer (sdk 11.50 API)

java.lang.Object
- com.silanis.esl.sdk.Signer

All Implemented Interfaces:

Serializable
```
public class Signer
extends Object
implements Serializable
```
The Signer class contains all the information about an user that is supposed to sign a document.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Signer(GroupId groupId)`
`Signer(String id)`
`Signer(String email, String firstName, String lastName, Authentication authentication)` The constructor of the Signer class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttachmentRequirement(AttachmentRequirement attachment)`
`boolean`	`canChangeSigner()` It tells if a signer can reassign or not the signing request to another signer.
`AttachmentRequirement`	`getAttachmentRequirement(String attachmentName)`
`List<AttachmentRequirement>`	`getAttachmentRequirements()`
`Authentication`	`getAuthentication()`
`AuthenticationMethod`	`getAuthenticationMethod()` Accessor method used to retrieve the authentication method used by the signer
`List<Challenge>`	`getChallengeQuestions()` Accessor method used to retrieve the challenge question
`String`	`getCompany()` Accessor method used to retrieve the signer's company
`String`	`getEmail()` Accessor method used to retrieve the signer's email
`String`	`getFirstName()` Accessor method used to retrieve the signer's first name
`GroupId`	`getGroupId()`
`String`	`getId()` Accessor method used to retrieve the signer's ID
`KnowledgeBasedAuthentication`	`getKnowledgeBasedAuthentication()`
`Locale`	`getLanguage()` Accessor method used to retrieve the signer's language
`String`	`getLastName()` Accessor method used to retrieve the signer's last name
`String`	`getLocalLanguage()`
`String`	`getMessage()`
`String`	`getPhoneNumber()` Accessor method used to retrieve the signer's phone number
`String`	`getPlaceholderName()`
`String`	`getSignerType()` Accessor method used to retrieve the signer's type
`int`	`getSigningOrder()` Accessor method used to retrieve the signer's signing order inside the document
`String`	`getTitle()` Accessor method used to retrieve the signer's title
`boolean`	`isDeliverSignedDocumentsByEmail()` Provides the value set for the deliverSignedDocumentsByEmail property
`boolean`	`isGroupSigner()`
`boolean`	`isLocked()`
`boolean`	`isPlaceholderSigner()`
`void`	`setAttachmentRequirements(List<AttachmentRequirement> attachments)`
`void`	`setCanChangeSigner(boolean canChangeSigner)` Accessor method used to set the
`void`	`setCompany(String company)` Accessor method used to set the signer's company
`void`	`setDeliverSignedDocumentsByEmail(boolean deliverSignedDocumentsByEmail)` Accessor method used to set the deliverSignedDocumentsByEmail.
`void`	`setId(String id)` Accessor method used to set the signer's ID.
`void`	`setKnowledgeBasedAuthentication(KnowledgeBasedAuthentication knowledgeBasedAuthentication)`
`void`	`setLanguage(Locale language)` Accessor method used to set the signer's language
`void`	`setLocalLanguage(String localLanguage)`
`void`	`setLocked(boolean locked)`
`void`	`setMessage(String message)`
`void`	`setPlaceholderName(String placeholderName)`
`void`	`setSignerType(String signerType)` Accessor method used to set the signer's type
`void`	`setSigningOrder(int signingOrder)` Accessor method used to set the signer's signing order inside the document
`void`	`setTitle(String title)` Accessor method used to set the signer's title

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Signer
```
public Signer(String email,
              String firstName,
              String lastName,
              Authentication authentication)
```
    The constructor of the Signer class.
    
    Parameters:
    
    email - the email address
    
    firstName - the first name
    
    lastName - the last name
    
    authentication - the authentication used by the signer to join to a eSL signing ceremony
  - Signer
```
public Signer(GroupId groupId)
```
  - Signer
```
public Signer(String id)
```
- Method Detail
  - isGroupSigner
```
public boolean isGroupSigner()
```
  - isPlaceholderSigner
```
public boolean isPlaceholderSigner()
```
  - getEmail
```
public String getEmail()
```
    Accessor method used to retrieve the signer's email
    
    Returns:
    
    the signer's email
  - getFirstName
```
public String getFirstName()
```
    Accessor method used to retrieve the signer's first name
    
    Returns:
    
    the signer's first name
  - getLastName
```
public String getLastName()
```
    Accessor method used to retrieve the signer's last name
    
    Returns:
    
    the signer's last name
  - setSigningOrder
```
public void setSigningOrder(int signingOrder)
```
    Accessor method used to set the signer's signing order inside the document
    
    Parameters:
    
    signingOrder - the signing order inside the document
  - getSigningOrder
```
public int getSigningOrder()
```
    Accessor method used to retrieve the signer's signing order inside the document
    
    Returns:
    
    the signer's signing order
  - getAuthentication
```
public Authentication getAuthentication()
```
  - getAuthenticationMethod
```
public AuthenticationMethod getAuthenticationMethod()
```
    Accessor method used to retrieve the authentication method used by the signer
    
    Returns:
    
    the authentication method
  - getChallengeQuestions
```
public List<Challenge> getChallengeQuestions()
```
    Accessor method used to retrieve the challenge question
    
    Returns:
    
    the challenge question
  - getPhoneNumber
```
public String getPhoneNumber()
```
    Accessor method used to retrieve the signer's phone number
    
    Returns:
    
    the phone number
  - getTitle
```
public String getTitle()
```
    Accessor method used to retrieve the signer's title
    
    Returns:
    
    the signer's title
  - getCompany
```
public String getCompany()
```
    Accessor method used to retrieve the signer's company
    
    Returns:
    
    the signer's company
  - getSignerType
```
public String getSignerType()
```
    Accessor method used to retrieve the signer's type
    
    Returns:
    
    the signer's type
  - setSignerType
```
public void setSignerType(String signerType)
```
    Accessor method used to set the signer's type
    
    Parameters:
    
    signerType - the signer's type
  - setTitle
```
public void setTitle(String title)
```
    Accessor method used to set the signer's title
    
    Parameters:
    
    title - the signer's title
  - setCompany
```
public void setCompany(String company)
```
    Accessor method used to set the signer's company
    
    Parameters:
    
    company - the signer's company
  - getLanguage
```
public Locale getLanguage()
```
    Accessor method used to retrieve the signer's language
    
    Returns:
    
    the signer's language
  - setLanguage
```
public void setLanguage(Locale language)
```
    Accessor method used to set the signer's language
    
    Parameters:
    
    language - the signer's language
  - setCanChangeSigner
```
public void setCanChangeSigner(boolean canChangeSigner)
```
    Accessor method used to set the
    
    Parameters:
    
    canChangeSigner -
  - canChangeSigner
```
public boolean canChangeSigner()
```
    It tells if a signer can reassign or not the signing request to another signer.
    
    Returns:
    
    if true it means that the signer can reassign the signing request to another signer
  - setMessage
```
public void setMessage(String message)
```
    Parameters:
    
    message -
  - getMessage
```
public String getMessage()
```
  - setDeliverSignedDocumentsByEmail
```
public void setDeliverSignedDocumentsByEmail(boolean deliverSignedDocumentsByEmail)
```
    Accessor method used to set the deliverSignedDocumentsByEmail.
    
    If a Signer instance has this property set to true it means that the documents once signed will be delivered to the signer by email.
    
    Parameters:
    
    deliverSignedDocumentsByEmail -
  - isDeliverSignedDocumentsByEmail
```
public boolean isDeliverSignedDocumentsByEmail()
```
    Provides the value set for the deliverSignedDocumentsByEmail property
    
    Returns:
    
    the value set for the deliverSignedDocumentsByEmail property
  - setId
```
public void setId(String id)
```
    Accessor method used to set the signer's ID.
    
    This ID should be uniquely defined at the document package level
    
    Parameters:
    
    id - the signer's ID
  - getId
```
public String getId()
```
    Accessor method used to retrieve the signer's ID
    
    Returns:
    
    the signer's ID
  - getGroupId
```
public GroupId getGroupId()
```
  - getPlaceholderName
```
public String getPlaceholderName()
```
  - setPlaceholderName
```
public void setPlaceholderName(String placeholderName)
```
  - setLocked
```
public void setLocked(boolean locked)
```
  - isLocked
```
public boolean isLocked()
```
  - getAttachmentRequirements
```
public List<AttachmentRequirement> getAttachmentRequirements()
```
  - getAttachmentRequirement
```
public AttachmentRequirement getAttachmentRequirement(String attachmentName)
```
  - setAttachmentRequirements
```
public void setAttachmentRequirements(List<AttachmentRequirement> attachments)
```
  - addAttachmentRequirement
```
public void addAttachmentRequirement(AttachmentRequirement attachment)
```
  - getKnowledgeBasedAuthentication
```
public KnowledgeBasedAuthentication getKnowledgeBasedAuthentication()
```
  - setKnowledgeBasedAuthentication
```
public void setKnowledgeBasedAuthentication(KnowledgeBasedAuthentication knowledgeBasedAuthentication)
```
  - getLocalLanguage
```
public String getLocalLanguage()
```
  - setLocalLanguage
```
public void setLocalLanguage(String localLanguage)
```

Class Signer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Signer

Signer

Signer

Method Detail

isGroupSigner

isPlaceholderSigner

getEmail

getFirstName

getLastName

setSigningOrder

getSigningOrder

getAuthentication

getAuthenticationMethod

getChallengeQuestions

getPhoneNumber

getTitle

getCompany

getSignerType

setSignerType

setTitle

setCompany

getLanguage

setLanguage

setCanChangeSigner

canChangeSigner

setMessage

getMessage

setDeliverSignedDocumentsByEmail

isDeliverSignedDocumentsByEmail

setId

getId

getGroupId

getPlaceholderName

setPlaceholderName

setLocked

isLocked

getAttachmentRequirements

getAttachmentRequirement

setAttachmentRequirements

addAttachmentRequirement

getKnowledgeBasedAuthentication

setKnowledgeBasedAuthentication

getLocalLanguage

setLocalLanguage