SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE RemoveComponentRelationship
extern SE_Return_Code
SE_RemoveComponentRelationship
(
SE_Object  aggregate_object,1
SE_Object  component_object,2
SE_Object  link_object3
);

Definition

Breaks the relationship between aggregate_object and component_object (and link_object, if given). Does notremove any of the objects involved from the transmittal (see SE_RemoveFromTransmittal()).

The transmittal whose object is to be edited must be explicitly opened in UPDATE mode for this operation to succeed.

Note that the relationship being removed may be 1-way or 2-way. If it is 2-way, both connections are removed, unless the component is unresolved.


Returns

SE_RETCOD_SUCCESS and the relationship is removed.
SE_RETCOD_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS set if valid parameters were passed in and all operations succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_INPUT_OBJECT set if aggregate_object is unresolved, or link_object is provided but unresolved.
SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT set if the DRM defines the relationship as bidirectional, but component_object is unresolved, so the relationship from component_object to aggregate_object cannot be removed.
SE_STATCODE_INVALID_ACCESS_MODE set if
  1. aggregate_object is in a transmittal that not opened for update,
  2. link_object is provided, but is in a transmittal that is not open for update, or
  3. component_object is resolved and has a relationship back to aggregate_object, but is in a transmittal that is not open in open for update.
SE_STATCODE_INACTIONABLE_FAILURE set if
  1. aggregate_object and component_object are not related by a component relationship,
  2. link_object is provided but is not the link object for the relationship, or
  3. the call fails for any other reason.

Parameters Notes

1 object whose relationship to one of its components is being broken.

2 object whose relationship to one of its aggregators (1-way or 2-way) is being broken

3 if specified, link object for the component relationship being removed.

Prev: SE_RemoveAssociateRelationship. Next: SE_RemoveFromTransmittal. Up:Index.

Last updated: July 1, 2011 Copyright © 2011 SEDRIS™