wt.workflow.collaboration
Class CollaborationServiceFwd

java.lang.Object
  wt.workflow.collaboration.CollaborationServiceFwd

All Implemented Interfaces:

CollaborationService, RemoteAccess, Serializable

public class CollaborationServiceFwd

extends Object

implements RemoteAccess, CollaborationService, Serializable

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

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private static String	FC_RESOURCE
(package private) static boolean	SERVER

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary

CollaborationServiceFwd()

Method Summary

private static Manager	getManager()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVER

static final boolean SERVER

FC_RESOURCE

private static final String FC_RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Constructor Detail

CollaborationServiceFwd

public CollaborationServiceFwd()

Method Detail

getManager

private static Manager getManager()
                           throws WTException

Returns:

Manager

Throws:

WTException

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

Specified by:

subscribe in interface CollaborationService

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

Specified by:

unsubscribe in interface CollaborationService

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

Specified by:

subscribe in interface CollaborationService

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

Specified by:

unsubscribe in interface CollaborationService

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

Specified by:

unsubscribe in interface CollaborationService

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

Specified by:

populateContainer in interface CollaborationService

Parameters:

container -

template -

Returns:

CollaborationContainer

Throws:

WTException

isValidTemplate

public boolean isValidTemplate(CollaborationTemplate template)
                        throws WTException

Supported API: false

Specified by:

isValidTemplate in interface CollaborationService

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

Specified by:

isSubscribed in interface CollaborationService

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

Specified by:

saveTemplate in interface CollaborationService

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

Specified by:

isSubscribed in interface CollaborationService

Parameters:

oid -

event_key -

Returns:

boolean

Throws:

WTException