Clearspace API (1.7.0) Core Javadocs

Uses of Interface
com.jivesoftware.community.Document

Packages that use Document
com.jivesoftware.community Core interfaces and classes for Clearspace. 
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, java.lang.String documentID, java.lang.String title, java.lang.String body)
          Create a new document.
 Document DocumentVersion.getDocument()
          Returns the Document object corresponding to this version.
 Document DocumentManager.getDocument(Community community, java.lang.String subject)
          Returns a document from a community 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(java.lang.String documentID)
          Returns a document from the community based on its document ID.
 Document DocumentManager.getDocument(java.lang.String documentID, int version)
          Returns the revision of the document with the specified docID and version number.
 Document Community.getLatestDocument()
          Returns the most recently created or edited document in this community (including all sub-communities).
 

Methods in com.jivesoftware.community that return types with arguments of type Document
 JiveIterator<Document> Community.getDocuments()
          Returns an Iterable for all the published documents in the community.
 JiveIterator<Document> ContentRetrieval.getDocuments()
          Returns an Iterable of published documents objects in the community.
 JiveIterator<Document> Community.getDocuments(DocumentResultFilter resultFilter)
          Returns an Iterable for all the documents in the community {and possibly all subcommunities} that match the criteria specified by the ResultFilter.
 JiveIterator<Document> ContentRetrieval.getDocuments(DocumentResultFilter filter)
          Returns an Iterable for all the documents in the community that match the criteria specified by the ResultFilter.
 JiveIterator<Document> Community.getDocumentsUnderEdit()
          Returns an Iterable of documents currently being editted in the community.
 JiveIterator<Document> DocumentManager.getDocumentsUnderEdit()
          Returns an Iterable of documents currently being editted.
 JiveIterator<Document> Community.getPopularDocuments()
          Returns the top x documents according to document views, number of comments & time passed since the document was created.
 JiveIterator<Document> DocumentManager.getPopularDocuments()
          Returns the top x documents across all communities according to ratings, document views & time passed since the document was created.
 JiveIterator<Document> DocumentManager.getPopularDocuments(java.util.List<java.lang.String> languages)
          Returns the top x documents across all communities according to ratings, document views & time passed since the document was created in the languages specified.
 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 Community.addDocument(Document document)
          Add a document as a child of the community.
 void Community.addDocument(Document document, com.jivesoftware.community.impl.PermissionsBundle permBundle)
          Add a document as a child of the community with permissions defined by the provided permission bundle.
 void SearchManager.addToIndex(Document document)
          Adds an individual document to the index.
 SearchQueryCriteria SearchQueryManager.createSearchQueryCriteria(Document document)
          Returns a SearchQueryCriteria that can be used to query for blog posts, documents and messages that are deemed similar to the provided document.
 void DocumentManager.deleteDocument(Document document)
          Deletes a document.
 java.lang.String DocumentPresenter.getTransformedTemplate(Document document, AuthToken auth, java.util.Locale locale)
          Applies the template to a Document and returns the results as a string
 void DocumentManager.moveDocument(Document document, Community destinationCommunity)
          Moves a document from it's current community to another.
 void SearchManager.removeFromIndex(Document document)
          Removes an individual document from the index.
 void SearchManager.updateIndex(Document document)
          Update an individual document in the index.
 

Uses of Document in com.jivesoftware.community.event
 

Methods in com.jivesoftware.community.event that return Document
 Document DocumentEvent.getDocument()
           
 

Constructors in com.jivesoftware.community.event with parameters of type Document
DocumentEvent(int eventType, Document document, Community community, java.util.Map<java.lang.String,? extends java.lang.Object> params)
           
 


Clearspace Project Page

Copyright © 1999-2007 Jive Software.