SocialDocument (Nuxeo ECM Projects 5.5-SNAPSHOT API Documentation)

All Known Implementing Classes:

SocialDocumentAdapter
```
public interface SocialDocument
```
This class gives method to make the document public or private into the constrains of social workspace. The document must be part of a social workspace and be a social document. A document is public if it's published into the public section. Except for an article render a social document visible only for the community is to publish the document into the private section. For an article this is just to have no proxy into the public section. The source document himself will be the document exposed. In the documentation about method of this class, when we reference to a social document, we implicitly talking about the social document handle by the instance of the class set into the constructor.

Author:

Benjamin JALON

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.

- Method Detail
  - isDocumentInSocialWorkspace
```
boolean isDocumentInSocialWorkspace()
```
    Returns true if this document is inside a SocialWorkspace , false otherwise.
  - isPublic
```
boolean isPublic()
                 throws ClientException
```
    Returns true if this document is public, false otherwise.
    
    Throws:
    
    ClientException
  - isRestrictedToMembers
```
boolean isRestrictedToMembers()
                              throws ClientException
```
    Returns true if this document is restricted to a SocialWorkspace members, false otherwise.
    
    Throws:
    
    ClientException
  - makePublic
```
DocumentModel makePublic()
                         throws ClientException
```
    Make this document public. It will be visible from non-members of the SocialWorkspace.
    
    Throws:
    
    ClientException
  - restrictToMembers
```
DocumentModel restrictToMembers()
                                throws ClientException
```
    Make this document restricted to a SocialWorkspace members.
    
    Throws:
    
    ClientException
  - getPublicDocument
```
DocumentModel getPublicDocument()
                                throws ClientException
```
    Return the public proxy of the source document if the source document is public else return null.
    
    Throws:
    
    ClientException
  - getRestrictedDocument
```
DocumentModel getRestrictedDocument()
                                    throws ClientException
```
    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.
    
    Throws:
    
    ClientException
  - getType
```
String getType()
```
    Returns:
    core type name of source document.

Interface SocialDocument

Method Summary

Method Detail

isDocumentInSocialWorkspace

isPublic

isRestrictedToMembers

makePublic

restrictToMembers

getPublicDocument

getRestrictedDocument

getType