com.sas.hls.resource.repository
Class CreateSignatureInfo

java.lang.Object
  extended by com.sas.hls.resource.repository.CreateSignatureInfo
All Implemented Interfaces:
Serializable

public class CreateSignatureInfo
extends Object
implements Serializable

Parameters that are necessary when creating an electronic signature. The credentials stored on the parameters object will be tested before the electronic signature is created so any AuthenticationException which is thrown will prevent the signature process from being completed.

Since:
1.7
See Also:
SignatureService, SignatureService.createSignature(String, CreateSignatureInfo), Serialized Form

Constructor Summary
CreateSignatureInfo()
          Constructs a newly allocated CreateSignatureInfo with all fields uninitialized.
 
Method Summary
 String getComment()
          Return the comment to use when creating this electronic signature.
 String getPassword()
          Returns the password which will be used in the creation of this electronic signature.
 String getReason()
          Return the signature reason to use when creating this electronic signature.
 String getRole()
          Return the signature role to use when creating this electronic signature.
 String getUserId()
          Returns the user ID which will be used in the creation of this electronic signature.
 void setComment(String comment)
          Set the comment to use when creating this electronic signature.
 void setPassword(String password)
          Set the password to be used during the electronic signature process.
 void setReason(String reason)
          Set the signature reason to use when creating this electronic signature.
 void setRole(String role)
          Set the signature role to use when creating this electronic signature.
 void setUserId(String userId)
          Set the user ID to be used in the creation of this electronic signature.
 String toString()
          Return a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CreateSignatureInfo

public CreateSignatureInfo()
Constructs a newly allocated CreateSignatureInfo with all fields uninitialized.

Method Detail

getUserId

public String getUserId()
Returns the user ID which will be used in the creation of this electronic signature.

Returns:
The user ID of the signee.

setUserId

public void setUserId(String userId)
Set the user ID to be used in the creation of this electronic signature. This value is required.

Parameters:
userId - The user ID to use when creating this signature.
See Also:
Signature.getUserId()

getPassword

public String getPassword()
Returns the password which will be used in the creation of this electronic signature. This password must be the current password of the account designated by the setUserId(String) value. These credentials will be tested as part of the signature process.

Returns:
The password for the signee account.

setPassword

public void setPassword(String password)
Set the password to be used during the electronic signature process. This value is required.

Parameters:
password - The password to use when creating this signature.

getRole

public String getRole()
Return the signature role to use when creating this electronic signature.

Returns:
The role to use when creating this signature.

setRole

public void setRole(String role)
Set the signature role to use when creating this electronic signature. This value is required.

To retrieve the valid roles please refer to SignatureService.getSignatureRoles().

Parameters:
role - The role to use when creating this signature.
See Also:
SignatureService.getSignatureRoles(), Signature.getRole()

getReason

public String getReason()
Return the signature reason to use when creating this electronic signature.

Returns:
The reason to use when creating this signature.

setReason

public void setReason(String reason)
Set the signature reason to use when creating this electronic signature. This value is required.

To retrieve the valid reasons please refer to SignatureService.getSignatureReasons().

Parameters:
reason - The reason to use when creating this signature.
See Also:
SignatureService.getSignatureRoles(), Signature.getReason()

getComment

public String getComment()
Return the comment to use when creating this electronic signature.

Returns:
The comment to use when creating this signature.

setComment

public void setComment(String comment)
Set the comment to use when creating this electronic signature. This value is optional.

Parameters:
comment - The comment to use when creating this signature.
See Also:
Signature.getComment()

toString

public String toString()
Return a string representation of the object.

Overrides:
toString in class Object
See Also:
Object.toString()


Copyright (c) 2016, SAS Institute Inc., Cary, NC, USA