com.sas.hls.resource.repository
Class Signature

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

public class Signature
extends Object
implements Serializable

Client side representation of an electronic signature created in the SAS Drug Development repository.

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

Constructor Summary
Signature(String identifier, String repositoryFileIdentifier, String repositoryFilePath, String repositoryFileVersion, String userId, String role, String reason, String comment, Date timestamp, String signature)
          Constructs a newly allocated Signature with all fields initialized.
 
Method Summary
 boolean equals(Object obj)
          Indicate whether some other object is "equal to" this one.
 String getComment()
          Returns the comment provided with this electronic signature, if one was provided.
 String getIdentifier()
          Returns the unique identifier of this electronic signature.
 String getReason()
          Returns the signature reason used when creating this electronic signature.
 String getRepositoryFileIdentifier()
          Returns the unique identifier of the repository file associated with this electronic signature.
 String getRepositoryFilePath()
          Returns the path of the repository file associated with this electronic signature.
 String getRepositoryFileVersion()
          Returns the version of the repository file associated with this electronic signature.
 String getRole()
          Returns the signature role used when creating this electronic signature.
 String getSignature()
          Returns the signature hash generated when this electronic signature was created.
 Date getTimestamp()
          Returns the Date when this electronic signature was created.
 String getUserId()
          Returns the user ID of the user who created this electronic signature.
 int hashCode()
          Return a hash code value for the object.
 String toString()
          Return a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Signature

public Signature(String identifier,
                 String repositoryFileIdentifier,
                 String repositoryFilePath,
                 String repositoryFileVersion,
                 String userId,
                 String role,
                 String reason,
                 String comment,
                 Date timestamp,
                 String signature)
Constructs a newly allocated Signature with all fields initialized.

Parameters:
identifier - The unique identifier of this electronic signature.
repositoryFileIdentifier - The unique identifier of the repository file associated with this electronic signature.
repositoryFilePath - The path of the repository file associated with this electronic signature.
repositoryFileVersion - The version of the repository file associated with this electronic signature.
userId - The user ID of the user who created this electronic signature.
role - The signature role used when creating this electronic signature.
reason - The signature reason used when creating this electronic signature.
comment - The comment provided with this electronic signature.
timestamp - The Date when this electronic signature was created.
signature - The signature value generated when this electronic signature was created.
Method Detail

getIdentifier

public String getIdentifier()
Returns the unique identifier of this electronic signature. This identifier is generated by the system when creating the signature.

Returns:
The identifier of this signature.

getRepositoryFileIdentifier

public String getRepositoryFileIdentifier()
Returns the unique identifier of the repository file associated with this electronic signature.

Returns:
The identifier of the repository file associated with this signature.
See Also:
RepositoryResource.getIdentifier()

getRepositoryFilePath

public String getRepositoryFilePath()
Returns the path of the repository file associated with this electronic signature.

Returns:
The path of the repository file associated with this signature.
See Also:
RepositoryResource.getPath()

getRepositoryFileVersion

public String getRepositoryFileVersion()
Returns the version of the repository file associated with this electronic signature. This value will be null if the file is unversioned.

Returns:
The version of the repository file associated with this signature.

getUserId

public String getUserId()
Returns the user ID of the user who created this electronic signature.

Returns:
The user ID associated with this signature.

getRole

public String getRole()
Returns the signature role used when creating this electronic signature.

Returns:
The role associated with this signature.
See Also:
CreateSignatureInfo.setRole(String), SignatureService.getSignatureRoles()

getReason

public String getReason()
Returns the signature reason used when creating this electronic signature.

Returns:
The reason associated with this signature.
See Also:
CreateSignatureInfo.setReason(String), SignatureService.getSignatureReasons()

getComment

public String getComment()
Returns the comment provided with this electronic signature, if one was provided.

Returns:
The comment associated with this signature.
See Also:
CreateSignatureInfo.setComment(String)

getTimestamp

public Date getTimestamp()
Returns the Date when this electronic signature was created.

Returns:
The date and time when this signature was created.

getSignature

public String getSignature()
Returns the signature hash generated when this electronic signature was created.

Returns:
The actual signature value generated when this file was signed.

hashCode

public int hashCode()
Return a hash code value for the object.

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

equals

public boolean equals(Object obj)
Indicate whether some other object is "equal to" this one.

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

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