Deactivates a participant from a specific relationship instance.
Syntax
void deactivateParticipantByInstance(String relDefName, String partDefName, int instanceId [, BusObj partData ] ) void deactivateParticipantByInstance(String relDefName, String partDefName, int instanceId [, String partData ] ) void deactivateParticipantByInstance(String relDefName, String partDefName, int instanceId [, long partData ] ) void deactivateParticipantByInstance(String relDefName, String partDefName, int instanceId [, int partData ] ) void deactivateParticipantByInstance(String relDefName, String partDefName, int instanceId [, double partData ] ) void deactivateParticipantByInstance(String relDefName, String partDefName, int instanceId [, float partData ] ) void deactivateParticipantByInstance(String relDefName, String partDefName, int instanceId [, boolean partData ] )
Parameters
Return values
None.
Exceptions
RelationshipRuntimeException - See "Handling exceptions".
Notes
The deactivateParticipantByInstance() method deactivates the specified participant from the relationship instance that relationship instance ID instanceID identifies. However, the method does not remove the participant from the relationship tables. Use this method when you want 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 deactivateParticipantByInstance() 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