org.nuxeo.ecm.social.workspace.adapters

Class SocialDocumentAdapter

java.lang.Object

org.nuxeo.ecm.social.workspace.adapters.SocialDocumentAdapter

All Implemented Interfaces:

SocialDocument

public class SocialDocumentAdapter
extends Object
implements SocialDocument

Default implementation of SocialDocument.

Author:

Benjamin JALON

Constructor Summary

Constructors

Constructor and Description
SocialDocumentAdapter(DocumentModel sourceDocument)

Method Summary

Methods

Modifier and Type	Method and Description
DocumentModel	getPublicDocument() Return the public proxy of the source document if the source document is public else return null.
DocumentModel	getRestrictedDocument() If source document is not an Article return the private proxy of the source document if the source document is private else return null If is the source document is an Article return the source document if private else return null.
String	getType()
boolean	isDocumentInSocialWorkspace() Returns true if this document is inside a SocialWorkspace , false otherwise.
boolean	isPublic() Returns true if this document is public, false otherwise.
boolean	isRestrictedToMembers() Returns true if this document is restricted to a SocialWorkspace members, false otherwise.
DocumentModel	makePublic() Make this document public.
DocumentModel	restrictToMembers() Make this document restricted to a SocialWorkspace members.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SocialDocumentAdapter

public SocialDocumentAdapter(DocumentModel sourceDocument)
                      throws ClientException

Parameters:

sourceDocument - on which social publications need to be performed

Throws:

ClientException

Method Detail

restrictToMembers

public DocumentModel restrictToMembers()
                                throws ClientException

Description copied from interface: SocialDocument

Make this document restricted to a SocialWorkspace members.

Specified by:

restrictToMembers in interface SocialDocument

Throws:

ClientException

makePublic

public DocumentModel makePublic()
                         throws ClientException

Description copied from interface: SocialDocument

Make this document public. It will be visible from non-members of the SocialWorkspace.

Specified by:

makePublic in interface SocialDocument

Throws:

ClientException

getPublicDocument

public DocumentModel getPublicDocument()
                                throws ClientException

Description copied from interface: SocialDocument

Return the public proxy of the source document if the source document is public else return null.

Specified by:

getPublicDocument in interface SocialDocument

Throws:

ClientException

isPublic

public boolean isPublic()
                 throws ClientException

Description copied from interface: SocialDocument

Returns true if this document is public, false otherwise.

Specified by:

isPublic in interface SocialDocument

Throws:

ClientException

getRestrictedDocument

public DocumentModel getRestrictedDocument()
                                    throws ClientException

Description copied from interface: SocialDocument

If source document is not an Article return the private proxy of the source document if the source document is private else return null If is the source document is an Article return the source document if private else return null.

Specified by:

getRestrictedDocument in interface SocialDocument

Throws:

ClientException

isRestrictedToMembers

public boolean isRestrictedToMembers()
                              throws ClientException

Description copied from interface: SocialDocument

Returns true if this document is restricted to a SocialWorkspace members, false otherwise.

Specified by:

isRestrictedToMembers in interface SocialDocument

Throws:

ClientException

isDocumentInSocialWorkspace

public boolean isDocumentInSocialWorkspace()

Description copied from interface: SocialDocument

Returns true if this document is inside a SocialWorkspace , false otherwise.

Specified by:

isDocumentInSocialWorkspace in interface SocialDocument

getType

public String getType()

Specified by:

getType in interface SocialDocument

Returns:

core type name of source document.