Package com.sas.lsaf.content.repository.signature

Class CreateSignatureInfo

java.lang.Object
com.sas.lsaf.content.repository.signature.CreateSignatureInfo
All Implemented Interfaces:
Serializable
public class CreateSignatureInfo extends Object implements Serializable
The class that represents the parameters that are required to create a signature. The credentials that are stored on the parameters object are tested before the electronic signature is created. If an AuthenticationException is thrown, it prevents the signature process from being completed.
Since:
1.7
See Also:

  • Constructor Details

    • CreateSignatureInfo

      public CreateSignatureInfo()
      Constructs an allocated CreateSignatureInfo with all of the fields uninitialized.

  • Method Details

    • getUserId

      public String getUserId()
      Gets the user identifier to use to create the signature.
      Returns:
      The user identifier to use to create the signature.

    • setUserId

      public void setUserId(String userId)
      Sets the user identifier to to use to create the signature. This value is required.
      Parameters:
      userId - The user identifier to use to create the signature.
      See Also:

    • getPassword

      public byte[] getPassword()
      Gets the password that is used to create the signature. The password must be the current password of the account that is specified by the setUserId(String) value. The credentials are tested as part of the signature process.
      Returns:
      The password for the signee account.

    • setPassword

      public void setPassword(byte[] password)
      Sets the password to use during the signature process. This value is required.
      Parameters:
      password - The password to use to create the signature.

    • getRole

      public String getRole()
      Gets the role to use to create the signature.
      Returns:
      The role to use to create the signature.

    • setRole

      public void setRole(String role)
      Sets the signature role to use to create signature. This value is required.

      To retrieve the valid roles, call SignatureService.getSignatureRoles().

      Parameters:
      role - The role to use to create the signature.
      See Also:

    • getReason

      public String getReason()
      Gets the signature reason to use to create the signature.
      Returns:
      The reason to use to create the signature.

    • setReason

      public void setReason(String reason)
      Sets the signature reason to use to create the signature. This value is required.

      To retrieve the valid reasons call SignatureService.getSignatureReasons().

      Parameters:
      reason - The reason to use to create the signature.
      See Also:

    • getComment

      public String getComment()
      Gets the comment to use to create the signature.
      Returns:
      The comment to use to create the signature.

    • setComment

      public void setComment(String comment)
      Sets the comment to use to create the signature. This value is optional.
      Parameters:
      comment - The comment to use to create the signature.
      See Also:

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object