com.softwareag.centrasite.api.activity
Interface ActivityManager


public interface ActivityManager

ActivityManager is an interface for activity and activity menu management.


Method Summary
 Activity createActivity(java.lang.String id, java.lang.String activityClass)
          Create an activity by using given parameters.
 ActivityMenuItem createActivityMenuItem(Activity activity)
          create the Menu Item using given activity.
 Activity getActivity(java.lang.String id)
          Get the activity for the given activity identifier.
 ActivityMenu getActivityMenu()
          Get the ActivityMenu associated with the ActivityManager.
 java.util.List<Activity> getAllActivities()
          Get all the activities available in the configuration file.
 boolean removeActivity(java.lang.String id)
          Remove the activity associated with the given activity identifier.
 

Method Detail

getAllActivities

java.util.List<Activity> getAllActivities()
                                          throws CLLException
Get all the activities available in the configuration file.

Returns:
list of activities.
Throws:
CLLException - in case of failed to construct the activities.

getActivity

Activity getActivity(java.lang.String id)
                     throws CLLException
Get the activity for the given activity identifier.

Parameters:
id - unique identifier for the activity.
Returns:
activity implementation class class reference used perform the actions on the activity.
Throws:
CLLException - in case of failed to construct the activity.

removeActivity

boolean removeActivity(java.lang.String id)
                       throws CLLException
Remove the activity associated with the given activity identifier.

Parameters:
id - unique identifier for the activity.
Returns:
true in case successful removal else false.
Throws:
CLLException - in case of failed to remove the activity.

createActivityMenuItem

ActivityMenuItem createActivityMenuItem(Activity activity)
                                        throws CLLException
create the Menu Item using given activity.

Parameters:
activity - activity implementation class class reference used perform the actions on the activity.
Returns:
ActivityMenuItem
Throws:
CLLException - in case of failed to construct the ActivityMenuItem using given activity.

createActivity

Activity createActivity(java.lang.String id,
                        java.lang.String activityClass)
                        throws CLLException
Create an activity by using given parameters.

Parameters:
id - unique identifier for the activity.
activityClass - activity implementation class
Returns:
Activity Implementation class reference, used to perform the actions on the activity.
Throws:
CLLException - in case of failed to create an activity

getActivityMenu

ActivityMenu getActivityMenu()
Get the ActivityMenu associated with the ActivityManager.

Returns:
ActivityMenu which represents the list of menu items.