Package com.primavera.integration.client.bo.object

Class Relationship

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.Relationship
public class Relationship extends BusinessObject

A relationship defines how an activity relates to the start or finish of another activity or assignment. Add relationships between activities to create a path through your schedule from the first activity to the last activity. These relationships, which form the logic of the project network, are used together with activity durations to determine schedule dates. An activity can have as many relationships as necessary to model the work that must be done. You can also identify relationships between activities that are in different projects; this type of relationship is referred to as an external relationship.

To obtain an array of all fields exported by the XMLExporter by default, use Relationship.getDefaultXMLExportFields(). The default fields for most business objects normally include all fields that are not summary, code, or UDF fields. For Relationship business objects, however, the following fields are also not included in the default XML export fields: PredecessorActivityName and SuccessorActivityName. See the XMLExporter documentation for information on how to customize the export process if these fields are needed in the generated XML output.

See Also:   Quick reference of Relationship fields

  • Constructor Details

    • Relationship

      public Relationship(Session session)
      Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.
      Parameters:
      session - the Session

    • Relationship

      public Relationship(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • Relationship

      public Relationship(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
      Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.
      Parameters:
      session - the Session
      rowSet - the PrmRowSet retrieved from the server
      iIndex - the row index in the PrmRowSet associated with this business object
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

  • Method Details

    • loadSuccessorActivity

      public Activity loadSuccessorActivity(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Activity object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Activity the Activity object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadPredecessorActivity

      public Activity loadPredecessorActivity(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Activity object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Activity the Activity object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadSuccessorProject

      public Project loadSuccessorProject(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Project object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Project the Project object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadPredecessorProject

      public Project loadPredecessorProject(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Project object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Project the Project object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      the value in the field ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setObjectId

      public void setObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      setObjectId in class BusinessObject
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSuccessorActivityObjectId

      public ObjectId getSuccessorActivityObjectId() throws BusinessObjectException
      Gets the unique ID of the successor activity. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field SuccessorActivityObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSuccessorActivityObjectId

      public void setSuccessorActivityObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the successor activity. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSuccessorActivityType

      public ActivityType getSuccessorActivityType() throws BusinessObjectException
      Gets the type of the successor activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'.
      Returns:
      the value in the field SuccessorActivityType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredecessorActivityType

      public ActivityType getPredecessorActivityType() throws BusinessObjectException
      Gets the type of the predecessor activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'.
      Returns:
      the value in the field PredecessorActivityType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredecessorActivityObjectId

      public ObjectId getPredecessorActivityObjectId() throws BusinessObjectException
      Gets the unique ID of the predecessor activity. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field PredecessorActivityObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPredecessorActivityObjectId

      public void setPredecessorActivityObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the predecessor activity. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSuccessorProjectObjectId

      public ObjectId getSuccessorProjectObjectId() throws BusinessObjectException
      Gets the unique ID of the project that owns the successor activity. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field SuccessorProjectObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSuccessorProjectObjectId

      public void setSuccessorProjectObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the project that owns the successor activity. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredecessorProjectObjectId

      public ObjectId getPredecessorProjectObjectId() throws BusinessObjectException
      Gets the unique ID of the project that owns the predecessor activity. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field PredecessorProjectObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPredecessorProjectObjectId

      public void setPredecessorProjectObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the project that owns the predecessor activity. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredCalendarObjectId

      public ObjectId getPredCalendarObjectId() throws BusinessObjectException
      Gets the unique ID of the calendar assigned to the predecessor activity.
      Returns:
      the value in the field PredCalendarObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getType

      public RelationshipType getType() throws BusinessObjectException
      Gets the type of relationship: 'Finish to Start', 'Finish to Finish', 'Start to Start', or 'Start to Finish'.
      Returns:
      the value in the field Type
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setType

      public void setType(RelationshipType enm) throws BusinessObjectException
      Sets the type of relationship: 'Finish to Start', 'Finish to Finish', 'Start to Start', or 'Start to Finish'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getComments

      public String getComments() throws BusinessObjectException
      Gets comments on the relationship. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field Comments
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setComments

      public void setComments(String s) throws BusinessObjectException
      Sets comments on the relationship. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLag

      public Duration getLag() throws BusinessObjectException
      Gets the time lag of the relationship. This is the time lag between the predecessor activity's start or finish date and the successor activity's start or finish date, depending on the relationship type. The time lag is based on the successor activity's calendar. This value is specified by the project manager and is used by the project scheduler when scheduling activities.
      Returns:
      the value in the field Lag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setLag

      public void setLag(Duration d) throws BusinessObjectException
      Sets the time lag of the relationship. This is the time lag between the predecessor activity's start or finish date and the successor activity's start or finish date, depending on the relationship type. The time lag is based on the successor activity's calendar. This value is specified by the project manager and is used by the project scheduler when scheduling activities.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getArls

      public Date getArls() throws BusinessObjectException
      Gets this field is the relationship late start date (RLS) when the lost relationship type is FS or FF. When the relationship type is SS or SF, then ARLS is the RLS + RD of the predecessor. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field Arls
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAref

      public Date getAref() throws BusinessObjectException
      Gets this field is the relationship early finish date (REF) when the lost relationship type is FS or SS. When the relationship type is SF or FF, then AREF is the REF - RD of the successor. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field Aref
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSuccessorActivityName

      public String getSuccessorActivityName() throws BusinessObjectException
      Gets the name of the successor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SuccessorActivityName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredecessorActivityName

      public String getPredecessorActivityName() throws BusinessObjectException
      Gets the name of the predecessor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredecessorActivityName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSuccessorActivityId

      public String getSuccessorActivityId() throws BusinessObjectException
      Gets the activity ID of the successor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SuccessorActivityId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredecessorActivityId

      public String getPredecessorActivityId() throws BusinessObjectException
      Gets the activity ID of the predecessor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredecessorActivityId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredActIsLongestPath

      public boolean getPredActIsLongestPath() throws BusinessObjectException
      Gets the flag that indicates whether the Predecessor activity is on the longest path. Default = 'N'.
      Returns:
      the value in the field PredActIsLongestPath
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredActPercentCompleteType

      public PercentCompleteType getPredActPercentCompleteType() throws BusinessObjectException
      Gets the Predecessor activity percent complete type: 'Physical', 'Duration', or 'Units'.
      Returns:
      the value in the field PredActPercentCompleteType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSuccessorProjectId

      public String getSuccessorProjectId() throws BusinessObjectException
      Gets the project ID of the project that owns the successor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SuccessorProjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredecessorProjectId

      public String getPredecessorProjectId() throws BusinessObjectException
      Gets the project ID of the project that owns the predecessor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredecessorProjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredecessorProjectName

      public String getPredecessorProjectName() throws BusinessObjectException
      Gets the project Name of the project that owns the predecessor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredecessorProjectName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this dependency was created.
      Returns:
      the value in the field CreateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateDate

      public Date getLastUpdateDate() throws BusinessObjectException
      Gets the date this dependency was last updated.
      Returns:
      the value in the field LastUpdateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateUser

      public String getCreateUser() throws BusinessObjectException
      Gets the name of the user that created this dependency.
      Returns:
      the value in the field CreateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateUser

      public String getLastUpdateUser() throws BusinessObjectException
      Gets the name of the user that last updated this dependency.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsPredecessorBaseline

      public boolean getIsPredecessorBaseline() throws BusinessObjectException
      Gets the YesNo value indicating if the predecessor activity is related to a Project or Baseline.
      Returns:
      the value in the field IsPredecessorBaseline
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsSuccessorBaseline

      public boolean getIsSuccessorBaseline() throws BusinessObjectException
      Gets the YesNo value indicating if the successor activity is related to a Project or Baseline.
      Returns:
      the value in the field IsSuccessorBaseline
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDriving

      public boolean getDriving() throws BusinessObjectException
      Gets the flag indicating whether the relationship drives activity dates. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field Driving
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsSuccessorTemplate

      public boolean getIsSuccessorTemplate() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a template Project.
      Returns:
      the value in the field IsSuccessorTemplate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsPredecessorTemplate

      public boolean getIsPredecessorTemplate() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a template Project.
      Returns:
      the value in the field IsPredecessorTemplate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredTotalFloat

      public Duration getPredTotalFloat() throws BusinessObjectException
      Gets the amount of time the predecessor activity can be delayed before delaying the project finish date. Total float can be computed as late start - early start or as late finish - early finish; this option can be set when running the project scheduler. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredTotalFloat
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredFreeFloat

      public Duration getPredFreeFloat() throws BusinessObjectException
      Gets the amount of time the predecessor activity can be delayed before delaying the start date of any successor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredFreeFloat
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredEarlyStartDate

      public BeginDate getPredEarlyStartDate() throws BusinessObjectException
      Gets the earliest possible date the remaining work for the predecessor activity can begin. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredEarlyStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredEarlyFinishDate

      public EndDate getPredEarlyFinishDate() throws BusinessObjectException
      Gets the earliest possible date the predecessor activity can finish. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredEarlyFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredLateStartDate

      public BeginDate getPredLateStartDate() throws BusinessObjectException
      Gets the latest possible date the remaining work for the predecessor activity must begin without delaying the project finish date. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredLateStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredLateFinishDate

      public EndDate getPredLateFinishDate() throws BusinessObjectException
      Gets the latest possible date the predecessor activity must finish without delaying the project finish date. This date is computed by the project scheduler based on network logic, schedule constraints, and resource availability. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredLateFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredActualStartDate

      public BeginDate getPredActualStartDate() throws BusinessObjectException
      Gets the date on which the predecessor activity is actually started. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredActualStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredActualFinishDate

      public EndDate getPredActualFinishDate() throws BusinessObjectException
      Gets the date on which the predecessor activity is actually finished. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredActualFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSuccessorStartDate

      public BeginDate getSuccessorStartDate() throws BusinessObjectException
      Gets the start date of the Successor activity. Set to the remaining start date until the activity is started, then set to the actual start date. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SuccessorStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSuccessorFinishDate

      public EndDate getSuccessorFinishDate() throws BusinessObjectException
      Gets the current finish date of the Successor activity. Set to the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SuccessorFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSuccessorWbsName

      public String getSuccessorWbsName() throws BusinessObjectException
      Gets the WBS Name of the Successor Activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SuccessorWbsName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredecessorStartDate

      public BeginDate getPredecessorStartDate() throws BusinessObjectException
      Gets the start date of the predecessor activity. Set to the remaining start date until the activity is started, then set to the actual start date. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredecessorStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredecessorFinishDate

      public EndDate getPredecessorFinishDate() throws BusinessObjectException
      Gets the current finish date of the Predecessor activity. Set to the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredecessorFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredecessorWbsName

      public String getPredecessorWbsName() throws BusinessObjectException
      Gets the WBS Name of the predecessor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredecessorWbsName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredecessorWbsShortName

      public String getPredecessorWbsShortName() throws BusinessObjectException
      Gets the WBS Short Name of the predecessor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredecessorWbsShortName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredWBSPath

      public String getPredWBSPath() throws BusinessObjectException
      Gets the WBS Path of the predecessor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredWBSPath
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPredProjectNameSepChar

      public String getPredProjectNameSepChar() throws BusinessObjectException
      Gets the WBS Name Separator char of the predecessor activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field PredProjectNameSepChar
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

      public static String[] getRequiredCreateFields()
      Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.
      Returns:
      String[] an array of required create fields

    • getFilterableFields

      public static String[] getFilterableFields()
      Gets all fields that can be filtered.
      Returns:
      String[] an array of filterable fields

    • getInternalDefaultLoadFields

      public static String[] getInternalDefaultLoadFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getAllFields

      public static String[] getAllFields()
      Gets all fields for this business object.
      Returns:
      String[] an array of all fields

    • getInternalAllFields

      public static String[] getInternalAllFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getInternalAllFieldsSet

      public static Set<String> getInternalAllFieldsSet()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getWritableFields

      public static String[] getWritableFields()
      Gets all writable fields for this business object.
      Returns:
      String[] an array of writable fields

    • getDefaultXMLExportFields

      @Deprecated public static String[] getDefaultXMLExportFields()
      Deprecated.
      Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.
      Returns:
      String[] an array of field names

    • getMinimumXMLExportFields

      public static String[] getMinimumXMLExportFields()
      Gets all fields that are always exported at a minimum by the new flat XML exporter
      Returns:
      String[] an array of exported fields

    • toString

      public String toString()
      Returns a string representation of the object. The output is in XML.
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object.

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this Relationship object in the database.
      Returns:
      ObjectId the unique ID of the newly created Relationship object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • create

      public static ObjectId[] create(Session session, Relationship[] relationships) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple Relationship objects in the database.
      Parameters:
      session - the Session object
      relationships - array of Relationship objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created Relationship objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static Relationship load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single Relationship object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the Relationship object
      Returns:
      Relationship the Relationship object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static BOIterator<Relationship> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple Relationship objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the Relationship objects
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public void update() throws ServerException, NetworkException, BusinessObjectException
      Updates this Relationship object in the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public static void update(Session session, Relationship[] relationships) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple Relationship objects in the database.
      Parameters:
      session - the Session object
      relationships - array of Relationship objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public void delete() throws ServerException, NetworkException, BusinessObjectException
      Deletes this Relationship object from the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public static void delete(Session session, Relationship[] relationships) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple Relationship objects from the database.
      Parameters:
      session - the Session object
      relationships - array of Relationship objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects