|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sas.hls.resource.repository.CreateSignatureInfo
public class CreateSignatureInfo
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.
SignatureService
,
SignatureService.createSignature(String, CreateSignatureInfo)
,
Serialized FormConstructor 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 |
---|
public CreateSignatureInfo()
CreateSignatureInfo
with all fields uninitialized.
Method Detail |
---|
public String getUserId()
public void setUserId(String userId)
userId
- The user ID to use when creating this signature.Signature.getUserId()
public String getPassword()
setUserId(String)
value. These credentials will be
tested as part of the signature process.
public void setPassword(String password)
password
- The password to use when creating this signature.public String getRole()
public void setRole(String role)
To retrieve the valid roles please refer to SignatureService.getSignatureRoles()
.
role
- The role to use when creating this signature.SignatureService.getSignatureRoles()
,
Signature.getRole()
public String getReason()
public void setReason(String reason)
To retrieve the valid reasons please refer to SignatureService.getSignatureReasons()
.
reason
- The reason to use when creating this signature.SignatureService.getSignatureRoles()
,
Signature.getReason()
public String getComment()
public void setComment(String comment)
comment
- The comment to use when creating this signature.Signature.getComment()
public String toString()
toString
in class Object
Object.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |