IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.rcp.activity.core
Class Activity

java.lang.Object
  extended by com.ibm.btt.rcp.activity.core.Activity
All Implemented Interfaces:
IActivity, java.lang.Runnable
Direct Known Subclasses:
AbstractWorkingAreaActivity

public abstract class Activity
extends java.lang.Object
implements IActivity

Abstract class for user defined activity. User should extend this abstract class to create their activity, no need to implement from IActivity interface directly.


Field Summary
protected  org.osgi.framework.Bundle bundle
           
protected  java.lang.String desc
           
protected  org.eclipse.jface.resource.ImageDescriptor icon
           
protected  java.lang.String id
           
protected  java.lang.String name
           
protected  java.lang.String parameter
           
protected  java.util.Map<?,?> params
           
protected  boolean unique
           
protected  org.eclipse.ui.IWorkbenchPartSite workbenchPartSite
           
 
Constructor Summary
Activity()
           
 
Method Summary
 org.osgi.framework.Bundle getBundle()
          Get Bundle(org.ogsi.framework.Bundle) of this activity, this bundle is used to load class from different plugin projects.
 java.lang.String getDescription()
          Get description(java.lang.String) of this activity
 org.eclipse.jface.resource.ImageDescriptor getIcon()
          Get the icon(org.eclipse.jface.resource.ImageDescriptor) of this activity
 java.lang.String getId()
          Get id(java.lang.String) property of this activity
 java.lang.String getName()
          Get the name(java.lang.String) of this activity.
 java.lang.String getParameter()
          Get the parameter(java.lang.String) of this activity
 java.util.Map<?,?> getParams()
          Get Map property of this activity
 void initializeFrom(IActivityDefinition define)
          Initialize a activity from a IActivityDefinition object
 boolean isUnique()
          Get if this activity is global unique during its lifecycle
 void setBundle(org.osgi.framework.Bundle bundle)
          Set Bundle(org.ogsi.framework.Bundle) of this activity, this bundle is used to load class from different plugin projects.
 void setDescription(java.lang.String desc)
          Set description(java.lang.String) for this activity
 void setIcon(org.eclipse.jface.resource.ImageDescriptor icon)
          Set the icon(org.eclipse.jface.resource.ImageDescriptor) of this activity
 void setId(java.lang.String id)
          Set id(java.lang.String) property for this activity
 void setName(java.lang.String name)
          Set the name(java.lang.String) of this activity.
 void setParameter(java.lang.String parameter)
          Set the parameter(java.lang.String) of this activity
 void setParams(java.util.Map<?,?> params)
          Set Map property for this activity
 void setUnique(boolean unique)
          Set if this activity is global unique during its lifecycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.btt.rcp.activity.core.IActivity
dispose
 
Methods inherited from interface java.lang.Runnable
run
 

Field Detail

id

protected java.lang.String id

params

protected java.util.Map<?,?> params

workbenchPartSite

protected org.eclipse.ui.IWorkbenchPartSite workbenchPartSite

desc

protected java.lang.String desc

unique

protected boolean unique

parameter

protected java.lang.String parameter

bundle

protected org.osgi.framework.Bundle bundle

name

protected java.lang.String name

icon

protected org.eclipse.jface.resource.ImageDescriptor icon
Constructor Detail

Activity

public Activity()
Method Detail

getId

public java.lang.String getId()
Description copied from interface: IActivity
Get id(java.lang.String) property of this activity

Specified by:
getId in interface IActivity
Returns:
id the id of this activity

getParams

public java.util.Map<?,?> getParams()
Description copied from interface: IActivity
Get Map property of this activity

Specified by:
getParams in interface IActivity
Returns:
the context passed to this activity

setId

public void setId(java.lang.String id)
Description copied from interface: IActivity
Set id(java.lang.String) property for this activity

Specified by:
setId in interface IActivity
Parameters:
id - the id of this activity

setParams

public void setParams(java.util.Map<?,?> params)
Description copied from interface: IActivity
Set Map property for this activity

Specified by:
setParams in interface IActivity
Parameters:
params - the context passed to this activity

getDescription

public java.lang.String getDescription()
Description copied from interface: IActivity
Get description(java.lang.String) of this activity

Specified by:
getDescription in interface IActivity
Returns:
description of this activity

setDescription

public void setDescription(java.lang.String desc)
Description copied from interface: IActivity
Set description(java.lang.String) for this activity

Specified by:
setDescription in interface IActivity
Parameters:
desc - description of this activity

isUnique

public boolean isUnique()
Description copied from interface: IActivity
Get if this activity is global unique during its lifecycle

Specified by:
isUnique in interface IActivity
Returns:
if this activity is global unique

setUnique

public void setUnique(boolean unique)
Description copied from interface: IActivity
Set if this activity is global unique during its lifecycle

Specified by:
setUnique in interface IActivity
Parameters:
unique - if this activity is global unique

getParameter

public java.lang.String getParameter()
Description copied from interface: IActivity
Get the parameter(java.lang.String) of this activity

Specified by:
getParameter in interface IActivity
Returns:
the parameter passed to this activity

setParameter

public void setParameter(java.lang.String parameter)
Description copied from interface: IActivity
Set the parameter(java.lang.String) of this activity

Specified by:
setParameter in interface IActivity
Parameters:
parameter - the parameter passed to this activity

getBundle

public org.osgi.framework.Bundle getBundle()
Description copied from interface: IActivity
Get Bundle(org.ogsi.framework.Bundle) of this activity, this bundle is used to load class from different plugin projects.

Specified by:
getBundle in interface IActivity
Returns:
Bundle of this activity

setBundle

public void setBundle(org.osgi.framework.Bundle bundle)
Description copied from interface: IActivity
Set Bundle(org.ogsi.framework.Bundle) of this activity, this bundle is used to load class from different plugin projects.

Specified by:
setBundle in interface IActivity
Parameters:
bundle - Bundle of this activity

getName

public java.lang.String getName()
Description copied from interface: IActivity
Get the name(java.lang.String) of this activity.

Specified by:
getName in interface IActivity
Returns:
the name of this activity

setName

public void setName(java.lang.String name)
Description copied from interface: IActivity
Set the name(java.lang.String) of this activity.

Specified by:
setName in interface IActivity
Parameters:
name - the name of this activity

getIcon

public org.eclipse.jface.resource.ImageDescriptor getIcon()
Description copied from interface: IActivity
Get the icon(org.eclipse.jface.resource.ImageDescriptor) of this activity

Specified by:
getIcon in interface IActivity
Returns:
icon

setIcon

public void setIcon(org.eclipse.jface.resource.ImageDescriptor icon)
Description copied from interface: IActivity
Set the icon(org.eclipse.jface.resource.ImageDescriptor) of this activity

Specified by:
setIcon in interface IActivity

initializeFrom

public void initializeFrom(IActivityDefinition define)
Description copied from interface: IActivity
Initialize a activity from a IActivityDefinition object

Specified by:
initializeFrom in interface IActivity

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010