Jive API (3.0.13) Core Javadocs

com.jivesoftware.community
Class ApprovalStatus

java.lang.Object
  extended by com.jivesoftware.community.ApprovalStatus
All Implemented Interfaces:
Serializable

public class ApprovalStatus
extends Object
implements Serializable

Contains information on whether a user has approved a document edit and when.

See Also:
Document.getApprovalStatus(), Serialized Form

Constructor Summary
ApprovalStatus(User user, boolean approved, boolean rejected, Date approvedDate)
          Creates a new approval status object.
 
Method Summary
 boolean equals(Object o)
           
 Date getApprovedDate()
          If the document is approved it will return the date the user approved it, else null will be returned.
 User getUser()
          Returns The approval user.
 int hashCode()
           
 boolean isApproved()
          True if this user has approved the document.
 boolean isRejected()
          True if this user has rejected the document.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ApprovalStatus

public ApprovalStatus(User user,
                      boolean approved,
                      boolean rejected,
                      Date approvedDate)
Creates a new approval status object.

Parameters:
user - The approval user.
approved - True if the user approved the edit.
rejected - True if the user rejected the edit.
approvedDate - The date the user approved the edit, else null.
Method Detail

getUser

public User getUser()
Returns The approval user.

Returns:
Returns The approval user.

isApproved

public boolean isApproved()
True if this user has approved the document.

Returns:
true if the user has approved the document.

isRejected

public boolean isRejected()
True if this user has rejected the document.

Returns:
true if the user has rejected the document.

getApprovedDate

public Date getApprovedDate()
If the document is approved it will return the date the user approved it, else null will be returned.

Returns:
The time the user approved the document, else null.

equals

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

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object

Jive Product Page

Copyright © 1999-2007 Jive Software.