com.ibm.wbiserver.rel
Interface RelationshipService

All Known Implementing Classes:
RelationshipServiceImpl

public interface RelationshipService

The RelationshipService interface represents the client programming model for the Relationship Service. The RelationshipService provides operations for Relationship and Role management.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 int addParticipant(java.lang.String relationshipName, java.lang.String roleName, commonj.sdo.DataObject bo)
          Adds a participant to a new relationship instance.
 int addParticipantBoolean(java.lang.String relationshipName, java.lang.String roleName, boolean dataSimpleType)
          Adds a participant to a new relationship instance.
 int addParticipantBooleanWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, boolean dataSimpleType)
          Adds a participant for an existing relationship instance.
 int addParticipantDouble(java.lang.String relationshipName, java.lang.String roleName, double dataSimpleType)
          Adds a participant to a new relationship instance.
 int addParticipantDoubleWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, double dataSimpleType)
          Adds a participant for an existing relationship instance.
 int addParticipantFloat(java.lang.String relationshipName, java.lang.String roleName, float dataSimpleType)
          Adds a participant to a new relationship instance.
 int addParticipantFloatWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, float dataSimpleType)
          Adds a participant for an existing relationship instance.
 int addParticipantInt(java.lang.String relationshipName, java.lang.String roleName, int dataSimpleType)
          Adds a participant to a new relationship instance.
 int addParticipantIntWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, int dataSimpleType)
          Adds a participant for an existing relationship instance.
 int addParticipantLong(java.lang.String relationshipName, java.lang.String roleName, long dataSimpleType)
          Adds a participant to a new relationship instance.
 int addParticipantLongWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, long dataSimpleType)
          Adds a participant for an existing relationship instance.
 int addParticipantString(java.lang.String relationshipName, java.lang.String roleName, java.lang.String dataString)
          Adds a participant to a new relationship instance.
 int addParticipantStringWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, java.lang.String dataString)
          Adds a participant for an existing relationship instance.
 int addParticipantWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceId, commonj.sdo.DataObject bo)
          Adds a participant for an existing relationship instance that match this relationship, ASBO role and instance id.
 int createParticipant(java.lang.String relationshipName, java.lang.String roleName, commonj.sdo.DataObject bo)
          Adds a participant to a new relationship instance.
 int createParticipantBoolean(java.lang.String relationshipName, java.lang.String roleName, boolean dataSimpleType)
          Adds a participant to a new relationship instance.
 int createParticipantBooleanWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, boolean dataSimpleType)
          Adds a participant for an existing relationship instance.
 int createParticipantDouble(java.lang.String relationshipName, java.lang.String roleName, double dataSimpleType)
          Adds a participant to a new relationship instance.
 int createParticipantDoubleWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, double dataSimpleType)
          Adds a participant for an existing relationship instance.
 int createParticipantFloat(java.lang.String relationshipName, java.lang.String roleName, float dataSimpleType)
          Adds a participant to a new relationship instance.
 int createParticipantFloatWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, float dataSimpleType)
          Adds a participant for an existing relationship instance.
 int createParticipantInt(java.lang.String relationshipName, java.lang.String roleName, int dataSimpleType)
          Adds a participant to a new relationship instance.
 int createParticipantIntWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, int dataSimpleType)
          Adds a participant for an existing relationship instance.
 int createParticipantLong(java.lang.String relationshipName, java.lang.String roleName, long dataSimpleType)
          Adds a participant to a new relationship instance.
 int createParticipantLongWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, long dataSimpleType)
          Adds a participant for an existing relationship instance.
 int createParticipantString(java.lang.String relationshipName, java.lang.String roleName, java.lang.String dataString)
          Adds a participant to a new relationship instance.
 int createParticipantStringWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, java.lang.String dataString)
          Adds a participant for an existing relationship instance.
 int createParticipantWithID(java.lang.String relationshipName, java.lang.String roleName, int instanceId, commonj.sdo.DataObject bo)
          Adds a participant for an existing relationship instance that has this instanceId.
 void deactivateParticipant(java.lang.String relationshipName, java.lang.String roleName, commonj.sdo.DataObject bo)
          Deactivates all the participants of this relationship that match the specified BO.
 void deactivateParticipantBoolean(java.lang.String relationshipName, java.lang.String roleName, boolean dataSimpleType)
          Deactivates all the participants of this relationship that match this data for the participant.
 void deactivateParticipantBooleanByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, boolean dataSimpleType)
          Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID.
 void deactivateParticipantByID(java.lang.String relationshipName, java.lang.String roleName, int instanceId)
          Deactivates all the participants of this relationship that matche the specified relationship instanceID.
 void deactivateParticipantByIDAndDO(java.lang.String relationshipName, java.lang.String roleName, int instanceId, commonj.sdo.DataObject bo)
          Deactivates all the partcipants that match this relationship, role, BO and instanceId.
 void deactivateParticipantDouble(java.lang.String relationshipName, java.lang.String roleName, double dataSimpleType)
          Deactivates all the participants of this relationship that match this data for the participant.
 void deactivateParticipantDoubleByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, double dataSimpleType)
          Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID.
 void deactivateParticipantFloat(java.lang.String relationshipName, java.lang.String roleName, float dataSimpleType)
          Deactivates all the participants of this relationship that match this data for the participant.
 void deactivateParticipantFloatByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, float dataSimpleType)
          Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID.
 void deactivateParticipantInt(java.lang.String relationshipName, java.lang.String roleName, int dataSimpleType)
          Deactivates all the participants of this relationship that match this data for the participant.
 void deactivateParticipantIntByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, int dataSimpleType)
          Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID.
 void deactivateParticipantLong(java.lang.String relationshipName, java.lang.String roleName, long dataSimpleType)
          Deactivates all the participants of this relationship that match this data for the participant.
 void deactivateParticipantLongByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, long dataSimpleType)
          Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID.
 void deactivateParticipantString(java.lang.String relationshipName, java.lang.String roleName, java.lang.String dataString)
          Deactivates all the participants of this relationship that match this data for the participant.
 void deactivateParticipantStringByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, java.lang.String dataString)
          Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID.
 void deleteAllParticipants(java.lang.String relationshipName, java.lang.String roleName)
          Deletes all the participants for this relationship and the ASBO role.
 void deleteParticipant(java.lang.String relationshipName, java.lang.String roleName, commonj.sdo.DataObject bo)
          Deletes all the participants of this relationship that match the specified BO.
 void deleteParticipantBoolean(java.lang.String relationshipName, java.lang.String roleName, boolean dataSimpleType)
          Deletes all the participants of this relationship that match this role and the specified data.
 void deleteParticipantBooleanByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, boolean dataSimpleType)
          Deletes all the participants that match this relationship name, role name, relationship instanceID and the data.
 void deleteParticipantByID(java.lang.String relationshipName, java.lang.String roleName, int instanceId)
          Deletes all the participants of this relationship that matche the specified relationship instanceID.
 void deleteParticipantByIDAndDO(java.lang.String relationshipName, java.lang.String roleName, int instanceId, commonj.sdo.DataObject bo)
          Deletes all the partcipants that match this relationship, role, BO and instanceId.
 void deleteParticipantDouble(java.lang.String relationshipName, java.lang.String roleName, double dataSimpleType)
          Deletes all the participants of this relationship that match this role and the specified data.
 void deleteParticipantDoubleByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, double dataSimpleType)
          Deletes all the participants that match the relationship name, role name, relationship instanceID and the data.
 void deleteParticipantFloat(java.lang.String relationshipName, java.lang.String roleName, float dataSimpleType)
          Deletes all the participants of this relationship that match this role and the specified data.
 void deleteParticipantFloatByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, float dataSimpleType)
          Deletes all the participants that match the relationship name, role name, relationship instanceID and the data.
 void deleteParticipantInt(java.lang.String relationshipName, java.lang.String roleName, int dataSimpleType)
          Deletes all the participants of this relationship that match this role and the specified data.
 void deleteParticipantIntByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, int dataSimpleType)
          Deletes all the participants that match the relationship name, role name, relationship instanceID and the data.
 void deleteParticipantLong(java.lang.String relationshipName, java.lang.String roleName, long dataSimpleType)
          Deletes all the participants of this relationship that match this role and the specified data.
 void deleteParticipantLongByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, long dataSimpleType)
          Deletes all the participants that match the relationship name, role name, relationship instanceID and the data.
 void deleteParticipantString(java.lang.String relationshipName, java.lang.String roleName, java.lang.String dataString)
          Deletes all the participants of this relationship that match this role and the specified data.
 void deleteParticipantStringByID(java.lang.String relationshipName, java.lang.String roleName, int instanceID, java.lang.String dataString)
          Deletes all the participants that match this relationship name, role name, relationship instanceID and the data.
 boolean existsParticipant(java.lang.String relationshipName, java.lang.String roleName, commonj.sdo.DataObject bo)
          Determines the existence of a participant that matches this relationship, ASBO role and BO.
 boolean existsParticipantByID(java.lang.String relationshipName, java.lang.String roleName, int instanceId)
          Determines the existence of a participant that matches this relationship, ASBO role and owns the given relationship instanceID.
 void foreignKeyLookup(java.lang.String foreignRelationshipName, java.lang.String foreignInputRoleName, commonj.sdo.DataObject inputBO, java.util.List inputBOForeignKeys, java.lang.String foreignOutputRoleName, commonj.sdo.DataObject outputBO, java.util.List outputBOForeignKeys, commonj.sdo.DataObject originalInputBO, commonj.sdo.DataObject originalOutputBO, java.lang.String callingContext)
          Performs a lookup in the foreign relationship table based on the foreign key of the source business object in normal calling contexts (SERVICE_CALL_REQUEST, EVENT_DELIVERY and SERVICE_CALL_RESPONSE).
 void foreignKeyXref(java.lang.String foreignRelationshipName, java.lang.String foreignInputRoleName, commonj.sdo.DataObject inputBO, java.util.List inputBOForeignKeys, java.lang.String foreignOutputRoleName, commonj.sdo.DataObject outputBO, java.util.List outputBOForeignKeys, commonj.sdo.DataObject originalInputBO, commonj.sdo.DataObject originalOutputBO, java.lang.String callingContext)
          Performs a lookup in this foreign relationship table based on the foreign key of this input business object in the calling context SERVICE_CALL_REQUEST, EVENT_DELIVERY and SERVICE_CALL_RESPONSE.
 java.lang.Object getRelationshipProperty(java.lang.String relationshipName, java.lang.String propertyName, int instanceid)
          Gets the value of the user defined property in this relationship instance.
 java.lang.Object getRoleProperty(java.lang.String relationshipName, java.lang.String roleName, java.lang.String propertyName, int instanceid, java.lang.Object dataobject)
          Gets the value of this user defined property for the given role instance.
 boolean isSetRelationshipProperty(java.lang.String relationshipName, java.lang.String propertyName, int instanceid)
          Determines if the user defined property for the given relationship instance is set.
 boolean isSetRoleProperty(java.lang.String relationshipName, java.lang.String roleName, java.lang.String propertyName, int instanceid, java.lang.Object dataobject)
          Determines if this user defined property for the given role instance is set.
 void maintainIdentityRelationship(java.lang.String relationshipName, java.lang.String appRoleName, commonj.sdo.DataObject inputBO, commonj.sdo.DataObject outputBO, commonj.sdo.DataObject originalInputBO, commonj.sdo.DataObject originalOutputBO, java.lang.String callingContext)
          Maintains an identity relationship, this could be used for both simple and composite relationship.
 int[] retrieveInstanceIDs(java.lang.String relationshipName, java.lang.String roleName, commonj.sdo.DataObject bo)
          Retrieves instance ids of relationship instances that match this relationship name, role name and BO.
 int[] retrieveInstanceIDsByBoolean(java.lang.String relationshipName, java.lang.String roleName, boolean dataSimpleType)
          Retrieves ids of all the participants that match this relationship, role and data.
 int[] retrieveInstanceIDsByDouble(java.lang.String relationshipName, java.lang.String roleName, double dataSimpleType)
          Retrieves ids of all the participants that match this relationship, role and data.
 int[] retrieveInstanceIDsByFloat(java.lang.String relationshipName, java.lang.String roleName, float dataSimpleType)
          Retrieves ids of all the participants that match this relationship, role and data.
 int[] retrieveInstanceIDsByInt(java.lang.String relationshipName, java.lang.String roleName, int dataSimpleType)
          Retrieves ids of all the participants that match this relationship, role and data.
 int[] retrieveInstanceIDsByLong(java.lang.String relationshipName, java.lang.String roleName, long dataSimpleType)
          Retrieves ids of all the participants that match this relationship, role and data.
 int[] retrieveInstanceIDsByRelNameBoolean(java.lang.String relationshipName, boolean dataSimpleType)
          Retrieves ids of the participants that match this relationship name and data.
 int[] retrieveInstanceIDsByRelNameDouble(java.lang.String relationshipName, double dataSimpleType)
          Retrieves ids of the participants that match this relationship name and data.
 int[] retrieveInstanceIDsByRelNameFloat(java.lang.String relationshipName, float dataSimpleType)
          Retrieves ids of the participants that match this relationship name and data.
 int[] retrieveInstanceIDsByRelNameInt(java.lang.String relationshipName, int dataSimpleType)
          Retrieves ids of the participants that match this relationship name and data.
 int[] retrieveInstanceIDsByRelNameLong(java.lang.String relationshipName, long dataSimpleType)
          Retrieves ids of the participants that match this relationship name and data.
 int[] retrieveInstanceIDsByRelNameString(java.lang.String relationshipName, java.lang.String dataString)
          Retrieves ids of the participants that match this relationship name and data.
 int[] retrieveInstanceIDsByRoleNameBoolean(java.lang.String relationshipName, java.lang.String[] roleName, boolean dataSimpleType)
          Retrieves ids of the participants that match the relationship name, the list of role names and the specified data.
 int[] retrieveInstanceIDsByRoleNameDouble(java.lang.String relationshipName, java.lang.String[] roleName, double dataSimpleType)
          Retrieves ids of the participants that match the relationship name, the list of role names and the specified data.
 int[] retrieveInstanceIDsByRoleNameFloat(java.lang.String relationshipName, java.lang.String[] roleName, float dataSimpleType)
          Retrieves ids of the participants that match the relationship name, the list of role names and the specified data.
 int[] retrieveInstanceIDsByRoleNameInt(java.lang.String relationshipName, java.lang.String[] roleName, int dataSimpleType)
          Retrieves ids of the participants that match the relationship name, the list of role names and the specified data.
 int[] retrieveInstanceIDsByRoleNameLong(java.lang.String relationshipName, java.lang.String[] roleName, long dataSimpleType)
          Retrieves ids of the participants that match the relationship name, the list of role names and the specified data.
 int[] retrieveInstanceIDsByRoleNameString(java.lang.String relationshipName, java.lang.String[] roleName, java.lang.String dataString)
          Retrieves ids of the participants that match this relationship name, the list of role names and the specified data.
 int[] retrieveInstanceIDsByString(java.lang.String relationshipName, java.lang.String roleName, java.lang.String dataString)
          Retrieves ids of all the participants that match this relationship, role and data.
 int[] retrieveInstanceIDsForParentObject(java.lang.String relationshipName, java.lang.String roleName, commonj.sdo.DataObject parent)
          Retrieves InstanceIDs of the partcipants whose parent data match this parent ASBO.
 int[] retrieveInstanceIDsUseDeactivate(java.lang.String relationshipName, java.lang.String roleName, java.lang.String dataString)
          Retrieves ids of relationship instances that match this relationship name, role name and data.
 java.util.List retrieveParticipants(java.lang.String relationshipName, java.lang.String roleName, int instanceId)
          Retrieves all the participants of this relationship that match this ASBO roleName and have this instance id.
 java.util.List retrieveParticipantsByRelationshipName(java.lang.String relationshipName, int instanceID)
          Retrieves all the matched participants from all the ASBO roles of this relationship.
 java.util.List retrieveParticipantsByRoleName(java.lang.String relationshipName, java.lang.String[] roleNames, int instanceID)
          Retrieves all the participants from this relationship and the list of ASBO roles.
 void setRelationshipProperty(java.lang.String relationshipName, java.lang.String propertyName, java.lang.Object value, int instanceid)
          Sets value for the user defined property into this relationship instance.
 void setRoleProperty(java.lang.String relationshipName, java.lang.String roleName, java.lang.String propertyName, java.lang.Object propertyValue, int instanceid, java.lang.Object object)
          Sets the specified property with the specifed value for the given role instance.
 void setRolePropertyWithOldValue(java.lang.String relationshipName, java.lang.String roleName, java.lang.String propertyName, java.lang.Object propertyValue, java.lang.Object oldPropertyValue, int instanceid)
          Sets this propertyValue to the given role property in the role instance.
 void unsetRelationshipProperty(java.lang.String relationshipName, java.lang.String propertyName, int instanceid)
          Unsets this property for the given relationship instance.
 void unsetRoleProperty(java.lang.String relationshipName, java.lang.String roleName, java.lang.String propertyName, int instanceid, java.lang.Object dataobject)
          Removes property value for this this role instance.It can be used for static as well as dynamic relationship.
 void unsetRolePropertyWithOldValue(java.lang.String relationshipName, java.lang.String roleName, java.lang.String propertyName, java.lang.Object oldPropertyValue, int instanceid)
          Unsets value of this role property in the give role instance.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

