|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EventHandler
Represents the configuration of a Worklist event handler. This interface can be used to view or edit this configuration at runtime and apply any changes in configuration to the running state of a Worklist system instance running in a WebLogic server.
NOTE: Some objects within this handler or its heirarchy of child objects cannot be removed or renamed at runtime. Any object type that has this restriction defines an isRemovable() method to determine if the object can be removed in the scope of the current edit session. You should check the return value of isRemovable before removing an object that may not be removable. If you attempt to remove a non-removable object, an IllegalStateException will be thrown.
Method Summary | ||
---|---|---|
EventSubscription |
addEventSubscription(String name)
Add a named event subscription to this handler. |
|
void |
addHandledTaskPlanId(TaskPlanId taskPlanId)
|
|
EventSubscription |
getEventSubscription(String name)
Get the event subscription with the given name. |
|
String[] |
getEventSubscriptionNames()
Get all subscription names. |
|
|
getEventSubscriptions(Class<T> subsType)
Get all the EventSubscriptionConfiguration instances (as the specific subscription type given by subsType) that have been configured to apply to any event type. |
|
List<EventSubscriptionConfiguration> |
getEventSubscriptions(TaskEvent.Type type)
Return a list of EventSubscriptionConfiguration objects that have been configured to apply to the given type of event. |
|
|
getEventSubscriptions(TaskEvent.Type type,
Class<T> subsType)
Get all the EventSubscriptionConfiguration instances (as the specific subscription type given by subsType) that have been configured to apply to the given event type. |
|
Set<TaskPlanId> |
getHandledTaskPlanIds()
Get the task plans (by id) for which this handler applies. |
|
String |
getName()
Unique name for this handler within the host application. |
|
boolean |
handlesEventType(TaskEvent.Type type)
Indicates if this handler has been configured to do anything with the given type of event. |
|
boolean |
hasEventSubscription(String name)
|
|
boolean |
isDisabled()
If true, this handler is disabled, and is ignored by the runtime listeners intended to respond to the subscriptions it contains. |
|
boolean |
isGlobalHandler()
If true, this handler applies to all task plans. |
|
void |
removeEventSubscription(String name)
NOTE: An event subscription may or may not be removable from an edit session at runtime. |
|
void |
removeHandledTaskPlanId(TaskPlanId taskPlanId)
|
|
void |
renameEventSubscription(String oldName,
String newName)
NOTE: An event subscription may or may not be removable from an edit session at runtime. |
|
void |
setDisabled(boolean disabled)
|
|
void |
setGlobalHandler(boolean global)
|
|
void |
writeToDescriptorStream(OutputStream descriptorStream,
String encoding)
Write the contents of this handler out as XML. |
Method Detail |
---|
String getName()
boolean isDisabled()
void setDisabled(boolean disabled)
boolean isGlobalHandler()
void setGlobalHandler(boolean global)
Set<TaskPlanId> getHandledTaskPlanIds()
void addHandledTaskPlanId(TaskPlanId taskPlanId)
void removeHandledTaskPlanId(TaskPlanId taskPlanId)
String[] getEventSubscriptionNames()
boolean hasEventSubscription(String name)
EventSubscription getEventSubscription(String name) throws UnknownObjectException
UnknownObjectException
- If no subscription by the given name
exists in this handler.List<EventSubscriptionConfiguration> getEventSubscriptions(TaskEvent.Type type)
type
- The event type for which the returned
EventSubscriptionConfiguration list should apply. Pass null here
to get all EventSubscriptionConfigurations for all event types.
<T extends EventSubscriptionConfiguration> List<T> getEventSubscriptions(TaskEvent.Type type, Class<T> subsType)
<T extends EventSubscriptionConfiguration> List<T> getEventSubscriptions(Class<T> subsType)
boolean handlesEventType(TaskEvent.Type type)
EventSubscription addEventSubscription(String name) throws DuplicateObjectException
DuplicateObjectException
void removeEventSubscription(String name)
IllegalStateException
- If the subscription with the given name is
not removable.void renameEventSubscription(String oldName, String newName)
IllegalStateException
- If the subscription with the given name is
not removable.void writeToDescriptorStream(OutputStream descriptorStream, String encoding) throws IOException
descriptorStream
- The output stream into which the XML content will
be written.encoding
- The character encoding (as a valid Java charset name)
to use when generating the XML content for the handler. If null,
a system-defined default encoding is used (though this is not
recommended).
IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |