|
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.base.ShiftBase
com.primavera.integration.client.bo.object.Shift
public class Shift
Shifts are used to define shift calendars for resources. A shift is comprised of one or more shift periods. The total duration of all shift periods in a shift always adds up to 24 hours, with one hour being the minimum shift period.
Shift hours are considered when calculating units and prices during leveling. The resource calendar is used to determine when the resource can work; the limits for that period are determined from the shift definition for that resource. The minimum resource availability for every shift must satisfy the minimum demand for the resource so that the resource can be leveled properly. Limits defined outside the boundaries of the shift definition are ignored. Since shifts are defined at the resource level, all projects are leveled using that resource according to the shift definition.
Shift periods may not be directly created or deleted. To access or change the shift periods on a shift, use the shift methods getShiftPeriodStarts(), getShiftPeriodDurations(), addShiftPeriod(), removeShiftPeriod(), and removeAllShiftPeriods().
See Also: Quick reference of Shift fields
Constructor Summary | |
---|---|
Shift(Session session)
Class constructor specifying the Session. |
|
Shift(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
Shift(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
void |
addShiftPeriod(int iStartHour)
Add a shift period with the start hour. |
ObjectId |
create()
Creates this Shift object in the database. |
static ObjectId[] |
create(Session session,
Shift[] shifts)
Creates multiple Shift objects in the database. |
void |
delete()
Deletes this Shift object from the database. |
static void |
delete(Session session,
Shift[] shifts)
Deletes multiple Shift objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this shift was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this shift. |
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. |
java.util.Date |
getLastUpdateDate()
Gets the date this shift was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this shift. |
static java.lang.String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
java.lang.String |
getName()
Gets the name of the shift. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
int[] |
getShiftPeriodDurations()
Gets the durations of the shift periods in an array. |
int[] |
getShiftPeriodStarts()
Gets the start hours of the shift periods in an array. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static Shift |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single Shift object from the database. |
static BOIterator<Shift> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple Shift objects from the database. |
BOIterator<ShiftPeriod> |
loadShiftPeriods(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ShiftPeriod objects from the database. |
void |
removeAllShiftPeriods()
Remove all the shift periods. |
void |
removeShiftPeriod(int iStartHour)
Remove a shift period with the start hour. |
void |
setName(java.lang.String s)
Sets the name of the shift. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this Shift object in the database. |
static void |
update(Session session,
Shift[] shifts)
Updates multiple Shift 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 Shift(Session session)
session
- the Sessionpublic Shift(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Shift(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, Shift[] shifts) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectshifts
- array of Shift 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 Shift load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the Shift 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<Shift> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the Shift 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, Shift[] shifts) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectshifts
- array of Shift 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, Shift[] shifts) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectshifts
- array of Shift 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 BOIterator<ShiftPeriod> loadShiftPeriods(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 int[] getShiftPeriodStarts() throws BusinessObjectException
getShiftPeriodStarts
in class com.primavera.integration.client.bo.base.ShiftBase
BusinessObjectException
- if something was wrong in this Business objectpublic int[] getShiftPeriodDurations() throws BusinessObjectException
getShiftPeriodDurations
in class com.primavera.integration.client.bo.base.ShiftBase
BusinessObjectException
- if something was wrong in this Business objectpublic void addShiftPeriod(int iStartHour) throws BusinessObjectException
addShiftPeriod
in class com.primavera.integration.client.bo.base.ShiftBase
iStartHour
- the start hour of the shift period
BusinessObjectException
- if something was wrong in this Business objectpublic void removeShiftPeriod(int iStartHour) throws BusinessObjectException
removeShiftPeriod
in class com.primavera.integration.client.bo.base.ShiftBase
iStartHour
- the start hour of the shift period
BusinessObjectException
- if something was wrong in this Business objectpublic void removeAllShiftPeriods() throws BusinessObjectException
removeAllShiftPeriods
in class com.primavera.integration.client.bo.base.ShiftBase
BusinessObjectException
- if something was wrong in this Business objectpublic 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 java.lang.String getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(java.lang.String s) throws BusinessObjectException
s
- 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[] 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 |