IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.bo
Interface BOEventSummary


public interface BOEventSummary

The BOEventSummary interface represents the client programming model interface for the BOEventSummary service. The BOEventSummary service provides low level operations for adding annotations to the Business Objects in a Business Graph. Each Business Object can be annotated with an Object Event ID or an Event. These two annotations are both typed as Strings.


Nested Class Summary
static interface BOEventSummary.ObjectContext
           
 
Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void clear()
          Removes all the Object Context objects in the Event Summary.
 java.lang.String getEvent(DataObject businessObject)
          Returns the Event name associated with the Business Object.
 java.util.List getObjectContexts()
          Returns the list of Object Context objects for each Business Object in the Business Graph that has either an Object Event ID and/or an Event name associated with it.
 java.lang.String getObjectEventID(DataObject businessObject)
          Returns the Object Event ID associated with the Business Object.
 void removeEvent(DataObject businessObject)
          Removes the Event name associated with the Business Object.
 void removeObjectEventID(DataObject businessObject)
          Removes the Object Event ID associated with the Business Object.
 void setEvent(DataObject businessObject, java.lang.String event)
          Annotate the Business Object with an Event name.
 void setObjectEventID(DataObject businessObject, java.lang.String objectEventID)
          Annotate the Business Object with an Object Event ID that uniquely identiifes it in the graph of Business Objects.
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

setObjectEventID

void setObjectEventID(DataObject businessObject,
                      java.lang.String objectEventID)
Annotate the Business Object with an Object Event ID that uniquely identiifes it in the graph of Business Objects.

The Business Object must be contained in a Business Graph that contains the Event Summary.

Parameters:
businessObject - The Business Object to annotate with an Object Event ID string
objectEventID - A string to uniquely identify the Business Object

getObjectEventID

java.lang.String getObjectEventID(DataObject businessObject)
Returns the Object Event ID associated with the Business Object.

The Business Object must be contained in a Business Graph that contains the Event Summary.

Parameters:
businessObject - The Business Object to annotate with an Object Event ID string
Returns:
Returns the Object Event ID string that uniquely identifies the Business Object

removeObjectEventID

void removeObjectEventID(DataObject businessObject)
Removes the Object Event ID associated with the Business Object.

The Business Object must be contained in a Business Graph that contains the Event Summary.

Parameters:
businessObject - The Business Object to annotate with an Object Event ID string

setEvent

void setEvent(DataObject businessObject,
              java.lang.String event)
Annotate the Business Object with an Event name. This field can be used to annotate a Business Object instance with any string.

The Business Object must be contained in a Business Graph that contains the Event Summary.

Parameters:
businessObject - The Business Object to annotate with the Event name
event - The Event name

getEvent

java.lang.String getEvent(DataObject businessObject)
Returns the Event name associated with the Business Object.

The Business Object must be contained in a Business Graph that contains the Event Summary.

Parameters:
businessObject - The Business Object to annotate with the Event name
Returns:
Returns the Event name

removeEvent

void removeEvent(DataObject businessObject)
Removes the Event name associated with the Business Object.

The Business Object must be contained in a Business Graph that contains the Event Summary.

Parameters:
businessObject - The Business Object to annotate with the Event name

getObjectContexts

java.util.List getObjectContexts()
Returns the list of Object Context objects for each Business Object in the Business Graph that has either an Object Event ID and/or an Event name associated with it.

Returns:
A List of ObjectContext objects

clear

void clear()
Removes all the Object Context objects in the Event Summary.


IBM WebSphere Application ServerTM
Release 7