Skip navigation links

waggle.common.modules.repository
Interface XRepositoryModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XRepositoryModule

public static interface XRepositoryModule.Server

extends XAPIInterface.Server

Server interface for the Repository Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XArtifactInfo	createDocumentFromRepositoryRevision(XObjectID repositoryID, XObjectID conversationID, String repositoryData, String documentName) Create a new Conversation Document or a new Version of an existing Conversation Document (by name) from an existing Repository document.
XRepositoryInfo	createRepository(XRepositoryCreateInfo createInfo) Create a new repository.
XRepositoryDocumentInfo	createRepositoryRevisionFromContent(XObjectID contentID) Create a new Repository document revision from existing Conversation content (Document or Version).
void	deleteRepository(XObjectID repositoryID) Delete an existing Repository.
List<XRepositoryInfo>	getAllRepositories() Get all Repositories.
XRepositoryDocumentInfo	getDocumentInfo(XObjectID repositoryID, String repositoryData) Get information about a specific document.
List<XRepositoryInfo>	getEnabledRepositories() Get all enabled Repositories.
XRepositoryInfo	getRepository(XObjectID repositoryID) Get an existing Repository.
XRepositorySearchResultsInfo	searchRepository(XObjectID repositoryID, XRepositorySearchInfo searchInfo) Search a Repository.
XRepositoryInfo	updateRepository(XObjectID repositoryID, XUpdater updater) Update an existing Repository.

Method Detail

getAllRepositories

List<XRepositoryInfo> getAllRepositories()

Get all Repositories.

Returns:

All Repository Information.

getEnabledRepositories

List<XRepositoryInfo> getEnabledRepositories()

Get all enabled Repositories.

Returns:

All enabled Repository Information.

createRepository

XRepositoryInfo createRepository(XRepositoryCreateInfo createInfo)

Create a new repository.

Parameters:

createInfo - The Repository create information.

Returns:

The Repository information.

getRepository

XRepositoryInfo getRepository(XObjectID repositoryID)

Get an existing Repository.

Parameters:

repositoryID - The Repository.

Returns:

The Repository information DTO.

updateRepository

XRepositoryInfo updateRepository(XObjectID repositoryID,
                                 XUpdater updater)

Update an existing Repository.

Parameters:

repositoryID - The Repository.

updater - The updater.

Returns:

The Repository information.

deleteRepository

void deleteRepository(XObjectID repositoryID)

Delete an existing Repository.

Parameters:

repositoryID - The Repository.

searchRepository

XRepositorySearchResultsInfo searchRepository(XObjectID repositoryID,
                                              XRepositorySearchInfo searchInfo)

Search a Repository.

Parameters:

repositoryID - The Repository.

searchInfo - The search specification.

Returns:

List of Repository document hits.

getDocumentInfo

XRepositoryDocumentInfo getDocumentInfo(XObjectID repositoryID,
                                        String repositoryData)

Get information about a specific document.

Parameters:

repositoryID - The Repository.

repositoryData - The internal content item revision identifier.

Returns:

The repository revision dID and info of the new repository revision.

createDocumentFromRepositoryRevision

XArtifactInfo createDocumentFromRepositoryRevision(XObjectID repositoryID,
                                                   XObjectID conversationID,
                                                   String repositoryData,
                                                   String documentName)

Create a new Conversation Document or a new Version of an existing Conversation Document (by name) from an existing Repository document.

Parameters:

repositoryID - The Repository.

conversationID - The Conversation's ID.

repositoryData - The internal content item revision identifier.

documentName - The document name as it should appear in the Conversation. May be null in which case the repository document's title will be used.

Returns:

The Document info for the newly created document, or of the existing document to which a new version was added.

createRepositoryRevisionFromContent

XRepositoryDocumentInfo createRepositoryRevisionFromContent(XObjectID contentID)

Create a new Repository document revision from existing Conversation content (Document or Version).

Parameters:

contentID - The Content ID (Document or Version). the specified Content Document came from. The method will get the associated repository document and add a new revision to that repository document.

Returns:

The repository revision dID and info of the new repository revision.

Skip navigation links