wt.workflow.collaboration
Interface CollaborationService

All Known Implementing Classes:

CollaborationServiceFwd, StandardCollaborationService

public interface CollaborationService

A utility service that holds methods to manipulate Collaborationcontainer and CollaborationTemplate objects.

Supported API: false

Extendable: false

Method Summary

boolean	isSubscribed(CollaborationContainer container, String event_key) returns true if current user is subscribed to the given event of the container, false otherwise.
boolean	isSubscribed(ObjectIdentifier oid, String event_key) returns true if current user is subscribed to the given event of the container, false otherwise.
boolean	isValidTemplate(CollaborationTemplate template) Supported API: false
CollaborationContainer	populateContainer(CollaborationContainer container, CollaborationTemplate template) Supported API: false
CollaborationTemplate	saveTemplate(CollaborationTemplate template) Validates the template and updates it if already persisted else inserts it into the database.
void	subscribe(CollaborationContainer container) Subscribes the current user to the given CollaborationContainer.
void	subscribe(CollaborationContainer container, Vector userVec) Subscribes the list of users to the given CollaborationContainer.
void	unsubscribe(CollaborationContainer container, String event_key) Unsubscribes the current user from the given CollaborationContainer.
void	unsubscribe(CollaborationContainer container, Vector userVec, String event_key) Unsubscribes the list of users from the given CollaborationContainer.
void	unsubscribe(CollaborationContainer container, WTPrincipalReference user, String event_key) Unsubscribes the list of users from the given CollaborationContainer.

Method Detail

subscribe

public void subscribe(CollaborationContainer container)
               throws WTException

Subscribes the current user to the given CollaborationContainer. The user is subscribed recursively to all child nodes of the container and so on to the very last node in the hierarchy.

Supported API: false

Parameters:

container -

Throws:

WTException

unsubscribe

public void unsubscribe(CollaborationContainer container,
                        String event_key)
                 throws WTException

Unsubscribes the current user from the given CollaborationContainer. Unsubscribing from a container does not unsubscribe the user from the child nodes of the container; this has to be done explicitly.

Supported API: false

Parameters:

container - The CollaborationContainer being unsubscribed from.

event_key - The event being unsubscribed from.

Throws:

WTException

subscribe

public void subscribe(CollaborationContainer container,
                      Vector userVec)
               throws WTException

Subscribes the list of users to the given CollaborationContainer. The users are subscribed recursively to all child nodes of the container and so on to the very last node in the hierarchy.

Supported API: false

Parameters:

container -

userVec -

Throws:

WTException

unsubscribe

public void unsubscribe(CollaborationContainer container,
                        WTPrincipalReference user,
                        String event_key)
                 throws WTException

Unsubscribes the list of users from the given CollaborationContainer. Unsubscribing from a container does not unsubscribe the users from the child nodes of the container; this has to be done explicitly.

Supported API: false

Parameters:

container - The CollaborationContainer being unsubscribed from.

user - The user being unsubscribed.

event_key - The event being unsubscribed from.

Throws:

WTException

unsubscribe

public void unsubscribe(CollaborationContainer container,
                        Vector userVec,
                        String event_key)
                 throws WTException

Unsubscribes the list of users from the given CollaborationContainer. Unsubscribing from a container does not unsubscribe the users from the child nodes of the container; this has to be done explicitly.

Supported API: false

Parameters:

container - The CollaborationContainer being unsubscribed from.

userVec - A Vector of WTPrincipal objects.

event_key - The event being unsubscribed from.

Throws:

WTException

populateContainer

public CollaborationContainer populateContainer(CollaborationContainer container,
                                                CollaborationTemplate template)
                                         throws WTException

Supported API: false

Parameters:

container -

template -

Returns:

CollaborationContainer

Throws:

WTException

isValidTemplate

public boolean isValidTemplate(CollaborationTemplate template)
                        throws WTException

Supported API: false

Parameters:

template -

Returns:

boolean

Throws:

WTException

isSubscribed

public boolean isSubscribed(CollaborationContainer container,
                            String event_key)
                     throws WTException

returns true if current user is subscribed to the given event of the container, false otherwise.

Supported API: false

Parameters:

container -

event_key -

Returns:

boolean

Throws:

WTException

saveTemplate

public CollaborationTemplate saveTemplate(CollaborationTemplate template)
                                   throws WTException

Validates the template and updates it if already persisted else inserts it into the database.

Supported API: false

Parameters:

template -

Returns:

CollaborationTemplate

Throws:

WTException

isSubscribed

public boolean isSubscribed(ObjectIdentifier oid,
                            String event_key)
                     throws WTException

returns true if current user is subscribed to the given event of the container, false otherwise.

Supported API: false

Parameters:

oid -

event_key -

Returns:

boolean

Throws:

WTException