Deactivates a participant from one or more relationship instances.
Syntax
void deactivateParticipant(String relDefName, String partDefName, BusObj partData) void deactivateParticipant(String relDefName, String partDefName, String partData) void deactivateParticipant(String relDefName, String partDefName, long partData) void deactivateParticipant(String relDefName, String partDefName, int partData) void deactivateParticipant(String relDefName, String partDefName, double partData) void deactivateParticipant(String relDefName, String partDefName, float partData) void deactivateParticipant(String relDefName, String partDefName, boolean partData) void deactivateParticipant(Participant participant)
Parameters
Return values
None.
Exceptions
RelationshipRuntimeException
Notes
The deactivateParticipant() method deactivates the participant from all instances of relDefName where partData is associated with partDefName. This method does not remove the participant from the relationship tables. Use this method to remove a participant while preserving a record of its existence in the relationship tables.
To view deactivated participants, you can query the relationship tables directly. To find the table names and access information for a given relationship, open the relationship definition using Relaitonship Designer Express and choose Advanced Settings from the Edit menu. See "Specifying advanced relationship settings" for more information on these settings.
The deactivateParticipant() 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
deleteParticipant(), deactivateParticipantByInstance(), Creating relationship definitions, "Transforming with a submap"