com.jamasoftware.contour.ws.domain

Class WsSignature

java.lang.Object

com.jamasoftware.contour.ws.domain.WsSignature

public class WsSignature
extends Object

This object is an electronic signature of a WsBaseline.

Author:

Dylan

Constructor Summary

Constructors

Constructor and Description
WsSignature() Creates an empty WsSignature object.
WsSignature(Integer scopeId, Long refId, WsUser user, String comments) Creates a new WsSignature object from the given baseline id, user and comments.

Method Summary

Methods

Modifier and Type	Method and Description
String	getComments() Gets the comments associated with this signature.
Long	getId() Gets the id of the signature.
Boolean	getIsRevoked() Is this signature revoked?
Long	getRefId() Gets the refId of the object associated with this signature
String	getRevokeComments() Gets the comments associated with the revocation of this signature.
Date	getRevokeDate() Gets the date this signature was revoked.
Integer	getScopeId() Gets the scopeId of the object associated with this signature Valid scopes for Signatures are Baseline and Revisions
Date	getSignedDate() Gets the date this signature took place.
WsUser	getUser() Gets the user that made this signature.
void	setComments(String comments) Sets the comments associated with this signature.
void	setId(Long id) Sets the id of the signature.
void	setIsRevoked(Boolean isRevoked)
void	setRefId(Long refId) Sets the refId of the object associated with this signature
void	setRevokeComments(String revokeComments) Sets the comments associated with the revocation of this signature.
void	setRevokeDate(Date revokeDate)
void	setScopeId(Integer scopeId) Sets the scopeId of the object associated with this signature
void	setSignedDate(Date signedDate)
void	setUser(WsUser user) Sets the user that made this signature.
String	toString() Gets a string representation of this signature.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WsSignature

public WsSignature()

Creates an empty WsSignature object.

WsSignature

public WsSignature(Integer scopeId,
           Long refId,
           WsUser user,
           String comments)

Creates a new WsSignature object from the given baseline id, user and comments. SignedDate is set to the current date.

Parameters:

scopeId - scope of the object being signature

refId - id of the object being signed

user - user signing

comments - any comments about the signature (can be null)

Method Detail

getId

public Long getId()

Gets the id of the signature.

Returns:

signature id

setId

public void setId(Long id)

Sets the id of the signature.

Parameters:

id - signature id

getComments

public String getComments()

Gets the comments associated with this signature.

Returns:

signature comments

setComments

public void setComments(String comments)

Sets the comments associated with this signature.

Parameters:

comments - signature comments

getRevokeComments

public String getRevokeComments()

Gets the comments associated with the revocation of this signature.

Returns:

signature revocation comments

setRevokeComments

public void setRevokeComments(String revokeComments)

Sets the comments associated with the revocation of this signature.

Parameters:

revokeComments - signature revocation comments

getUser

public WsUser getUser()

Gets the user that made this signature.

Returns:

WsUser

setUser

public void setUser(WsUser user)

Sets the user that made this signature.

Parameters:

user - WsUser

getSignedDate

public Date getSignedDate()

Gets the date this signature took place.

Returns:

signature date

setSignedDate

public void setSignedDate(Date signedDate)

getIsRevoked

public Boolean getIsRevoked()

Is this signature revoked?

Returns:

whether or not the signature is revoked

setIsRevoked

public void setIsRevoked(Boolean isRevoked)

getRevokeDate

public Date getRevokeDate()

Gets the date this signature was revoked.

Returns:

signature revocation date

setRevokeDate

public void setRevokeDate(Date revokeDate)

getScopeId

public Integer getScopeId()

Gets the scopeId of the object associated with this signature Valid scopes for Signatures are Baseline and Revisions

Returns:

signed object scopeId

setScopeId

public void setScopeId(Integer scopeId)

Sets the scopeId of the object associated with this signature

Parameters:

scopeId - scopeId of the object being signed

getRefId

public Long getRefId()

Gets the refId of the object associated with this signature

Returns:

signed object refId

setRefId

public void setRefId(Long refId)

Sets the refId of the object associated with this signature

Parameters:

refId - refId of the object being signed

toString

public String toString()

Gets a string representation of this signature.

Overrides:

toString in class Object

Returns:

String