com.jivesoftware.community
Interface DocumentAttributes

public interface DocumentAttributes

Attributes for documents -- recommendation status and published status.

Method Summary

boolean	isPublished() Convenience mathod for whether there is a published version of this document or not.
boolean	isRecommended() Returns true if the document was created as a recommendation.
void	setRecommended(boolean recommended)

Method Detail

isRecommended

boolean isRecommended()

Returns true if the document was created as a recommendation.

Returns:

true if the document was created as a recommendation. Default is false.

setRecommended

void setRecommended(boolean recommended)
                    throws UnauthorizedException

Parameters:

recommended - true if the document should be marked as recommended, false otherwise.

Throws:

UnauthorizedException - if the user does not have permission to modify the document.

See Also:

isRecommended()

isPublished

boolean isPublished()

Convenience mathod for whether there is a published version of this document or not.

Returns:

true if the there is a published version of this document, false otherwise.