com.ibm.websphere.bo

Interface BOEventSummary


  1. 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

Modifier and Type Interface and Description
  1. static interface
BOEventSummary.ObjectContext

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Method Summary

Modifier and Type Method and Description
  1. void
clear()
Removes all the Object Context objects in the Event Summary.
  1. java.lang.String
getEvent(commonj.sdo.DataObject businessObject)
Returns the Event name associated with the Business Object.
  1. 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.
  1. java.lang.String
getObjectEventID(commonj.sdo.DataObject businessObject)
Returns the Object Event ID associated with the Business Object.
  1. void
removeEvent(commonj.sdo.DataObject businessObject)
Removes the Event name associated with the Business Object.
  1. void
removeObjectEventID(commonj.sdo.DataObject businessObject)
Removes the Object Event ID associated with the Business Object.
  1. void
setEvent(commonj.sdo.DataObject businessObject,java.lang.String event)
Annotate the Business Object with an Event name.
  1. void
setObjectEventID(commonj.sdo.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

  1. static final java.lang.String COPYRIGHT
See Also:

Method Detail

setObjectEventID

  1. void setObjectEventID(commonj.sdo.DataObject businessObject,
  2. 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

  1. java.lang.String getObjectEventID( commonj.sdo.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

  1. void removeObjectEventID(commonj.sdo.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

  1. void setEvent(commonj.sdo.DataObject businessObject,
  2. 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

  1. java.lang.String getEvent(commonj.sdo.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

  1. void removeEvent(commonj.sdo.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

  1. 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

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