|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.xpn.xwiki.xmlrpc.DomainObjectFactory
public class DomainObjectFactory
This class contains utility methods for building xmlrpc domain objects.
Constructor Summary | |
---|---|
DomainObjectFactory()
|
Method Summary | |
---|---|
static Attachment |
createAttachment(Attachment xwikiAttachment)
Create an Attachment object containing information about an attachment. |
static Comment |
createComment(Document document,
Object commentObject)
Create a comment object containing all the information concerning a document comment. |
static XWikiObject |
createEmptyXWikiObject()
|
static XWikiPage |
createEmptyXWikiPage()
|
static SearchResult |
createSearchResult(String pageId)
Create a search result object. |
static Space |
createSpace(Document spaceWebHome)
Create a space from its WebHome document. |
static Space |
createSpace(String spaceKey)
Create a space description. |
static SpaceSummary |
createSpaceSummary(Document spaceWebHome)
Create a space summary starting from the space Web home. |
static SpaceSummary |
createSpaceSummary(String spaceKey)
Create a space summary |
static XWikiClass |
createXWikiClass(Class xwikiClass)
Create an XWikiClass object with all the information about a given XWiki class |
static XWikiClassSummary |
createXWikiClassSummary(String className)
Create a summary of an XWiki class. |
static XWikiObject |
createXWikiObject(XWiki xwiki,
XWikiContext xwikiContext,
Document document,
Object object)
Create an XWikiObject containing all the information and attributed of a given xwiki object. |
static XWikiObjectSummary |
createXWikiObjectSummary(Document document,
Object object)
Create a summary of a given xwiki object. |
static XWikiPage |
createXWikiPage(Document document,
boolean useExtendedPageId)
Create a page description from an XWiki document. |
static XWikiPageHistorySummary |
createXWikiPageHistorySummary(Document document)
Create a page history summary containing revision information about a document. |
static XWikiPageSummary |
createXWikiPageSummary(Document document)
Create a page summary description from an XWiki document. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DomainObjectFactory()
Method Detail |
---|
public static SpaceSummary createSpaceSummary(String spaceKey)
public static SpaceSummary createSpaceSummary(Document spaceWebHome)
public static Space createSpace(String spaceKey)
public static Space createSpace(Document spaceWebHome)
public static XWikiPageSummary createXWikiPageSummary(Document document) throws XWikiException
XWikiException
- If there is a problem getting page translations.public static XWikiPage createXWikiPage(Document document, boolean useExtendedPageId) throws Exception
useExtendedPageId
- true if the id should contain additional information concerning the version, language
etc. In this case the pageId will be in the form Space.Page?param=value¶m=value&...
XWikiException
- If there is a problem getting page translations.
Exception
public static XWikiPage createEmptyXWikiPage()
public static XWikiPageHistorySummary createXWikiPageHistorySummary(Document document)
public static Comment createComment(Document document, Object commentObject)
commentObject
- The XWiki object of type "XWiki.Comment" containing the actual comment.
public static Attachment createAttachment(Attachment xwikiAttachment)
public static XWikiClassSummary createXWikiClassSummary(String className)
public static XWikiClass createXWikiClass(Class xwikiClass)
public static XWikiObjectSummary createXWikiObjectSummary(Document document, Object object)
public static XWikiObject createXWikiObject(XWiki xwiki, XWikiContext xwikiContext, Document document, Object object) throws QueryException, XWikiException
QueryException
XWikiException
public static XWikiObject createEmptyXWikiObject()
public static SearchResult createSearchResult(String pageId)
pageId
- The page id representing the page associated with this result.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |