com.crystaldecisions.sdk.plugin.destination.streamwork
Interface IStreamWorkActivity

public interface IStreamWorkActivity

This interface allows you to set the information of an activity being created on Streamwork

Nested Class Summary

static class

IStreamWorkActivity.ParticipantType Type indicating how the participant is specified

Method Summary

java.lang.String	getID() Returns the ID of the existing activity to which an item will be posted.
java.lang.String	getName() Returns the name of the new activity to which an item will be posted.
java.lang.String	getObjectives() Returns new activity objective
java.util.List	getParticipants(IStreamWorkActivity.ParticipantType type) Returns the list of strings representing the participants in a new activity.
java.lang.String	getTemplateID() Returns the ID of the template the new activity will be using
java.lang.String	getWorklistID() Returns the ID of the worklist the new activity belongs to
void	setID(java.lang.String id) Sets the ID of an existing activity to which an item will be posted.
void	setName(java.lang.String name) Sets new activity title.
void	setObjectives(java.lang.String objective) Sets new activity objective
void	setTemplateID(java.lang.String templateID) Sets the ID of the template the new activity will be using
void	setWorklistID(java.lang.String worklist) Sets the ID of the worklist the new activity belongs to

Method Detail

setID

void setID(java.lang.String id)

Sets the ID of an existing activity to which an item will be posted. Setting the existing activity ID will result in all other properties except the Participants in the SI_ACTIVITY bag being cleared because except the Participants, they apply to new activity only.

Parameters:

id - A String ID of the existing activity to which an item will be posted

getID

java.lang.String getID()

Returns the ID of the existing activity to which an item will be posted.

Returns:

A String ID of the existing activity to which an item will be posted

setName

void setName(java.lang.String name)

Sets new activity title. Setting the activity name will result in the activity ID property being removed because activity ID only applies to existing activity.

Parameters:

name - The new activity title

getName

java.lang.String getName()

Returns the name of the new activity to which an item will be posted.

Returns:

The new activity name

setObjectives

void setObjectives(java.lang.String objective)

Sets new activity objective

Parameters:

objective - The new activity objective

getObjectives

java.lang.String getObjectives()

Returns new activity objective

Returns:

The new activity objective

setWorklistID

void setWorklistID(java.lang.String worklist)

Sets the ID of the worklist the new activity belongs to

Parameters:

worklist - The ID of the worklist the new activity belongs to

getWorklistID

java.lang.String getWorklistID()

Returns the ID of the worklist the new activity belongs to

Returns:

The ID of the worklist the new activity belongs to

setTemplateID

void setTemplateID(java.lang.String templateID)

Sets the ID of the template the new activity will be using

Parameters:

templateID - The ID of the template the new activity will be using

getTemplateID

java.lang.String getTemplateID()

Returns the ID of the template the new activity will be using

Returns:

The ID of the template the new activity will be using

getParticipants

java.util.List getParticipants(IStreamWorkActivity.ParticipantType type)

Returns the list of strings representing the participants in a new activity. The input type determines if the participant should be specified as email address or user ID

Parameters:

type - IStreamWorkActivity.ParticipantType indicating how the participant is specified

Returns:

The list of participants based on participant type