Removes a participant from a specific relationship instance.
Syntax
void deleteParticipantByInstance(String relDefName, String partDefName, int instanceId [, BusObj partData] ) void deleteParticipantByInstance(String relDefName, String partDefName, int instanceId [, String partData] ) void deleteParticipantByInstance(String relDefName, String partDefName, int instanceId [, long partData] ) void deleteParticipantByInstance(String relDefName, String partDefName, int instanceId [, int partData] ) void deleteParticipantByInstance(String relDefName, String partDefName, int instanceId [, double partData] ) void deleteParticipantByInstance(String relDefName, String partDefName, int instanceId [, float partData] ) void deleteParticipantByInstance(String relDefName, String partDefName, int instanceId [, boolean partData] )
Parameters
Return values
None.
Exceptions
RelationshipRuntimeException
Notes
The deleteParticipantByInstance() method deletes a participant instance from the relationship identified by the instanceId relationship instance ID. The method removes the participant from the relationship instance and from the underlying relationship tables.
If you supply the optional partData parameter, deleteParticipantByInstance() deletes the participant instance only if partData is the data associated with the partDefName participant definition.
The last form of the method accepts a participant instance as the only parameter. The participant instance must contain the relationship definition name, participant definition name, and either the instance ID or the participant data.
The deleteParticipantByInstance() method is a class method declared as static. You can call this method from an existing relationship instance or by referencing the Relationship class.
See also