|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.Relationship
public class Relationship
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 Summary | |
---|---|
Relationship(Session session)
Class constructor specifying the Session. |
|
Relationship(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
Relationship(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
ObjectId |
create()
Creates this Relationship object in the database. |
static ObjectId[] |
create(Session session,
Relationship[] relationships)
Creates multiple Relationship objects in the database. |
void |
delete()
Deletes this Relationship object from the database. |
static void |
delete(Session session,
Relationship[] relationships)
Deletes multiple Relationship objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this dependency was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this dependency. |
static java.lang.String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
static java.lang.String[] |
getFilterableFields()
Gets all fields that can be filtered. |
static java.lang.String[] |
getInternalAllFields()
An internal method that should not be called directly by client code. |
static java.util.Set<java.lang.String> |
getInternalAllFieldsSet()
An internal method that should not be called directly by client code. |
static java.lang.String[] |
getInternalDefaultLoadFields()
An internal method that should not be called directly by client code. |
boolean |
getIsPredecessorBaseline()
Gets the YesNo value indicating if the predecessor activity is related to a Project or Baseline. |
boolean |
getIsSuccessorBaseline()
Gets the YesNo value indicating if the successor activity is related to a Project or Baseline. |
Duration |
getLag()
Gets the time lag of the relationship. |
java.util.Date |
getLastUpdateDate()
Gets the date this dependency was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this dependency. |
static java.lang.String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
java.lang.String |
getPredecessorActivityId()
Gets the activity ID of the predecessor activity. |
java.lang.String |
getPredecessorActivityName()
Gets the name of the predecessor activity. |
ObjectId |
getPredecessorActivityObjectId()
Gets the unique ID of the predecessor activity. |
ActivityType |
getPredecessorActivityType()
Gets the type of the predecessor activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'. |
java.lang.String |
getPredecessorProjectId()
Gets the project ID of the project that owns the predecessor activity. |
ObjectId |
getPredecessorProjectObjectId()
Gets the unique ID of the project that owns the predecessor activity. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
java.lang.String |
getSuccessorActivityId()
Gets the activity ID of the successor activity. |
java.lang.String |
getSuccessorActivityName()
Gets the name of the successor activity. |
ObjectId |
getSuccessorActivityObjectId()
Gets the unique ID of the successor activity. |
ActivityType |
getSuccessorActivityType()
Gets the type of the successor activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'. |
java.lang.String |
getSuccessorProjectId()
Gets the project ID of the project that owns the successor activity. |
ObjectId |
getSuccessorProjectObjectId()
Gets the unique ID of the project that owns the successor activity. |
RelationshipType |
getType()
Gets the type of relationship: 'Finish to Start', 'Finish to Finish', 'Start to Start', or 'Start to Finish'. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static Relationship |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single Relationship object from the database. |
static BOIterator<Relationship> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple Relationship objects from the database. |
Activity |
loadPredecessorActivity(java.lang.String[] fields)
Loads an associated Activity object from the database. |
Project |
loadPredecessorProject(java.lang.String[] fields)
Loads an associated Project object from the database. |
Activity |
loadSuccessorActivity(java.lang.String[] fields)
Loads an associated Activity object from the database. |
Project |
loadSuccessorProject(java.lang.String[] fields)
Loads an associated Project object from the database. |
void |
setLag(Duration d)
Sets the time lag of the relationship. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setPredecessorActivityObjectId(ObjectId o)
Sets the unique ID of the predecessor activity. |
void |
setSuccessorActivityObjectId(ObjectId o)
Sets the unique ID of the successor activity. |
void |
setType(RelationshipType enm)
Sets the type of relationship: 'Finish to Start', 'Finish to Finish', 'Start to Start', or 'Start to Finish'. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this Relationship object in the database. |
static void |
update(Session session,
Relationship[] relationships)
Updates multiple Relationship objects in the database. |
Methods inherited from class com.primavera.integration.client.bo.BusinessObject |
---|
equals, hashCode, isNull, setNull |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Relationship(Session session)
session
- the Sessionpublic Relationship(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Relationship(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
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 objectspublic static ObjectId[] create(Session session, Relationship[] relationships) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectrelationships
- array of Relationship objects to create
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 objectspublic static Relationship load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the Relationship object
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 objectspublic static BOIterator<Relationship> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the Relationship objects
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 objectspublic void update() throws ServerException, NetworkException, BusinessObjectException
update
in class BOBase
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 objectspublic static void update(Session session, Relationship[] relationships) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectrelationships
- array of Relationship objects to update
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 objectspublic void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class BOBase
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 objectspublic static void delete(Session session, Relationship[] relationships) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectrelationships
- array of Relationship objects to delete
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 objectspublic Activity loadSuccessorActivity(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic Activity loadPredecessorActivity(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic Project loadSuccessorProject(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic Project loadPredecessorProject(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getSuccessorActivityObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSuccessorActivityObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityType getSuccessorActivityType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityType getPredecessorActivityType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getPredecessorActivityObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPredecessorActivityObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getSuccessorProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getPredecessorProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic RelationshipType getType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setType(RelationshipType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Duration getLag() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setLag(Duration d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getSuccessorActivityName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getPredecessorActivityName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getSuccessorActivityId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getPredecessorActivityId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getSuccessorProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getPredecessorProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsPredecessorBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsSuccessorBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static java.lang.String[] getRequiredCreateFields()
public static java.lang.String[] getFilterableFields()
public static java.lang.String[] getInternalDefaultLoadFields()
public static java.lang.String[] getAllFields()
public static java.lang.String[] getInternalAllFields()
public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
public static java.lang.String[] getWritableFields()
public static java.lang.String[] getDefaultXMLExportFields()
public static java.lang.String[] getMinimumXMLExportFields()
public java.lang.String toString()
toString
in class java.lang.Object
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |