The methods documented in this chapter operate on objects of the IBM WebSphere InterChange Server Express-defined class Relationship. The Relationship class provides methods for manipulating the runtime instances of relationships, called relationship instances. You typically use these methods in transformation steps for business object attributes that are mapped as identity relationships or static lookups. For more information on programming relationship attributes using the methods in this class, see "Transforming with a submap".
Most methods in this class support variations in the parameters you specify. The variations generally follow these guidelines:
In most cases, if you have a Participant instance (for example, as the result of a retrieve() call), it is easier to pass it as a parameter to a Relationship class method instead of specifying each attribute individually.
All methods in this class are declared as static. You can call them from existing relationship instances or by referencing the Relationship class.
Table 109 summarizes the methods in the Relationship
class.
Method | Description | Page |
---|---|---|
Static methods | ||
addParticipant() | Adds a new participant to a relationship instance. | addParticipant() |
create() | Creates a new relationship instance. | create() |
deactivateParticipant() | Deactivates a participant from one or more relationship instances. | deactivateParticipant() |
deactivateParticipantByInstance() | Deactivates a participant from a specific relationship instance. | deactivateParticipantByInstance() |
deleteParticipant() | Removes a participant instance from one or more relationship instances. | deleteParticipant() |
deleteParticipantByInstance() | Removes a participant from a specific relationship instance. | deleteParticipantByInstance() |
getNewID() | Returns the next available relationship instance ID for a relationship, based on the relationship definition name. | getNewID() |
retrieveInstances() | Retrieves only the relationship instance IDs for zero or more relationship instances which contain a given participant instance. | retrieveInstances() |
retrieveParticipants() | Retrieves zero or more participants from a relationship instance. | retrieveParticipants() |
updateParticipant() | Updates a participant in one or more relationship instances. | updateParticipant() |
updateParticipantByInstance() | Updates a participant in a specific relationship instance. | updateParticipantByInstance() |