|
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.ScheduleOptions
public class ScheduleOptions
Use this class to specify how the associated project is to be scheduled.
Note that this business object has a multi-part object ID; its object ID is a combination of its user object ID and its project object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs. When loading schedule options from a project, the current user is always used. To access schedule options for other users, first create a multi-part object ID and then load the schedule options object directly.
You may not create or delete schedule options; they may only be loaded and updated.
See Also: Quick reference of ScheduleOptions fields
Constructor Summary | |
---|---|
ScheduleOptions(Session session)
Class constructor specifying the Session. |
|
ScheduleOptions(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ScheduleOptions(Session session,
ObjectId userObjectId,
ObjectId projectObjectId)
Class constructor specifying the Session and the individual components of the multi-part key: UserObjectId and ProjectObjectId. |
|
ScheduleOptions(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
static ObjectId |
createObjectId(ObjectId userObjectId,
ObjectId projectObjectId)
Creates a multi-part ObjectId from two individual ObjectIds. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
boolean |
getCalculateFloatBasedOnFinishDate()
Gets the flag that indicates how each activity's float will be calculated with respect to other projects in the scheduling batch. |
ScheduleFloatType |
getComputeTotalFloatType()
Gets the method for calculating total float for all activities. |
java.util.Date |
getCreateDate()
Gets the date this schedule option was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this schedule option. |
Duration |
getCriticalActivityFloatThreshold()
Gets the maximum float time for activities before they are marked critical. |
CriticalActivityPathType |
getCriticalActivityPathType()
Gets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'. |
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. |
boolean |
getIgnoreOtherProjectRelationships()
Gets the option used by the scheduler for treating activity relationships between projects when scheduling. |
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. |
java.util.Date |
getLastUpdateDate()
Gets the date this schedule option was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this schedule option. |
boolean |
getLevelResourcesDuringScheduling()
Gets the option used by the scheduler for automatically leveling resources when scheduling projects. |
boolean |
getMakeOpenEndedActivitiesCritical()
Gets the option used by the scheduler for automatically leveling resources when scheduling projects. |
int |
getMaximumMultipleFloatPaths()
Gets the number of critical float paths to calculate. |
static java.lang.String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
boolean |
getMultipleFloatPathsEnabled()
Gets the Boolean value that indicates whether multiple critical float paths (sequences of activities) should be calculated in the project schedule. |
ObjectId |
getMultipleFloatPathsEndingActivityObjectId()
Gets the activity in the WBS that you want to represent the end of the float paths. |
boolean |
getMultipleFloatPathsUseTotalFloat()
Gets the Boolean value that decides whether or not to use total float in multiple float path calculations. |
ObjectId |
getObjectId()
Gets the ObjectId for this object. |
OutOfSequenceScheduleType |
getOutOfSequenceScheduleType()
Gets the type of logic used to schedule the progressed activities: 'Retained Logic', 'Progress Override', or 'Actual Dates'. |
java.lang.String |
getProjectId()
Gets the short code that uniquely identifies the project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
boolean |
getRecalculateResourceCosts()
Gets the option used by the scheduler for recalculating the resource costs after scheduling the open projects. |
ScheduleRelationshipLagCalendar |
getRelationshipLagCalendar()
Gets the calendar used to calculate the lag between predecessors and successors for all activities. |
boolean |
getStartToStartLagCalculationType()
Gets the method used to calculate lag when a start-to-start relationship exists and the predecessor starts out of sequence. |
boolean |
getUseExpectedFinishDates()
Gets the option used for setting activity finish dates as the expected finish dates when scheduling projects. |
java.lang.String |
getUserName()
Gets the user's login name. |
ObjectId |
getUserObjectId()
Gets the unique ID of the associated user. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ScheduleOptions |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ScheduleOptions object from the database. |
static BOIterator<ScheduleOptions> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ScheduleOptions objects from the database. |
void |
setCalculateFloatBasedOnFinishDate(boolean b)
Sets the flag that indicates how each activity's float will be calculated with respect to other projects in the scheduling batch. |
void |
setComputeTotalFloatType(ScheduleFloatType enm)
Sets the method for calculating total float for all activities. |
void |
setCriticalActivityFloatThreshold(Duration d)
Sets the maximum float time for activities before they are marked critical. |
void |
setCriticalActivityPathType(CriticalActivityPathType enm)
Sets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'. |
void |
setIgnoreOtherProjectRelationships(boolean b)
Sets the option used by the scheduler for treating activity relationships between projects when scheduling. |
void |
setLevelResourcesDuringScheduling(boolean b)
Sets the option used by the scheduler for automatically leveling resources when scheduling projects. |
void |
setMakeOpenEndedActivitiesCritical(boolean b)
Sets the option used by the scheduler for automatically leveling resources when scheduling projects. |
void |
setMaximumMultipleFloatPaths(int i)
Sets the number of critical float paths to calculate. |
void |
setMultipleFloatPathsEnabled(boolean b)
Sets the Boolean value that indicates whether multiple critical float paths (sequences of activities) should be calculated in the project schedule. |
void |
setMultipleFloatPathsEndingActivityObjectId(ObjectId o)
Sets the activity in the WBS that you want to represent the end of the float paths. |
void |
setMultipleFloatPathsUseTotalFloat(boolean b)
Sets the Boolean value that decides whether or not to use total float in multiple float path calculations. |
void |
setOutOfSequenceScheduleType(OutOfSequenceScheduleType enm)
Sets the type of logic used to schedule the progressed activities: 'Retained Logic', 'Progress Override', or 'Actual Dates'. |
void |
setRecalculateResourceCosts(boolean b)
Sets the option used by the scheduler for recalculating the resource costs after scheduling the open projects. |
void |
setRelationshipLagCalendar(ScheduleRelationshipLagCalendar enm)
Sets the calendar used to calculate the lag between predecessors and successors for all activities. |
void |
setStartToStartLagCalculationType(boolean b)
Sets the method used to calculate lag when a start-to-start relationship exists and the predecessor starts out of sequence. |
void |
setUseExpectedFinishDates(boolean b)
Sets the option used for setting activity finish dates as the expected finish dates when scheduling projects. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ScheduleOptions object in the database. |
static void |
update(Session session,
ScheduleOptions[] scheduleoptions)
Updates multiple ScheduleOptions objects in the database. |
Methods inherited from class com.primavera.integration.client.bo.BusinessObject |
---|
equals, hashCode, isNull, setNull, setObjectId |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ScheduleOptions(Session session)
session
- the Sessionpublic ScheduleOptions(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ScheduleOptions(Session session, ObjectId userObjectId, ObjectId projectObjectId) throws BusinessObjectException
session
- the SessionuserObjectId
- the first ObjectId in the keyprojectObjectId
- the second ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ScheduleOptions(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 static ObjectId createObjectId(ObjectId userObjectId, ObjectId projectObjectId) throws InvalidValueException
userObjectId
- the ObjectId of the associated user object.projectObjectId
- the ObjectId of the associated project object.
InvalidValueException
- if one of the input parameters was invalid.
java.lang.IllegalArgumentException
- if one of the input parameters was null.public ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if the ObjectId fields were not loaded.public static ScheduleOptions load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ScheduleOptions 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<ScheduleOptions> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ScheduleOptions 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, ScheduleOptions[] scheduleoptions) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectscheduleoptions
- array of ScheduleOptions 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 ObjectId getUserObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getUserName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getLevelResourcesDuringScheduling() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setLevelResourcesDuringScheduling(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getRecalculateResourceCosts() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setRecalculateResourceCosts(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIgnoreOtherProjectRelationships() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIgnoreOtherProjectRelationships(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic OutOfSequenceScheduleType getOutOfSequenceScheduleType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setOutOfSequenceScheduleType(OutOfSequenceScheduleType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getMakeOpenEndedActivitiesCritical() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setMakeOpenEndedActivitiesCritical(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getUseExpectedFinishDates() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUseExpectedFinishDates(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getStartToStartLagCalculationType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setStartToStartLagCalculationType(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Duration getCriticalActivityFloatThreshold() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCriticalActivityFloatThreshold(Duration d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ScheduleFloatType getComputeTotalFloatType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setComputeTotalFloatType(ScheduleFloatType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ScheduleRelationshipLagCalendar getRelationshipLagCalendar() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setRelationshipLagCalendar(ScheduleRelationshipLagCalendar enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic CriticalActivityPathType getCriticalActivityPathType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCriticalActivityPathType(CriticalActivityPathType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getMultipleFloatPathsEnabled() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setMultipleFloatPathsEnabled(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getMultipleFloatPathsUseTotalFloat() throws BusinessObjectException
If True, then based on the activity you want the paths to end on, the module determines which predecessor activity has the most critical Relationship Total Float on the backward pass. The module repeats this process until an activity is reached that has no relationship. The module begins the forward pass from this activity and determines which successor activity has the most critical Relationship Successor Total Float. The module repeats this process until an activity is reached that has no relationship. These activities represent the most critical float path. The process begins again until the remaining sub-critical paths are calculated.
If False, then critical float paths are defined based on longest path. The most critical path will be identical to the critical path that is derived when you choose to define critical activities as Longest Path in the General tab. In a multicalendar project, the longest path is calculated by identifying the activities that have an early finish equal to the latest calculated early finish for the project and tracing all driving relationships for those activities back to the project start date. After the most critical path is identified, the module will calculate the remaining sub-critical paths.
This field may not be included in the where clause or order by clause specified when loading business objects.
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setMultipleFloatPathsUseTotalFloat(boolean b) throws BusinessObjectException
If True, then based on the activity you want the paths to end on, the module determines which predecessor activity has the most critical Relationship Total Float on the backward pass. The module repeats this process until an activity is reached that has no relationship. The module begins the forward pass from this activity and determines which successor activity has the most critical Relationship Successor Total Float. The module repeats this process until an activity is reached that has no relationship. These activities represent the most critical float path. The process begins again until the remaining sub-critical paths are calculated.
If False, then critical float paths are defined based on longest path. The most critical path will be identical to the critical path that is derived when you choose to define critical activities as Longest Path in the General tab. In a multicalendar project, the longest path is calculated by identifying the activities that have an early finish equal to the latest calculated early finish for the project and tracing all driving relationships for those activities back to the project start date. After the most critical path is identified, the module will calculate the remaining sub-critical paths.
This field may not be included in the where clause or order by clause specified when loading business objects.
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getMultipleFloatPathsEndingActivityObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setMultipleFloatPathsEndingActivityObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getMaximumMultipleFloatPaths() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setMaximumMultipleFloatPaths(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getCalculateFloatBasedOnFinishDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCalculateFloatBasedOnFinishDate(boolean b) throws BusinessObjectException
b
- the value to set this field to
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 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 |