Skip navigation links

waggle.common.modules.artifact
Interface XArtifactModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XArtifactModule

public static interface XArtifactModule.Server

extends XAPIInterface.Server

Server interface for the Artifact Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XArtifactInfo	copyArtifact(XObjectID artifactID, XObjectID conversationID, String name) Copy an Artifact to a Conversation in another Track.
XArtifactInfo	getArtifact(XObjectID artifactID) Get an Artifact Information DTO.
XArtifactInfo	getArtifactIfAccessible(XObjectID artifactID) Get an Artifact Information DTO.
List<XArtifactInfo>	getArtifacts(List<XObjectID> artifactIDs) Get a set of Artifact Information DTOs.
void	removeArtifact(XObjectID artifactID) Remove an Artifact.
void	setArtifactName(XObjectID artifactID, String name) Change an Artifact's name.
void	setArtifactState(XObjectID artifactID, XArtifactState state) Change an Artifact's state.
void	unremoveArtifact(XObjectID artifactID) Un-remove an Artifact.

Method Detail

getArtifact

XArtifactInfo getArtifact(XObjectID artifactID)

Get an Artifact Information DTO.

Parameters:

artifactID - The Artifact.

Returns:

An Artifact Information DTO.

getArtifactIfAccessible

XArtifactInfo getArtifactIfAccessible(XObjectID artifactID)

Get an Artifact Information DTO.

Parameters:

artifactID - The Artifact.

Returns:

An Artifact Information DTO or null if the Conversation is not accessible.

getArtifacts

List<XArtifactInfo> getArtifacts(List<XObjectID> artifactIDs)

Get a set of Artifact Information DTOs.

Parameters:

artifactIDs - The Artifacts.

Returns:

The set of Artifact Information DTOs.

setArtifactName

void setArtifactName(XObjectID artifactID,
                     String name)

Change an Artifact's name.

Parameters:

artifactID - The Artifact.

name - The new name.

setArtifactState

void setArtifactState(XObjectID artifactID,
                      XArtifactState state)

Change an Artifact's state.

Parameters:

artifactID - The Artifact.

state - The state.

copyArtifact

XArtifactInfo copyArtifact(XObjectID artifactID,
                           XObjectID conversationID,
                           String name)

Copy an Artifact to a Conversation in another Track.

Parameters:

artifactID - The Artifact.

conversationID - The other Conversation.

name - The new name. May be null.

Returns:

The new Artifact info DTO.

removeArtifact

void removeArtifact(XObjectID artifactID)

Remove an Artifact.

Parameters:

artifactID - The Artifact.

unremoveArtifact

void unremoveArtifact(XObjectID artifactID)

Un-remove an Artifact.

Parameters:

artifactID - The Artifact.

Skip navigation links