foreignKeyXref

public void foreignKeyXref(java.lang.String foreignRelationshipName,
                           java.lang.String foreignInputRoleName,
                           commonj.sdo.DataObject inputBO,
                           java.util.List inputBOForeignKeys,
                           java.lang.String foreignOutputRoleName,
                           commonj.sdo.DataObject outputBO,
                           java.util.List outputBOForeignKeys,
                           commonj.sdo.DataObject originalInputBO,
                           commonj.sdo.DataObject originalOutputBO,
                           java.lang.String callingContext)
                    throws RelationshipServiceException,
                           RelationshipUserException,
                           MissingIdException
Performs a lookup in this foreign relationship table based on the foreign key of this input business object in the calling context SERVICE_CALL_REQUEST, EVENT_DELIVERY and SERVICE_CALL_RESPONSE.

Currently it supports single foreign key attribute only.

Parameters:
foreignRelationshipName - name of the foreign identity relationship that manages the foreign business object
foreignInputRoleName - role name of the foreign relationship for the foreign incoming object
inputBO - input business object that contains the foreign attributes for this foreign input role. It could also be a BusinessGraph.
inputBOForeignKeys - names of the attributes defined in this foreign input role
foreignOutputRoleName - role name of the foreign relationship for the foregin outgoing object
outputBO - output business object that contains the foreign attributes for this foreign output role. It could also be a BusinessGraph.
outputBOForeignKeys - names of the attributes defined in this foregin output role
originalInputBO - original input business object that contains the foreign key attributes. It could also be a BusinessGraph.
originalOutputBO - original output business object that contains the foreign key attributes. It could also be a BusinessGraph.
callingContext - calling context. It could be SERVICE_CALL_REQUEST, EVENT_DELIVERY, SERVICE_CALL_RESPONSE and SERVICE_CALL_FAILURE.
Throws:
RelationshipServiceException
RelationshipUserException
MissingIdException

foreignKeyLookup

public void foreignKeyLookup(java.lang.String foreignRelationshipName,
                             java.lang.String foreignInputRoleName,
                             commonj.sdo.DataObject inputBO,
                             java.util.List inputBOForeignKeys,
                             java.lang.String foreignOutputRoleName,
                             commonj.sdo.DataObject outputBO,
                             java.util.List outputBOForeignKeys,
                             commonj.sdo.DataObject originalInputBO,
                             commonj.sdo.DataObject originalOutputBO,
                             java.lang.String callingContext)
                      throws RelationshipServiceException,
                             RelationshipUserException,
                             MissingIdException
Performs a lookup in the foreign relationship table based on the foreign key of the source business object in normal calling contexts (SERVICE_CALL_REQUEST, EVENT_DELIVERY and SERVICE_CALL_RESPONSE). If the instance is not found, a MissingIdException is thrown . If the verb or change of inputBO is not set, a RelationshipServiceException is thrown. If the calling context is SERVICE_CALL_FAILURE, it simply returns outputBOForeignKeys of originalInputBO.

Currently it supports single foreign key attribute only.

Parameters:
foreignRelationshipName - name of the foreign identity relationship that manages the foreign business object
foreignInputRoleName - role name of the foreign relationship for the foreign incoming object
inputBO - input business object that contains the foreign attributes for this foreign input role. It could also be a BusinessGraph.
inputBOForeignKeys - names of the attributes defined in this foreign input role
foreignOutputRoleName - role name of the foreign relationship for the foregin outgoing object
outputBO - output business object that contains the foreign attributes for this foreign output role. It could also be a BusinessGraph.
outputBOForeignKeys - names of the attributes defined in this foregin output role
originalInputBO - original input business object that contains the foreign key attributes. It could also be a BusinessGraph.
originalOutputBO - original output business object that contains the foreign key attributes. It could also be a BusinessGraph.
callingContext - calling context. It could be SERVICE_CALL_REQUEST, EVENT_DELIVERY, SERVICE_CALL_RESPONSE and SERVICE_CALL_FAILURE.
Throws:
RelationshipServiceException
RelationshipUserException
MissingIdException

addParticipant

public int addParticipant(java.lang.String relationshipName,
                          java.lang.String roleName,
                          commonj.sdo.DataObject bo)
                   throws RelationshipServiceException,
                          RelationshipUserException
Adds a participant to a new relationship instance. This BO contains value for the target participant that match the given relationship and ASBO role. This API can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipant("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", sapCustomer);

Parameters:
relationshipName - name of the relationship to add the participant to. If no Relationship found, RelationshipUserException is thrown.
roleName - name of the ASBO role to add the participant to. If no role found, RelationshipUserException is thrown.
bo - ASBO that contains value for the participant. It could also be a BusinessGraph. If there is a matched existing participant, the instance id of the existing one is returned.
Returns:
relationship instance ID
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantWithID

public int addParticipantWithID(java.lang.String relationshipName,
                                java.lang.String roleName,
                                int instanceId,
                                commonj.sdo.DataObject bo)
                         throws RelationshipServiceException,
                                RelationshipUserException
Adds a participant for an existing relationship instance that match this relationship, ASBO role and instance id. This API can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipantWithID("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", 1, sapCustomer);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException is thrown.
roleName - name of the ASBO role to add the participant to. If no role found, RelationshipUserException is thrown.
instanceId - given relationship instanceID
bo - ASBO that contains value for the participant. It could also be a BusinessGraph. If there is a matched existing participant, the instance id of the existing one is returned.
Returns:
relationship instance ID
Throws:
RelationshipServiceException
RelationshipUserException

existsParticipant

public boolean existsParticipant(java.lang.String relationshipName,
                                 java.lang.String roleName,
                                 commonj.sdo.DataObject bo)
                          throws RelationshipServiceException,
                                 RelationshipUserException
Determines the existence of a participant that matches this relationship, ASBO role and BO. This API can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
boolean result = relService.existsParticipant("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", sapCustomer);

Parameters:
relationshipName - name of the relationship to check. If no relationship found, RelationshipUserException is thrown.
roleName - name of the ASBO role to check. If no role found, RelationshipUserException is thrown.
bo - ASBO contains the value for the target participant. It could also be a BusinessGraph.
Returns:
true, if a matched participant exists false, if can't find a matched participant.
Throws:
RelationshipServiceException
RelationshipUserException

existsParticipantByID

public boolean existsParticipantByID(java.lang.String relationshipName,
                                     java.lang.String roleName,
                                     int instanceId)
                              throws RelationshipServiceException,
                                     RelationshipUserException
Determines the existence of a participant that matches this relationship, ASBO role and owns the given relationship instanceID. This API can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
boolean result = relService.existsParticipantByID("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", 1);

Parameters:
relationshipName - name of the relationship to check. If no relationship found, RelationshipUserException is thrown.
roleName - name of the ASBO role to check. If no role found, RelationshipUserException is thrown.
instanceId - given relationship instanceID
Returns:
true, if a matched participant exists false, if can't find a matched participant.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipant

public void deactivateParticipant(java.lang.String relationshipName,
                                  java.lang.String roleName,
                                  commonj.sdo.DataObject bo)
                           throws RelationshipServiceException,
                                  RelationshipUserException
Deactivates all the participants of this relationship that match the specified BO. This BO contains value for the ASBO role. It could aslo be a BusinessGraph. This API can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deactivateParticipant("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", sapCustomer);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException is thrown.
roleName - name of the ASBO role to deactivate the partcipants from. If no role found, RelationshipUserException is thrown.
bo - ASBO contains value for the partcipants to be deleted. It could aslo be a BusinessGraph.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantByID

public void deactivateParticipantByID(java.lang.String relationshipName,
                                      java.lang.String roleName,
                                      int instanceId)
                               throws RelationshipServiceException,
                                      RelationshipUserException
Deactivates all the participants of this relationship that matche the specified relationship instanceID. This API can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deactivateParticipantByID("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", 1);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException is thrown.
roleName - name of the ASBO role to deactivate the participants from. If no role found, RelationshipUserException is thrown.
instanceId - specified relationship instanceID
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantByIDAndDO

public void deactivateParticipantByIDAndDO(java.lang.String relationshipName,
                                           java.lang.String roleName,
                                           int instanceId,
                                           commonj.sdo.DataObject bo)
                                    throws RelationshipServiceException,
                                           RelationshipUserException
Deactivates all the partcipants that match this relationship, role, BO and instanceId. The BO contains value for the ASBO role. This API can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deactivateParticipantByIDAndDO("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", 1, sapCustomer);

Parameters:
relationshipName - name of the relationship to deactivate the partcipant from. If no relationship found, RelationshipUserException is thrown.
roleName - name of the ASBO role to deactivate the partcipant from. If no role found, RelationshipUserException is thrown.
instanceId - specified relationship instanceID
bo - ASBO contains value for the partcipant to be deleted. It could also be a BusinessGraph.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipant

public void deleteParticipant(java.lang.String relationshipName,
                              java.lang.String roleName,
                              commonj.sdo.DataObject bo)
                       throws RelationshipServiceException,
                              RelationshipUserException
Deletes all the participants of this relationship that match the specified BO. This BO contains value for the ASBO role. It could aslo be a BusinessGraph. This API can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deleteParticipant("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", sapCustomer);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException is thrown.
roleName - name of the ASBO role to delete the partcipants from. If no role found, RelationshipUserException is thrown.
bo - ASBO contains value for the partcipants to be deleted. It could aslo be a BusinessGraph.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantByID

public void deleteParticipantByID(java.lang.String relationshipName,
                                  java.lang.String roleName,
                                  int instanceId)
                           throws RelationshipServiceException,
                                  RelationshipUserException
Deletes all the participants of this relationship that matche the specified relationship instanceID. This API can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deleteParticipantByID("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", 1);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException is thrown.
roleName - name of the ASBO role to delete the participants from. If no role found, RelationshipUserException is thrown.
instanceId - specified relationship instanceID
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantByIDAndDO

public void deleteParticipantByIDAndDO(java.lang.String relationshipName,
                                       java.lang.String roleName,
                                       int instanceId,
                                       commonj.sdo.DataObject bo)
                                throws RelationshipServiceException,
                                       RelationshipUserException
Deletes all the partcipants that match this relationship, role, BO and instanceId. The BO contains value for the ASBO role. This API can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deleteParticipantByIDAndDO("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", 1, sapCustomer);

Parameters:
relationshipName - name of the relationship to delete the partcipant from. If no relationship found, RelationshipUserException is thrown.
roleName - name of the ASBO role to delete the partcipant from. If no role found, RelationshipUserException is thrown.
instanceId - specified relationship instanceID
bo - ASBO contains value for the partcipant to be deleted. It could also be a BusinessGraph.
Throws:
RelationshipServiceException
RelationshipUserException

deleteAllParticipants

public void deleteAllParticipants(java.lang.String relationshipName,
                                  java.lang.String roleName)
                           throws RelationshipServiceException,
                                  RelationshipUserException
Deletes all the participants for this relationship and the ASBO role. It can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deleteAllParticipants("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole");

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException is thrown.
roleName - name of the role to delete the partcipants from. If no role found, RelationshipUserException is thrown.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDs

public int[] retrieveInstanceIDs(java.lang.String relationshipName,
                                 java.lang.String roleName,
                                 commonj.sdo.DataObject bo)
                          throws RelationshipServiceException,
                                 RelationshipUserException
Retrieves instance ids of relationship instances that match this relationship name, role name and BO. The BO contains the key values for the ASBO role. It could also be a BusinessGraph. This API can be used for static as well as dynamic relationships.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDs("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", sapCustomer);

Parameters:
relationshipName - name of the relationship to retrieve the instanceIDs from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the ASBO role for retrieve. If no role found, RelationshipUserException will be thrown.
bo - ASBO that corresponds to this role. It could be a BusinessObject or a BusinessGraph. Either null value or a empty BusinessGraph instance that could not retrieve a BusinessObject from will cause RelationshipUserException
Returns:
a int array of instance ids. If no target instance found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsForParentObject

public int[] retrieveInstanceIDsForParentObject(java.lang.String relationshipName,
                                                java.lang.String roleName,
                                                commonj.sdo.DataObject parent)
                                         throws RelationshipServiceException,
                                                RelationshipUserException
Retrieves InstanceIDs of the partcipants whose parent data match this parent ASBO. It is used in the case of composite relationship where ASBO Roles contain both key attributes of parent ASBO and child ASBO.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsForParentObject("http://www.ibm.com/CompositeRel", "http://www.ibm.com/Level1InRol", level1InBO);

Parameters:
relationshipName - name of the composite relationship to retrieve instanceIDs from
roleName - name of the ASBO role to retrieve instanceIDs from
parent - parent ASBO contained in the target participant instances. It could also be a BusinessGraph.
Returns:
int array of matched instance ids. If no target instance found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveParticipants

public java.util.List retrieveParticipants(java.lang.String relationshipName,
                                           java.lang.String roleName,
                                           int instanceId)
                                    throws RelationshipServiceException,
                                           RelationshipUserException
Retrieves all the participants of this relationship that match this ASBO roleName and have this instance id.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
List partcipants = relService.retrieveParticipants("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", 1);

Parameters:
relationshipName - name of the relationship to retrieve the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to retrieve the participants from. If no role found, RelationshipUserException will be thrown.
instanceId - instanceID of the target participants. It should be greater than zero.
Returns:
a list of the matched participants. If no matched participant found, an empty list will be returned.
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantString

public int createParticipantString(java.lang.String relationshipName,
                                   java.lang.String roleName,
                                   java.lang.String dataString)
                            throws RelationshipServiceException,
                                   RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of String type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantString("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "value_String");

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataString - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantLong

public int createParticipantLong(java.lang.String relationshipName,
                                 java.lang.String roleName,
                                 long dataSimpleType)
                          throws RelationshipServiceException,
                                 RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of long type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantLong("http://www.ibm.com/StaticRel", "http://www.ibm.com/longRole", -9223372036854775808);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantInt

public int createParticipantInt(java.lang.String relationshipName,
                                java.lang.String roleName,
                                int dataSimpleType)
                         throws RelationshipServiceException,
                                RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of int type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantInt("http://www.ibm.com/StaticRel", "http://www.ibm.com/intRole", -2147483648);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantFloat

public int createParticipantFloat(java.lang.String relationshipName,
                                  java.lang.String roleName,
                                  float dataSimpleType)
                           throws RelationshipServiceException,
                                  RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of float type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantFloat("http://www.ibm.com/StaticRel", "http://www.ibm.com/floatRole", -3.40282346638528860e+38F);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantDouble

public int createParticipantDouble(java.lang.String relationshipName,
                                   java.lang.String roleName,
                                   double dataSimpleType)
                            throws RelationshipServiceException,
                                   RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of double type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantDouble("http://www.ibm.com/StaticRel", "http://www.ibm.com/doubleRole", 4.94065645841246544e-324D);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantBoolean

public int createParticipantBoolean(java.lang.String relationshipName,
                                    java.lang.String roleName,
                                    boolean dataSimpleType)
                             throws RelationshipServiceException,
                                    RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of boolean type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantStringWithID

public int createParticipantStringWithID(java.lang.String relationshipName,
                                         java.lang.String roleName,
                                         int instanceID,
                                         java.lang.String dataString)
                                  throws RelationshipServiceException,
                                         RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of String type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
int id = relService.createParticipantStringWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", origId, "value_String");

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataString - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantLongWithID

public int createParticipantLongWithID(java.lang.String relationshipName,
                                       java.lang.String roleName,
                                       int instanceID,
                                       long dataSimpleType)
                                throws RelationshipServiceException,
                                       RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of long type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
int id = relService.createParticipantLongWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/longRole", origId, -9223372036854775808);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantIntWithID

public int createParticipantIntWithID(java.lang.String relationshipName,
                                      java.lang.String roleName,
                                      int instanceID,
                                      int dataSimpleType)
                               throws RelationshipServiceException,
                                      RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of int type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
int id = relService.createParticipantIntWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/intRole", origId, -2147483648);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantFloatWithID

public int createParticipantFloatWithID(java.lang.String relationshipName,
                                        java.lang.String roleName,
                                        int instanceID,
                                        float dataSimpleType)
                                 throws RelationshipServiceException,
                                        RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of float type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
int id = relService.createParticipantFloatWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/floatRole", origId, -3.40282346638528860e+38F);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantDoubleWithID

public int createParticipantDoubleWithID(java.lang.String relationshipName,
                                         java.lang.String roleName,
                                         int instanceID,
                                         double dataSimpleType)
                                  throws RelationshipServiceException,
                                         RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of double type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
int id = relService.createParticipantDoubleWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/doubleRole", origId, 4.94065645841246544e-324D);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

createParticipantBooleanWithID

public int createParticipantBooleanWithID(java.lang.String relationshipName,
                                          java.lang.String roleName,
                                          int instanceID,
                                          boolean dataSimpleType)
                                   throws RelationshipServiceException,
                                          RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of boolean type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantString("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "value_String");
int id = relService.createParticipantBooleanWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", origId, false);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantString

public int addParticipantString(java.lang.String relationshipName,
                                java.lang.String roleName,
                                java.lang.String dataString)
                         throws RelationshipServiceException,
                                RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of String type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipantString("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "value_String");

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataString - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantLong

public int addParticipantLong(java.lang.String relationshipName,
                              java.lang.String roleName,
                              long dataSimpleType)
                       throws RelationshipServiceException,
                              RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of long type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipantLong("http://www.ibm.com/StaticRel", "http://www.ibm.com/longRole", -9223372036854775808);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantInt

public int addParticipantInt(java.lang.String relationshipName,
                             java.lang.String roleName,
                             int dataSimpleType)
                      throws RelationshipServiceException,
                             RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of int type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipantInt("http://www.ibm.com/StaticRel", "http://www.ibm.com/intRole", -2147483648);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantFloat

public int addParticipantFloat(java.lang.String relationshipName,
                               java.lang.String roleName,
                               float dataSimpleType)
                        throws RelationshipServiceException,
                               RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of float type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipantFloat("http://www.ibm.com/StaticRel", "http://www.ibm.com/floatRole", -3.40282346638528860e+38F);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantDouble

public int addParticipantDouble(java.lang.String relationshipName,
                                java.lang.String roleName,
                                double dataSimpleType)
                         throws RelationshipServiceException,
                                RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of double type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipantDouble("http://www.ibm.com/StaticRel", "http://www.ibm.com/doubleRole", 4.94065645841246544e-324D);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantBoolean

public int addParticipantBoolean(java.lang.String relationshipName,
                                 java.lang.String roleName,
                                 boolean dataSimpleType)
                          throws RelationshipServiceException,
                                 RelationshipUserException
Adds a participant to a new relationship instance. This role contains a roleObject of boolean type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantStringWithID

public int addParticipantStringWithID(java.lang.String relationshipName,
                                      java.lang.String roleName,
                                      int instanceID,
                                      java.lang.String dataString)
                               throws RelationshipServiceException,
                                      RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of String type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
int id = relService.addParticipantStringWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", origId, "value_String");

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataString - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantLongWithID

public int addParticipantLongWithID(java.lang.String relationshipName,
                                    java.lang.String roleName,
                                    int instanceID,
                                    long dataSimpleType)
                             throws RelationshipServiceException,
                                    RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of long type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
int id = relService.addParticipantLongWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/longRole", origId, -9223372036854775808);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantIntWithID

public int addParticipantIntWithID(java.lang.String relationshipName,
                                   java.lang.String roleName,
                                   int instanceID,
                                   int dataSimpleType)
                            throws RelationshipServiceException,
                                   RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of int type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
int id = relService.addParticipantIntWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/intRole", origId, -2147483648);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantFloatWithID

public int addParticipantFloatWithID(java.lang.String relationshipName,
                                     java.lang.String roleName,
                                     int instanceID,
                                     float dataSimpleType)
                              throws RelationshipServiceException,
                                     RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of float type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
int id = relService.addParticipantFloatWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/floatRole", origId, -3.40282346638528860e+38F);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantDoubleWithID

public int addParticipantDoubleWithID(java.lang.String relationshipName,
                                      java.lang.String roleName,
                                      int instanceID,
                                      double dataSimpleType)
                               throws RelationshipServiceException,
                                      RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of double type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
int id = relService.addParticipantDoubleWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/doubleRole", origId, 4.94065645841246544e-324D);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

addParticipantBooleanWithID

public int addParticipantBooleanWithID(java.lang.String relationshipName,
                                       java.lang.String roleName,
                                       int instanceID,
                                       boolean dataSimpleType)
                                throws RelationshipServiceException,
                                       RelationshipUserException
Adds a participant for an existing relationship instance. This role contains a roleObject of boolean type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int origId = relService.createParticipantString("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "value_String");
int id = relService.addParticipantBooleanWithID("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", origId, false);

Parameters:
relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to add the participant to. If no role found, RelationshipUserException will be thrown.
instanceID - instanceID of the existing relationship instance. InstanceID equal with or less than zero is not valid.
dataSimpleType - data of the participant to be added
Returns:
relationship instanceID of the newly added participant
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantString

public void deactivateParticipantString(java.lang.String relationshipName,
                                        java.lang.String roleName,
                                        java.lang.String dataString)
                                 throws RelationshipServiceException,
                                        RelationshipUserException
Deactivates all the participants of this relationship that match this data for the participant. This role contains a roleObject of String type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deactivateParticipantString("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "value_String");

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
dataString - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantLong

public void deactivateParticipantLong(java.lang.String relationshipName,
                                      java.lang.String roleName,
                                      long dataSimpleType)
                               throws RelationshipServiceException,
                                      RelationshipUserException
Deactivates all the participants of this relationship that match this data for the participant. This role contains a roleObject of long type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deactivateParticipantLong("http://www.ibm.com/StaticRel", "http://www.ibm.com/longRole", -9223372036854775808);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantInt

public void deactivateParticipantInt(java.lang.String relationshipName,
                                     java.lang.String roleName,
                                     int dataSimpleType)
                              throws RelationshipServiceException,
                                     RelationshipUserException
Deactivates all the participants of this relationship that match this data for the participant. This role contains a roleObject of int type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deactivateParticipantInt("http://www.ibm.com/StaticRel", "http://www.ibm.com/intRole", -2147483648);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantFloat

public void deactivateParticipantFloat(java.lang.String relationshipName,
                                       java.lang.String roleName,
                                       float dataSimpleType)
                                throws RelationshipServiceException,
                                       RelationshipUserException
Deactivates all the participants of this relationship that match this data for the participant. This role contains a roleObject of float type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deactivateParticipantFloat("http://www.ibm.com/StaticRel", "http://www.ibm.com/floatRole", 1.40129846432481707e-45F);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantDouble

public void deactivateParticipantDouble(java.lang.String relationshipName,
                                        java.lang.String roleName,
                                        double dataSimpleType)
                                 throws RelationshipServiceException,
                                        RelationshipUserException
Deactivates all the participants of this relationship that match this data for the participant. This role contains a roleObject of double type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deactivateParticipantDouble("http://www.ibm.com/StaticRel", "http://www.ibm.com/doubleRole", 4.94065645841246544e-324D);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantBoolean

public void deactivateParticipantBoolean(java.lang.String relationshipName,
                                         java.lang.String roleName,
                                         boolean dataSimpleType)
                                  throws RelationshipServiceException,
                                         RelationshipUserException
Deactivates all the participants of this relationship that match this data for the participant. This role contains a roleObject of boolean type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deactivateParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantStringByID

public void deactivateParticipantStringByID(java.lang.String relationshipName,
                                            java.lang.String roleName,
                                            int instanceID,
                                            java.lang.String dataString)
                                     throws RelationshipServiceException,
                                            RelationshipUserException
Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID. This role contains a roleObject of String type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantString("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "value_String");
relService.deactivateParticipantStingByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", id, "value_String");

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
dataString - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantLongByID

public void deactivateParticipantLongByID(java.lang.String relationshipName,
                                          java.lang.String roleName,
                                          int instanceID,
                                          long dataSimpleType)
                                   throws RelationshipServiceException,
                                          RelationshipUserException
Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID. This role contains a roleObject of long type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantLong("http://www.ibm.com/StaticRel", "http://www.ibm.com/longRole", -9223372036854775808);
relService.deactivateParticipantLongByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/longRole", id, -9223372036854775808);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantIntByID

public void deactivateParticipantIntByID(java.lang.String relationshipName,
                                         java.lang.String roleName,
                                         int instanceID,
                                         int dataSimpleType)
                                  throws RelationshipServiceException,
                                         RelationshipUserException
Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID. This role contains a roleObject of int type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipantInt("http://www.ibm.com/StaticRel", "http://www.ibm.com/intRole", -2147483648);
relService.deactivateParticipantIntByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/intRole", id, -2147483648);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
instanceID - specified relationship instanceID
dataSimpleType - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantFloatByID

public void deactivateParticipantFloatByID(java.lang.String relationshipName,
                                           java.lang.String roleName,
                                           int instanceID,
                                           float dataSimpleType)
                                    throws RelationshipServiceException,
                                           RelationshipUserException
Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID. This role contains a roleObject of float type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipantFloat("http://www.ibm.com/StaticRel", "http://www.ibm.com/floatRole", -3.40282346638528860e+38F);
relService.deactivateParticipantFloatByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/floatRole", id, -3.40282346638528860e+38F);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
instanceID - specified relationship instanceID
dataSimpleType - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantDoubleByID

public void deactivateParticipantDoubleByID(java.lang.String relationshipName,
                                            java.lang.String roleName,
                                            int instanceID,
                                            double dataSimpleType)
                                     throws RelationshipServiceException,
                                            RelationshipUserException
Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID. This role contains a roleObject of double type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantDouble("http://www.ibm.com/StaticRel", "http://www.ibm.com/doubleRole", 4.94065645841246544e-324D);
relService.deactivateParticipantDoubleByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/doubleRole", id, 4.94065645841246544e-324D);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
instanceID - specified relationship instanceID
dataSimpleType - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deactivateParticipantBooleanByID

public void deactivateParticipantBooleanByID(java.lang.String relationshipName,
                                             java.lang.String roleName,
                                             int instanceID,
                                             boolean dataSimpleType)
                                      throws RelationshipServiceException,
                                             RelationshipUserException
Deactivates all the participant instances of the relationship that match this data for the participant and have the specified relationship instanceID. This role contains a roleObject of boolean type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
relService.deactivateParticipantBooleanByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", id, true);

Parameters:
relationshipName - name of the relationship to deactivate the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to deactivate the participants from. If no role found, RelationshipUserException will be thrown.
instanceID - specified relationship instanceID. InstanceID equal with or less than zero is not valid.
dataSimpleType - data of the participants to be deactivated. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsUseDeactivate

public int[] retrieveInstanceIDsUseDeactivate(java.lang.String relationshipName,
                                              java.lang.String roleName,
                                              java.lang.String dataString)
                                       throws RelationshipServiceException,
                                              RelationshipUserException
Retrieves ids of relationship instances that match this relationship name, role name and data. Deactivated instances are also considered. This role contains a roleObject of String type and a keyAttribute whose path is defined as "Data". This API supports static rleationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantString("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "value_String");
relService.deactivateParticipantStringByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", id, "value_String");
int[] idArray = relService.retrieveInstanceIDsUseDeactivate("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "value_String");

Parameters:
relationshipName - name of the relationship to retrieve instanceIDs from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role for retrieve. If no role found, RelationshipUserException will be thrown.
dataString - data of the participants to be retrieved
Returns:
int array of ids of the matched instance ids. If no matched instance found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantString

public void deleteParticipantString(java.lang.String relationshipName,
                                    java.lang.String roleName,
                                    java.lang.String dataString)
                             throws RelationshipServiceException,
                                    RelationshipUserException
Deletes all the participants of this relationship that match this role and the specified data. This role contains a roleObject of String type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deleteParticipantString("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "value_String");

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the participants from. If no role found, RelationshipUserException will be thrown.
dataString - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantLong

public void deleteParticipantLong(java.lang.String relationshipName,
                                  java.lang.String roleName,
                                  long dataSimpleType)
                           throws RelationshipServiceException,
                                  RelationshipUserException
Deletes all the participants of this relationship that match this role and the specified data. This role contains a roleObject of long type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deleteParticipantLong("http://www.ibm.com/StaticRel", "http://www.ibm.com/longRole", -9223372036854775808);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the participants from. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantInt

public void deleteParticipantInt(java.lang.String relationshipName,
                                 java.lang.String roleName,
                                 int dataSimpleType)
                          throws RelationshipServiceException,
                                 RelationshipUserException
Deletes all the participants of this relationship that match this role and the specified data. This role contains a roleObject of int type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deleteParticipantInt("http://www.ibm.com/StaticRel", "http://www.ibm.com/intRole", -2147483648);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the participants from. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantFloat

public void deleteParticipantFloat(java.lang.String relationshipName,
                                   java.lang.String roleName,
                                   float dataSimpleType)
                            throws RelationshipServiceException,
                                   RelationshipUserException
Deletes all the participants of this relationship that match this role and the specified data. This role contains a roleObject of float type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deleteParticipantFloat("http://www.ibm.com/StaticRel", "http://www.ibm.com/floatRole", 1.40129846432481707e-45F);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the participants from. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantDouble

public void deleteParticipantDouble(java.lang.String relationshipName,
                                    java.lang.String roleName,
                                    double dataSimpleType)
                             throws RelationshipServiceException,
                                    RelationshipUserException
Deletes all the participants of this relationship that match this role and the specified data. This role contains a roleObject of double type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deleteParticipantDouble("http://www.ibm.com/StaticRel", "http://www.ibm.com/doubleRole", 4.94065645841246544e-324D);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the participants from. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantBoolean

public void deleteParticipantBoolean(java.lang.String relationshipName,
                                     java.lang.String roleName,
                                     boolean dataSimpleType)
                              throws RelationshipServiceException,
                                     RelationshipUserException
Deletes all the participants of this relationship that match this role and the specified data. This role contains a roleObject of boolean type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
relService.deleteParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the participants from. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantStringByID

public void deleteParticipantStringByID(java.lang.String relationshipName,
                                        java.lang.String roleName,
                                        int instanceID,
                                        java.lang.String dataString)
                                 throws RelationshipServiceException,
                                        RelationshipUserException
Deletes all the participants that match this relationship name, role name, relationship instanceID and the data. This role contains a roleObject of String type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantString("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "value_String");
relService.deleteParticipantStringByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", id, "value_String");

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the partcipants from. If no role found, RelationshipUserException will be thrown.
instanceID - given relationship instanceID
dataString - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantLongByID

public void deleteParticipantLongByID(java.lang.String relationshipName,
                                      java.lang.String roleName,
                                      int instanceID,
                                      long dataSimpleType)
                               throws RelationshipServiceException,
                                      RelationshipUserException
Deletes all the participants that match the relationship name, role name, relationship instanceID and the data. This role contains a roleObject of long type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantLong("http://www.ibm.com/StaticRel", "http://www.ibm.com/longRole", -9223372036854775808);
relService.deleteParticipantLongByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/longRole", id, -9223372036854775808);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the partcipants from. If no role found, RelationshipUserException will be thrown.
instanceID - given relationship instanceID
dataSimpleType - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantIntByID

public void deleteParticipantIntByID(java.lang.String relationshipName,
                                     java.lang.String roleName,
                                     int instanceID,
                                     int dataSimpleType)
                              throws RelationshipServiceException,
                                     RelationshipUserException
Deletes all the participants that match the relationship name, role name, relationship instanceID and the data. This role contains a roleObject of int type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipantInt("http://www.ibm.com/StaticRel", "http://www.ibm.com/intRole", -2147483648);
relService.deleteParticipantIntByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/intRole", id, -2147483648);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the partcipants from. If no role found, RelationshipUserException will be thrown.
instanceID - given relationship instanceID
dataSimpleType - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantFloatByID

public void deleteParticipantFloatByID(java.lang.String relationshipName,
                                       java.lang.String roleName,
                                       int instanceID,
                                       float dataSimpleType)
                                throws RelationshipServiceException,
                                       RelationshipUserException
Deletes all the participants that match the relationship name, role name, relationship instanceID and the data. This role contains a roleObject of float type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.addParticipantFloat("http://www.ibm.com/StaticRel", "http://www.ibm.com/floatRole", -3.40282346638528860e+38F);
relService.deleteParticipantFloatByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/floatRole", id, -3.40282346638528860e+38F);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the partcipants from. If no role found, RelationshipUserException will be thrown.
instanceID - given relationship instanceID
dataSimpleType - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantDoubleByID

public void deleteParticipantDoubleByID(java.lang.String relationshipName,
                                        java.lang.String roleName,
                                        int instanceID,
                                        double dataSimpleType)
                                 throws RelationshipServiceException,
                                        RelationshipUserException
Deletes all the participants that match the relationship name, role name, relationship instanceID and the data. This role contains a roleObject of double type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantDouble("http://www.ibm.com/StaticRel", "http://www.ibm.com/doubleRole", 4.94065645841246544e-324D);
relService.deleteParticipantDoubleByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/doubleRole", id, 4.94065645841246544e-324D);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the partcipants from. If no role found, RelationshipUserException will be thrown.
instanceID - given relationship instanceID
dataSimpleType - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

deleteParticipantBooleanByID

public void deleteParticipantBooleanByID(java.lang.String relationshipName,
                                         java.lang.String roleName,
                                         int instanceID,
                                         boolean dataSimpleType)
                                  throws RelationshipServiceException,
                                         RelationshipUserException
Deletes all the participants that match this relationship name, role name, relationship instanceID and the data. This role contains a roleObject of boolean type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int id = relService.createParticipantBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);
relService.deleteParticipantBooleanByID("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", id, true);

Parameters:
relationshipName - name of the relationship to delete the participants from. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the role to delete the partcipants from. If no role found, RelationshipUserException will be thrown.
instanceID - given relationship instanceID
dataSimpleType - data of the participants to be deleted. If no matched participant found, no exception will be thrown.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByString

public int[] retrieveInstanceIDsByString(java.lang.String relationshipName,
                                         java.lang.String roleName,
                                         java.lang.String dataString)
                                  throws RelationshipServiceException,
                                         RelationshipUserException
Retrieves ids of all the participants that match this relationship, role and data. This role contains a roleObject of String type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByString("http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "value_String");

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the specified role. If no role found, RelationshipUserException will be thrown.
dataString - data of the target participants
Returns:
int array of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByLong

public int[] retrieveInstanceIDsByLong(java.lang.String relationshipName,
                                       java.lang.String roleName,
                                       long dataSimpleType)
                                throws RelationshipServiceException,
                                       RelationshipUserException
Retrieves ids of all the participants that match this relationship, role and data. This role contains a roleObject of long type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByLong("http://www.ibm.com/StaticRel", "http://www.ibm.com/longRole", -9223372036854775808);

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the specified role. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the target participants
Returns:
int array of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByInt

public int[] retrieveInstanceIDsByInt(java.lang.String relationshipName,
                                      java.lang.String roleName,
                                      int dataSimpleType)
                               throws RelationshipServiceException,
                                      RelationshipUserException
Retrieves ids of all the participants that match this relationship, role and data. This role contains a roleObject of int type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByInt("http://www.ibm.com/StaticRel", "http://www.ibm.com/intRole", -2147483648);

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the specified role. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the target participants
Returns:
int array of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByFloat

public int[] retrieveInstanceIDsByFloat(java.lang.String relationshipName,
                                        java.lang.String roleName,
                                        float dataSimpleType)
                                 throws RelationshipServiceException,
                                        RelationshipUserException
Retrieves ids of all the participants that match this relationship, role and data. This role contains a roleObject of float type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByFloat("http://www.ibm.com/StaticRel", "http://www.ibm.com/floatRole", 1.40129846432481707e-45F);

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the specified role. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the target participants
Returns:
int array of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByDouble

public int[] retrieveInstanceIDsByDouble(java.lang.String relationshipName,
                                         java.lang.String roleName,
                                         double dataSimpleType)
                                  throws RelationshipServiceException,
                                         RelationshipUserException
Retrieves ids of all the participants that match this relationship, role and data. This role contains a roleObject of double type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByDouble("http://www.ibm.com/StaticRel", "http://www.ibm.com/doubleRole", 4.94065645841246544e-324D);

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the specified role. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the target participants
Returns:
int array of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByBoolean

public int[] retrieveInstanceIDsByBoolean(java.lang.String relationshipName,
                                          java.lang.String roleName,
                                          boolean dataSimpleType)
                                   throws RelationshipServiceException,
                                          RelationshipUserException
Retrieves ids of all the participants that match this relationship, role and data. This role contains a roleObject of boolean type and a keyAttribute whose path is defined as "Data". Value for this role is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByBoolean("http://www.ibm.com/StaticRel", "http://www.ibm.com/booleanRole", true);

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - name of the specified role. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the target participants
Returns:
int array of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRoleNameString

public int[] retrieveInstanceIDsByRoleNameString(java.lang.String relationshipName,
                                                 java.lang.String[] roleName,
                                                 java.lang.String dataString)
                                          throws RelationshipServiceException,
                                                 RelationshipUserException
Retrieves ids of the participants that match this relationship name, the list of role names and the specified data. Each role contains a roleObject of String type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
String[] roleNames = {"http://www.ibm.com/StringRole_First", "http://www.ibm.com/StringRole_Second"};
int[] ids = relService.retrieveInstanceIDsByRoleNameString("http://www.ibm.com/StaticRel", roleNames, "value_String");

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - list of the specified role names. If no role found, RelationshipUserException will be thrown.
dataString - data of the target participants
Returns:
int array of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRoleNameLong

public int[] retrieveInstanceIDsByRoleNameLong(java.lang.String relationshipName,
                                               java.lang.String[] roleName,
                                               long dataSimpleType)
                                        throws RelationshipServiceException,
                                               RelationshipUserException
Retrieves ids of the participants that match the relationship name, the list of role names and the specified data. Each role contains a roleObject of long type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
String[] roleNames = {"http://www.ibm.com/longRole_First", "http://www.ibm.com/longRole_Second"};
int[] ids = relService.retrieveInstanceIDsByRoleNameLong("http://www.ibm.com/StaticRel", roleNames, -9223372036854775808);

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - list of the specified role names. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the target participants
Returns:
list of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRoleNameInt

public int[] retrieveInstanceIDsByRoleNameInt(java.lang.String relationshipName,
                                              java.lang.String[] roleName,
                                              int dataSimpleType)
                                       throws RelationshipServiceException,
                                              RelationshipUserException
Retrieves ids of the participants that match the relationship name, the list of role names and the specified data. Each role contains a roleObject of int type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
String[] roleNames = {"http://www.ibm.com/intRole_First", "http://www.ibm.com/intRole_Second"};
int[] ids = relService.retrieveInstanceIDsByRoleNameInt("http://www.ibm.com/StaticRel", roleNames, -2147483648);

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - list of the specified role names. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the target participants
Returns:
list of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRoleNameFloat

public int[] retrieveInstanceIDsByRoleNameFloat(java.lang.String relationshipName,
                                                java.lang.String[] roleName,
                                                float dataSimpleType)
                                         throws RelationshipServiceException,
                                                RelationshipUserException
Retrieves ids of the participants that match the relationship name, the list of role names and the specified data. Each role contains a roleObject of float type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
String[] roleNames = {"http://www.ibm.com/floatRole_First", "http://www.ibm.com/floatRole_Second"};
int[] ids = relService.retrieveInstanceIDsByRoleNameFloat("http://www.ibm.com/StaticRel", roleNames, 1.40129846432481707e-45F);

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - list of the specified role names. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the target participants
Returns:
list of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRoleNameDouble

public int[] retrieveInstanceIDsByRoleNameDouble(java.lang.String relationshipName,
                                                 java.lang.String[] roleName,
                                                 double dataSimpleType)
                                          throws RelationshipServiceException,
                                                 RelationshipUserException
Retrieves ids of the participants that match the relationship name, the list of role names and the specified data. Each role contains a roleObject of double type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
String[] roleNames = {"http://www.ibm.com/doubleRole_First", "http://www.ibm.com/doubleRole_Second"};
int[] ids = relService.retrieveInstanceIDsByRoleNameDouble("http://www.ibm.com/StaticRel", roleNames, 4.94065645841246544e-324D);

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - list of the specified role names. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the target participants
Returns:
list of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRoleNameBoolean

public int[] retrieveInstanceIDsByRoleNameBoolean(java.lang.String relationshipName,
                                                  java.lang.String[] roleName,
                                                  boolean dataSimpleType)
                                           throws RelationshipServiceException,
                                                  RelationshipUserException
Retrieves ids of the participants that match the relationship name, the list of role names and the specified data. Each role contains a roleObject of boolean type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
String[] roleNames = {"http://www.ibm.com/booleanRole_First", "http://www.ibm.com/booleanRole_Second"};
int[] ids = relService.retrieveInstanceIDsByRoleNameBoolean("http://www.ibm.com/StaticRel", roleNames, true);

Parameters:
relationshipName - name of the specified relationship. If no relationship found, RelationshipUserException will be thrown.
roleName - list of the specified role names. If no role found, RelationshipUserException will be thrown.
dataSimpleType - data of the target participants
Returns:
list of ids of all the matched participants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRelNameString

public int[] retrieveInstanceIDsByRelNameString(java.lang.String relationshipName,
                                                java.lang.String dataString)
                                         throws RelationshipServiceException,
                                                RelationshipUserException
Retrieves ids of the participants that match this relationship name and data. It looks up all the roles that contains a roleObject of String type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByRelNameString("http://www.ibm.com/StaticRel", "value_String");

Parameters:
relationshipName - name of the spcified relationship. If no relationship found, RelationshipUserException will be thrown.
dataString - data of the target partcipants
Returns:
list of ids of all the matched partcipants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRelNameLong

public int[] retrieveInstanceIDsByRelNameLong(java.lang.String relationshipName,
                                              long dataSimpleType)
                                       throws RelationshipServiceException,
                                              RelationshipUserException
Retrieves ids of the participants that match this relationship name and data. It looks up all the roles that contains a roleObject of long type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByRelNameLong("http://www.ibm.com/StaticRel", -9223372036854775808);

Parameters:
relationshipName - name of the spcified relationship. If no relationship found, RelationshipUserException will be thrown.
dataSimpleType - data of the target partcipants
Returns:
list of ids of all the matched partcipants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRelNameInt

public int[] retrieveInstanceIDsByRelNameInt(java.lang.String relationshipName,
                                             int dataSimpleType)
                                      throws RelationshipServiceException,
                                             RelationshipUserException
Retrieves ids of the participants that match this relationship name and data. It looks up all the roles that contains a roleObject of int type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByRelNameInt("http://www.ibm.com/StaticRel", -2147483648);

Parameters:
relationshipName - name of the spcified relationship. If no relationship found, RelationshipUserException will be thrown.
dataSimpleType - data of the target partcipants
Returns:
list of ids of all the matched partcipants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRelNameFloat

public int[] retrieveInstanceIDsByRelNameFloat(java.lang.String relationshipName,
                                               float dataSimpleType)
                                        throws RelationshipServiceException,
                                               RelationshipUserException
Retrieves ids of the participants that match this relationship name and data. It looks up all the roles that contains a roleObject of float type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByRelNameFloat("http://www.ibm.com/StaticRel", -3.40282346638528860e+38F);

Parameters:
relationshipName - name of the spcified relationship. If no relationship found, RelationshipUserException will be thrown.
dataSimpleType - data of the target partcipants
Returns:
list of ids of all the matched partcipants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRelNameDouble

public int[] retrieveInstanceIDsByRelNameDouble(java.lang.String relationshipName,
                                                double dataSimpleType)
                                         throws RelationshipServiceException,
                                                RelationshipUserException
Retrieves ids of the participants that match this relationship name and data. It looks up all the roles that contains a roleObject of double type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByRelNameDouble("http://www.ibm.com/StaticRel", 4.94065645841246544e-324D);

Parameters:
relationshipName - name of the spcified relationship. If no relationship found, RelationshipUserException will be thrown.
dataSimpleType - data of the target partcipants
Returns:
list of ids of all the matched partcipants. If no matched participant found, an empty int array is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveInstanceIDsByRelNameBoolean

public int[] retrieveInstanceIDsByRelNameBoolean(java.lang.String relationshipName,
                                                 boolean dataSimpleType)
                                          throws RelationshipServiceException,
                                                 RelationshipUserException
Retrieves ids of the participants that match this relationship name and data. It looks up all the roles that contains a roleObject of boolean type and a keyAttribute whose path is defined as "Data". Value for these roles is specified by the data. This API supports static relationship only.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
int[] ids = relService.retrieveInstanceIDsByRelNameBoolean("http://www.ibm.com/StaticRel", true);

Parameters:
relationshipName - name of the spcified relationship. If no relationship found, RelationshipUserException will be thrown.
dataSimpleType - data of the target partcipants
Returns:
list of ids of all the matched partcipants. If no matched participant found, an empty list is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveParticipantsByRoleName

public java.util.List retrieveParticipantsByRoleName(java.lang.String relationshipName,
                                                     java.lang.String[] roleNames,
                                                     int instanceID)
                                              throws RelationshipServiceException,
                                                     RelationshipUserException
Retrieves all the participants from this relationship and the list of ASBO roles. The matched participants own the specified instanceID. It can be used for static as well as dynamic relationship.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
String roleNames = {"http://www.ibm.com/StringRole", "http://www.ibm.com/longRole"};
List participants = relService.retrieveParticipantsByRoleName("http://www.ibm.com/StaticRel", roleNames, 1);

Parameters:
relationshipName - name of the relationship to retrieve the participants from. If no relationship found, RelationshipUserException is thrown.
roleNames - list of role names. If any role in the list could not be found, RelationshipUserException is thrown.
instanceID - specified relationship instanceID
Returns:
list of all the matced partcipants. If no matched participant found, an empty list is returned.
Throws:
RelationshipServiceException
RelationshipUserException

retrieveParticipantsByRelationshipName

public java.util.List retrieveParticipantsByRelationshipName(java.lang.String relationshipName,
                                                             int instanceID)
                                                      throws RelationshipServiceException,
                                                             RelationshipUserException
Retrieves all the matched participants from all the ASBO roles of this relationship. The matched participants own the given relationship instanceID. It can be used for static as well as dynamic relationship.

RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
List participants = relService.retrieveParticipantsByRelationshipName("http://www.ibm.com/StaticRel", 1);

Parameters:
relationshipName - name of the relationship to retrieve participants from. If no relationship found, RelationshipUserException is thrown.
instanceID - given relationship instanceID
Returns:
list of all the matched participants. If no matched participant found, an empty list is returned.
Throws:
RelationshipServiceException
RelationshipUserException

maintainIdentityRelationship

public void maintainIdentityRelationship(java.lang.String relationshipName,
                                         java.lang.String appRoleName,
                                         commonj.sdo.DataObject inputBO,
                                         commonj.sdo.DataObject outputBO,
                                         commonj.sdo.DataObject originalInputBO,
                                         commonj.sdo.DataObject originalOutputBO,
                                         java.lang.String callingContext)
                                  throws RelationshipServiceException,
                                         RelationshipUserException,
                                         MissingIdException
Maintains an identity relationship, this could be used for both simple and composite relationship. Before using this API, please ensure follwoing items are true:
Five usage scenarioes are listed below.

Parameters:
relationshipName - name of the identity relationship to maintain
appRoleName - name of the ASBO role
inputBO - input BO, it could also be a BG.
outputBO - output BO, it could also be a BG.
originalInputBO - original input BO, it could also be a BG.
originalOutputBO - original output BO, it could also be a BG.
callingContext - calling context including SERVICE_CALL_REQUEST, SERVICE_CALL_RESPONSE, EVENT_DELIVERY and SERVICE_CALL_FAILURE
Throws:
RelationshipServiceException
RelationshipUserException
MissingIdException
Since:
WPS6.0

In WPS6.0, the need for parent-children relationships in composite relationship maintenance, will be done away with with the new maintainIdentityRelationship API. That is:

  • In WPS6.0, users will no longer be required to create parent-children relationships in order to help maintain composite relationships if they choose to adopt the new maintainIdentity api.
  • maintainIdentityRelationship now replaces both maintainSimpleIdentityRelationship and maintainCompositeIdentityRelationship.
  • maintainSimpleIdentityRelationship and maintainCompositeIdentityRelationship will still be supported but will be marked as deprecated.
  • Likewise, the WBI ICS *child* relationship api (updateMyChildren, etc.) will still be supported but will be marked as deprecated.
  • The map 'relationshipCall' transform type will only invoke maintainIdentity (vs. maintainSimple or maintainComposite) for direct relationship maintenance purposes (i.e., for non foreign-key application - for these applications, the foreignKey* methods will be used in place of maintain*).
  • [MIGRATION] The coexistence scenario for composite relationship support requires that the old (deprecated) maintainComposite*, *children* api be used, instead of the new maintainIdentity api, when composite relationships are shared by both a WBI ICS instance and a Diamond Server instance.

    isSetRelationshipProperty

    public boolean isSetRelationshipProperty(java.lang.String relationshipName,
                                             java.lang.String propertyName,
                                             int instanceid)
                                      throws RelationshipServiceException,
                                             RelationshipUserException
    Determines if the user defined property for the given relationship instance is set. This property name is one of properties defined in the relationship. In a relationship instance, it is optional to set value for relationship properties. It can be used for static as well as dynamic relationship.

    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    boolean isSet = relService.isSetRelationshipProperty("http://www.ibm.com/CustomerRel", "DatetimeProperty", 1);

    Parameters:
    relationshipName - name of the relationship to check. If no relationship found, RelationshipUserException is thrown.
    propertyName - property name to be set. If no property name found in this relationship, RelationshipServiceException is thrown.
    instanceid - ID of the target relationship instance. instanceid equal with or less than zero is not valid.
    Returns:
    true, if the target property is set; false, if the target property is not set
    Throws:
    RelationshipServiceException
    RelationshipUserException

    setRelationshipProperty

    public void setRelationshipProperty(java.lang.String relationshipName,
                                        java.lang.String propertyName,
                                        java.lang.Object value,
                                        int instanceid)
                                 throws RelationshipServiceException,
                                        RelationshipUserException
    Sets value for the user defined property into this relationship instance. It can be used for static as well as dynamic relationship.

    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    relService.setRelationshipProperty("http://www.ibm.com/CustomerRel", "StringProperty", "value_String", 1);

    Parameters:
    relationshipName - name of the relationship to set relationship instance property. If no relationship found, RelationshipUserException is thrown.
    propertyName - property name to be set. If no property name found in this relationship, RelationshipServiceException is thrown.
    value - value to set for the property
    instanceid - ID of the relationship instance
    Throws:
    RelationshipServiceException
    RelationshipUserException

    getRelationshipProperty

    public java.lang.Object getRelationshipProperty(java.lang.String relationshipName,
                                                    java.lang.String propertyName,
                                                    int instanceid)
                                             throws RelationshipServiceException,
                                                    RelationshipUserException
    Gets the value of the user defined property in this relationship instance. In case of no property value set in this relationship instance, if there is a default value defined in the relationship definition, the default value is returned; otherwise, null is returned. It can be used for static as well as dynamic relationship.

    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    String value = (String) relService.getRelationshipProperty("http://www.ibm.com/CustomerRel", "StringProperty", 1);

    Parameters:
    relationshipName - name of the relationship to get property from. If no relationship found, RelationshipUserException is thrown.
    propertyName - name of the target property. If no property name found in this relationship, RelationshipServiceException is thrown.
    instanceid - given relationship instanceID
    Returns:
    relationship property value
    Throws:
    RelationshipServiceException
    RelationshipUserException

    unsetRelationshipProperty

    public void unsetRelationshipProperty(java.lang.String relationshipName,
                                          java.lang.String propertyName,
                                          int instanceid)
                                   throws RelationshipServiceException,
                                          RelationshipUserException
    Unsets this property for the given relationship instance. It can be used for static as well as dynamic relationship.

    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    relService.unsetRelationshipProperty("http://www.ibm.com/CustomerRel", "DatetimeProperty", 1);

    Parameters:
    relationshipName - name of the relationship to unset property value. If no relationship found, RelationshipUserException is thrown.
    propertyName - name of the target property. If no property name found in this relationship, RelationshipServiceException is thrown.
    instanceid - given relationship instanceID
    Throws:
    RelationshipServiceException
    RelationshipUserException

    isSetRoleProperty

    public boolean isSetRoleProperty(java.lang.String relationshipName,
                                     java.lang.String roleName,
                                     java.lang.String propertyName,
                                     int instanceid,
                                     java.lang.Object dataobject)
                              throws RelationshipServiceException,
                                     RelationshipUserException
    Determines if this user defined property for the given role instance is set. This property name is one of properties defined in the role. In a role instance, it is optional to set value for role properties. This API can be used for static as well as dynamic relationship.
    For dynamic relationship or static relationship with BO roleObject, param dataobject is an String:
    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    boolean result = relService.isSetRoleProperty( "http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", "IntProperty", 1, bo);

    For static relationship with simple type roleObject, param dataobject could be String, long, int, float, double or boolean:
    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    boolean result = relService.isSetRoleProperty( "http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "IntProperty", 1, "value_String");

    Parameters:
    relationshipName - name of the relationship to check. If no relationship found, RelationshipUserException is thrown.
    roleName - name of the ASBO role to check. If no role found, RelationshipUserException is thrown.
    propertyName - name of the target property. If no property name found in this role, RelationshipServiceException is thrown.
    instanceid - given relationship instanceID
    dataobject - data of the target role instance. For dynamic relationship and static relationship with BO roleObject, dataobject is a ASBO. For static relationship with simple type roleObject, data could be String, long, int, float, double or boolean.
    Returns:
    true, if the target role property is set false, if the target role property is not set
    Throws:
    RelationshipServiceException
    RelationshipUserException

    getRoleProperty

    public java.lang.Object getRoleProperty(java.lang.String relationshipName,
                                            java.lang.String roleName,
                                            java.lang.String propertyName,
                                            int instanceid,
                                            java.lang.Object dataobject)
                                     throws RelationshipServiceException,
                                            RelationshipUserException
    Gets the value of this user defined property for the given role instance. In case of no role property set in this role instance, if there is a default value defined in the role definition, the default one is returned; otherwise, null is returned. This API can be used for static as well as dynamic relationship.
    For dynamic relationship or static relationship with BO roleObject:
    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    Integer value = (Integer) relService.getRoleProperty( "http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", "IntProperty", 1, bo);

    For static relationship with simple type roleObject:
    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    Integer value = (Integer) relService.getRoleProperty( "http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "IntProperty", 1, "value_String");

    Parameters:
    relationshipName - name of the target relationship. If no relationship found, RelationshipUserException is thrown.
    roleName - name of the ASBO role to get property from. If no role found, RelationshipUserException is thrown.
    propertyName - name of the target property. If no property name found in this role, RelationshipServiceException is thrown.
    instanceid - given relationship instanceID
    dataobject - data of the target role instance. For dynamic relationship and static relationship with BO roleObject, dataobject is a ASBO. For static relationship with simple type roleObject, data could be String, long, int, float, double or boolean.
    Returns:
    property value or the default value if the property is not set
    Throws:
    RelationshipServiceException
    RelationshipUserException

    setRoleProperty

    public void setRoleProperty(java.lang.String relationshipName,
                                java.lang.String roleName,
                                java.lang.String propertyName,
                                java.lang.Object propertyValue,
                                int instanceid,
                                java.lang.Object object)
                         throws RelationshipServiceException,
                                RelationshipUserException
    Sets the specified property with the specifed value for the given role instance. It can be used for static as well as dynamic relationship.
    For dynamic relationship or static relationship with BO roleObject, param object is an String:
    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    relService.setRoleProperty( "http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", "IntProperty", new Integer(123456), 1, bo);

    For static relationship with simple type roleObject, param object could be String, long, int, float, double or boolean:
    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    relService.setRoleProperty( "http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "IntProperty", new Integer(123456), 1, "value_String");

    Parameters:
    relationshipName - name of the target relationship. If no relationship found, RelationshipUserException is thrown.
    roleName - name of the ASBO role that defines this property name. If no role found, RelationshipUserException is thrown.
    propertyName - name of the property that is defined in the ASBO role. If no property name found in this role, RelationshipServiceException is thrown.
    propertyValue - specified property value
    instanceid - given relationship instanceID
    object - data of the target role instance. For dynamic relationship and static relationship with BO roleObject, dataobject is a ASBO. For static relationship with simple type roleObject, data could be String, long, int, float, double or boolean.
    Throws:
    RelationshipServiceException
    RelationshipUserException

    unsetRoleProperty

    public void unsetRoleProperty(java.lang.String relationshipName,
                                  java.lang.String roleName,
                                  java.lang.String propertyName,
                                  int instanceid,
                                  java.lang.Object dataobject)
                           throws RelationshipServiceException,
                                  RelationshipUserException
    Removes property value for this this role instance.It can be used for static as well as dynamic relationship.
    For dynamic relationship or static relationship with BO roleObject, param object is an String:
    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    relService.unsetRoleProperty( "http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", "IntProperty", 1, bo);

    For static relationship with simple type roleObject, param object could be String, long, int, float, double or boolean:
    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    relService.unsetRoleProperty( "http://www.ibm.com/StaticRel", "http://www.ibm.com/StringRole", "IntProperty", 1, "value_String");

    Parameters:
    relationshipName - name of the target relationship. If no relationship found, RelationshipUserException is thrown.
    roleName - name of the ASBO role that defines this property name. If no role found, RelationshipUserException is thrown.
    propertyName - name of the property that is defined in the ASBO role. If no property name found in this role, RelationshipServiceException is thrown.
    instanceid - given relationship instanceID
    dataobject - data of the target role instance. For dynamic relationship and static relationship with BO roleObject, dataobject is a ASBO. For static relationship with simple type roleObject, data could be String, long, int, float, double or boolean.
    Throws:
    RelationshipServiceException
    RelationshipUserException

    createParticipant

    public int createParticipant(java.lang.String relationshipName,
                                 java.lang.String roleName,
                                 commonj.sdo.DataObject bo)
                          throws RelationshipServiceException,
                                 RelationshipUserException
    Adds a participant to a new relationship instance. The BO contains value for the ASBO role. It could also be a BusinessGraph. This API can be used for static as well as dynamic relationship.

    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    int instanceID = relService.createParticipant("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", bg);

    Parameters:
    relationshipName - name of the relationship to add the relationship instance to. If no relationship found, RelationshipUserException is thrown.
    roleName - name of the ASBO role to add the participant to. If no role found, RelationshipUserException is thrown.
    bo - data to be set for the role attribute. It could also be an BusinessGraph.
    Returns:
    relationship instance ID. If there is an existing participant with the same bo, the instanceID of the existing one is returned.
    Throws:
    RelationshipServiceException
    RelationshipUserException

    createParticipantWithID

    public int createParticipantWithID(java.lang.String relationshipName,
                                       java.lang.String roleName,
                                       int instanceId,
                                       commonj.sdo.DataObject bo)
                                throws RelationshipServiceException,
                                       RelationshipUserException
    Adds a participant for an existing relationship instance that has this instanceId. BO contains value for this ASBO role. It could also be an BusinessGraph. This API can be used for static as well as dynamic relationship.

    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    int instanceID = relService.createParticipantWithID("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", targetID, bg);

    Parameters:
    relationshipName - name of the relationship to add the participant to. If no relationship found, RelationshipUserException is thrown.
    roleName - name of the ASBO role to add the participant to. If no role found, RelationshipUserException is thrown.
    instanceId - given relationship instanceID
    bo - data to be set for the role attribute. It could also be an BusinessGraph.
    Returns:
    relationship instance ID. If there is an existing participant with the same bo, the instanceID of the existing one is returned.
    Throws:
    RelationshipServiceException
    RelationshipUserException

    setRolePropertyWithOldValue

    public void setRolePropertyWithOldValue(java.lang.String relationshipName,
                                            java.lang.String roleName,
                                            java.lang.String propertyName,
                                            java.lang.Object propertyValue,
                                            java.lang.Object oldPropertyValue,
                                            int instanceid)
                                     throws RelationshipServiceException,
                                            RelationshipUserException
    Sets this propertyValue to the given role property in the role instance. This role instance has the specified instanceID and this oldPropertyValue in the specified role property name. This API can be used for static as well as dynamic relationship.

    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    relService.setRolePropertyWithOldValue("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", "IntProperty", new Integer(123456), new Integer(11111), 1);

    Parameters:
    relationshipName - name of the target relationship. If no relationship found, RelationshipUserException is thrown.
    roleName - name of the ASBO role that defines this property name. If no role found, RelationshipUserException is thrown.
    propertyName - name of the property that is defined in the ASBO role. If no property name found in this role, RelationshipServiceException is thrown.
    propertyValue - new property value
    oldPropertyValue - old property value
    instanceid - given relationship instanceID
    Throws:
    RelationshipServiceException
    RelationshipUserException

    unsetRolePropertyWithOldValue

    public void unsetRolePropertyWithOldValue(java.lang.String relationshipName,
                                              java.lang.String roleName,
                                              java.lang.String propertyName,
                                              java.lang.Object oldPropertyValue,
                                              int instanceid)
                                       throws RelationshipServiceException,
                                              RelationshipUserException
    Unsets value of this role property in the give role instance. This role instance has the specified instanceID and this oldPropertyValue in the specified role property name.

    RelationshipService relService = (RelationshipService) new ServiceManager().locateService("com/ibm/wbiserver/rel/RelationshipService");
    relService.unsetRolePropertyWithOldValue("http://www.ibm.com/CustomerRel", "http://www.sap.com/SAPRole", "IntProperty", new Integer(11111), 1);

    Parameters:
    relationshipName - name of the target relationship. If no relationship found, RelationshipUserException is thrown.
    roleName - name of the ASBO role that defines this property name. If no role found, RelationshipUserException is thrown.
    propertyName - name of the property that is defined in the ASBO role. If no property name found in this role, RelationshipServiceException is thrown.
    oldPropertyValue - specified old property value
    instanceid - given relationship instanceID
    Throws:
    RelationshipServiceException
    RelationshipUserException