systems.dmx.workspaces

Interface WorkspacesService

Show UML class diagram

All Known Implementing Classes:

WorkspacesPlugin

public interface WorkspacesService

Field Summary

Fields

Modifier and Type	Field and Description
static String	DMX_WORKSPACE_NAME
static SharingMode	DMX_WORKSPACE_SHARING_MODE
static String	DMX_WORKSPACE_URI
static String	PROP_WORKSPACE_ID

Method Summary

Modifier and Type	Method and Description
void	assignToWorkspace(DMXObject object, long workspaceId) Assigns the given object to the given workspace.
void	assignTypeToWorkspace(DMXType type, long workspaceId) Assigns the given type and all its view configuration topics to the given workspace.
Topic	createWorkspace(String name, String uri, SharingMode sharingMode)
List<Association>	getAssignedAssociations(long workspaceId) Returns all associations assigned to the given workspace.
List<Association>	getAssignedAssociations(long workspaceId, String assocTypeUri) Returns all associations of the given type that are assigned to the given workspace.
List<Topic>	getAssignedTopics(long workspaceId) Returns all topics assigned to the given workspace.
List<Topic>	getAssignedTopics(long workspaceId, String topicTypeUri) Returns all topics of the given type that are assigned to the given workspace.
Topic	getAssignedWorkspace(long objectId) Returns the workspace a topic or association is assigned to.
Topic	getWorkspace(String uri) Returns a workspace by URI.

Field Detail

DMX_WORKSPACE_NAME

static final String DMX_WORKSPACE_NAME

See Also:

Constant Field Values

DMX_WORKSPACE_URI

static final String DMX_WORKSPACE_URI

See Also:

Constant Field Values

DMX_WORKSPACE_SHARING_MODE

static final SharingMode DMX_WORKSPACE_SHARING_MODE

PROP_WORKSPACE_ID

static final String PROP_WORKSPACE_ID

See Also:

Constant Field Values

Method Detail

createWorkspace

Topic createWorkspace(String name,
                      String uri,
                      SharingMode sharingMode)

Parameters:

uri - may be null

getWorkspace

Topic getWorkspace(String uri)

Returns a workspace by URI.

Returns:

The workspace (a topic of type "Workspace").

Throws:

RuntimeException - If no workspace exists for the given URI.

getAssignedWorkspace

Topic getAssignedWorkspace(long objectId)

Returns the workspace a topic or association is assigned to.

Parameters:

id - a topic ID, or an association ID

Returns:

The assigned workspace (a topic of type "Workspace"), or null if no workspace is assigned.

assignToWorkspace

void assignToWorkspace(DMXObject object,
                       long workspaceId)

Assigns the given object to the given workspace.

assignTypeToWorkspace

void assignTypeToWorkspace(DMXType type,
                           long workspaceId)

Assigns the given type and all its view configuration topics to the given workspace.

getAssignedTopics

List<Topic> getAssignedTopics(long workspaceId)

Returns all topics assigned to the given workspace.

getAssignedAssociations

List<Association> getAssignedAssociations(long workspaceId)

Returns all associations assigned to the given workspace.

getAssignedTopics

List<Topic> getAssignedTopics(long workspaceId,
                              String topicTypeUri)

Returns all topics of the given type that are assigned to the given workspace.

getAssignedAssociations

List<Association> getAssignedAssociations(long workspaceId,
                                          String assocTypeUri)

Returns all associations of the given type that are assigned to the given workspace.