|
Jive API (5.0.0.0) Core Javadocs | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use Document | |
|---|---|
| com.jivesoftware.community | Core interfaces and classes for Jive SBS. |
| com.jivesoftware.community.event | Provides mechanisms to be notified of actions in the system such as new messages being created. |
| Uses of Document in com.jivesoftware.community |
|---|
| Methods in com.jivesoftware.community that return Document | |
|---|---|
Document |
DocumentManager.createDocument(User user,
DocumentType documentType,
String documentID,
String title,
Document body)
Create a new document. |
Document |
DocumentManager.createDocument(User user,
DocumentType documentType,
String documentID,
String title,
String body)
Create a new document. |
Document |
DocumentAttributes.getDocument()
Returns the document to which these attributes apply. |
Document |
DocumentVersion.getDocument()
Returns the Document object corresponding to this version. |
Document |
DocumentManager.getDocument(JiveContainer container,
String subject)
Returns a document from a container based on its subject. |
Document |
DocumentManager.getDocument(long docID)
Returns the document with the specified docID. |
Document |
DocumentManager.getDocument(long docID,
int version)
Returns the revision of document with the specified docID and version number. |
Document |
DocumentManager.getDocument(String documentID)
Returns a document from the container based on its document ID. |
Document |
DocumentManager.getDocument(String documentID,
int version)
Returns the revision of the document with the specified docID and version number. |
Document |
DocumentManager.getLatestDocument(JiveContainer container)
Returns the most recently created or edited document in this container (including all sub-communities). |
| Methods in com.jivesoftware.community that return types with arguments of type Document | |
|---|---|
JiveIterator<Document> |
DocumentManager.getDocuments(DocumentResultFilter filter)
Returns an Iterable for all the published documents in the container. |
JiveIterator<Document> |
DocumentManager.getDocuments(JiveContainer container)
Returns an Iterable for all the published documents in the container. |
JiveIterator<Document> |
DocumentManager.getDocuments(JiveContainer container,
DocumentResultFilter resultFilter)
Returns an Iterable for all the documents in the container {and possibly all child containers (if the container is a community)} that match the criteria specified by the ResultFilter. |
List<Document> |
DocumentManager.getDocuments(Set<Long> documentIDs)
Returns the documents for the specified document IDs. |
JiveIterator<Document> |
DocumentManager.getDocuments(TagSet tagSet)
Returns an Iterable for all the published documents in the tag set. |
JiveIterator<Document> |
DocumentManager.getDocuments(TagSet tagSet,
DocumentResultFilter resultFilter)
Returns an Iterable for all the documents in the tag set that match the criteria specified by the ResultFilter. |
JiveIterator<Document> |
DocumentManager.getDocumentsUnderEdit()
Returns an Iterable of documents currently being editted. |
JiveIterator<Document> |
DocumentManager.getDocumentsUnderEdit(JiveContainer container)
Returns the count of the number of documents currently being editted in the container. |
JiveIterator<Document> |
DocumentManager.getUserApprovalDocuments(User user)
Returns all documents that a user needs to approve. |
JiveIterator<Document> |
DocumentManager.getUserDocuments(User user,
DocumentState[] states)
Returns all documents in the supplied DocumentStates for the supplied user. |
| Methods in com.jivesoftware.community with parameters of type Document | |
|---|---|
void |
DocumentManager.addDocument(JiveContainer container,
Document document,
Map parameters)
Add a document as a child of a container. |
void |
DocumentManager.addDocument(JiveContainer container,
Document document,
com.jivesoftware.community.impl.PermissionsBundle permBundle,
Map parameters)
Add a document as a child of the container with permissions defined by the provided permission bundle. |
void |
DocumentManager.deleteDocument(Document document)
Deletes a document. |
String |
DocumentPresenter.getTransformedTemplate(Document document,
AuthToken auth,
Locale locale)
Applies the template to a Document and returns the results as a string |
void |
DocumentManager.moveDocument(Document document,
JiveContainer destinationContainer)
Moves a document from it's current container to another. |
| Uses of Document in com.jivesoftware.community.event |
|---|
| Constructors in com.jivesoftware.community.event with parameters of type Document | |
|---|---|
DocumentEvent(DocumentEvent.Type type,
Document d,
JiveContainer c)
|
|
DocumentEvent(DocumentEvent.Type type,
Document d,
JiveContainer c,
Map<String,? extends Object> params)
|
|
|
Jive Product Page | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||