Package com.smartsheet.api.models
Class Proof
- java.lang.Object
-
- com.smartsheet.api.models.IdentifiableModel<T>
-
- com.smartsheet.api.models.NamedModel<java.lang.Long>
-
- com.smartsheet.api.models.Proof
-
public class Proof extends NamedModel<java.lang.Long>
Represents the Proof object. A proof is a container that holds attachments and comments for review, editing, or approval.
-
-
Constructor Summary
Constructors Constructor Description Proof()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<Attachment>getAttachments()Gets the attachments associated with the proof.java.util.List<Discussion>getDiscussions()Gets the discussions associated with the proof.java.lang.StringgetDocumentType()Gets the document type of the proof.java.lang.BooleangetIsCompleted()Indicates whether the proof is completed.java.util.DategetLastUpdatedAt()Gets the date and time the proof was last updated.UsergetLastUpdatedBy()Gets the user who last updated the proof.java.lang.LonggetOriginalId()Gets the ID of the original proof version.java.lang.StringgetProofRequestUrl()Gets the URL used to request the proof.ProofTypegetType()Gets the type of the proof.java.lang.IntegergetVersion()Gets the version number of the proof.ProofsetAttachments(java.util.List<Attachment> attachments)Sets the attachments associated with the proof.ProofsetDiscussions(java.util.List<Discussion> discussions)Sets the discussions associated with the proof.ProofsetDocumentType(java.lang.String documentType)Sets the document type of the proof.ProofsetIsCompleted(java.lang.Boolean isCompleted)Sets whether the proof is completed.ProofsetLastUpdatedAt(java.util.Date lastUpdatedAt)Sets the date and time the proof was last updated.ProofsetLastUpdatedBy(User lastUpdatedBy)Sets the user who last updated the proof.ProofsetName(java.lang.String name)Provide an 'override' of setName (returns Proof not NamedModel)ProofsetOriginalId(java.lang.Long originalId)Sets the ID of the original proof version.ProofsetProofRequestUrl(java.lang.String proofRequestUrl)Sets the URL used to request the proof.ProofsetType(ProofType type)Sets the type of the proof.ProofsetVersion(java.lang.Integer version)Sets the version number of the proof.-
Methods inherited from class com.smartsheet.api.models.NamedModel
getName
-
Methods inherited from class com.smartsheet.api.models.IdentifiableModel
equals, getId, hashCode, setId
-
-
-
-
Method Detail
-
setName
public Proof setName(java.lang.String name)
Provide an 'override' of setName (returns Proof not NamedModel)- Overrides:
setNamein classNamedModel<java.lang.Long>- Parameters:
name- the new name
-
getOriginalId
public java.lang.Long getOriginalId()
Gets the ID of the original proof version.- Returns:
- the original id
-
setOriginalId
public Proof setOriginalId(java.lang.Long originalId)
Sets the ID of the original proof version.- Parameters:
originalId- the new original id
-
getType
public ProofType getType()
Gets the type of the proof.- Returns:
- the proof type
-
setType
public Proof setType(ProofType type)
Sets the type of the proof.- Parameters:
type- the new proof type
-
getDocumentType
public java.lang.String getDocumentType()
Gets the document type of the proof.- Returns:
- the document type
-
setDocumentType
public Proof setDocumentType(java.lang.String documentType)
Sets the document type of the proof.- Parameters:
documentType- the new document type
-
getProofRequestUrl
public java.lang.String getProofRequestUrl()
Gets the URL used to request the proof.- Returns:
- the proof request url
-
setProofRequestUrl
public Proof setProofRequestUrl(java.lang.String proofRequestUrl)
Sets the URL used to request the proof.- Parameters:
proofRequestUrl- the new proof request url
-
getVersion
public java.lang.Integer getVersion()
Gets the version number of the proof.- Returns:
- the version
-
setVersion
public Proof setVersion(java.lang.Integer version)
Sets the version number of the proof.- Parameters:
version- the new version
-
getLastUpdatedAt
public java.util.Date getLastUpdatedAt()
Gets the date and time the proof was last updated.- Returns:
- the last updated at
-
setLastUpdatedAt
public Proof setLastUpdatedAt(java.util.Date lastUpdatedAt)
Sets the date and time the proof was last updated.- Parameters:
lastUpdatedAt- the new last updated at
-
getLastUpdatedBy
public User getLastUpdatedBy()
Gets the user who last updated the proof.- Returns:
- the last updated by user
-
setLastUpdatedBy
public Proof setLastUpdatedBy(User lastUpdatedBy)
Sets the user who last updated the proof.- Parameters:
lastUpdatedBy- the new last updated by user
-
getIsCompleted
public java.lang.Boolean getIsCompleted()
Indicates whether the proof is completed.- Returns:
- the completed status
-
setIsCompleted
public Proof setIsCompleted(java.lang.Boolean isCompleted)
Sets whether the proof is completed.- Parameters:
isCompleted- the new completed status
-
getAttachments
public java.util.List<Attachment> getAttachments()
Gets the attachments associated with the proof.- Returns:
- the attachments
-
setAttachments
public Proof setAttachments(java.util.List<Attachment> attachments)
Sets the attachments associated with the proof.- Parameters:
attachments- the new attachments
-
getDiscussions
public java.util.List<Discussion> getDiscussions()
Gets the discussions associated with the proof.- Returns:
- the discussions
-
setDiscussions
public Proof setDiscussions(java.util.List<Discussion> discussions)
Sets the discussions associated with the proof.- Parameters:
discussions- the new discussions
-
-