Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class Shift

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.base.ShiftBase
              extended by com.primavera.integration.client.bo.object.Shift

public class Shift
extends com.primavera.integration.client.bo.base.ShiftBase

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

Shift

public Shift(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

Shift

public Shift(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

Shift

public Shift(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 Detail

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this Shift object in the database.

Returns:
ObjectId the unique ID of the newly created Shift 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,
                                Shift[] shifts)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple Shift objects in the database.

Parameters:
session - the Session object
shifts - array of Shift objects to create
Returns:
ObjectId[] the array of unique IDs of newly created Shift 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 Shift load(Session session,
                         java.lang.String[] fields,
                         ObjectId objId)
                  throws ServerException,
                         NetworkException,
                         BusinessObjectException
Loads a single Shift object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the Shift object
Returns:
Shift the Shift 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<Shift> load(Session session,
                                     java.lang.String[] fields,
                                     ObjectId[] objIds)
                              throws ServerException,
                                     NetworkException,
                                     BusinessObjectException
Loads multiple Shift objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the Shift 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 Shift object in the database.

Overrides:
update in class BOBase
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,
                          Shift[] shifts)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple Shift objects in the database.

Parameters:
session - the Session object
shifts - array of Shift 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 Shift object from the database.

Overrides:
delete in class BOBase
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,
                          Shift[] shifts)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple Shift objects from the database.

Parameters:
session - the Session object
shifts - array of Shift 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

loadShiftPeriods

public BOIterator<ShiftPeriod> loadShiftPeriods(java.lang.String[] fields,
                                                java.lang.String sWhereClause,
                                                java.lang.String sOrderBy)
                                         throws ServerException,
                                                NetworkException,
                                                BusinessObjectException
Loads multiple associated ShiftPeriod objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
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

getShiftPeriodStarts

public int[] getShiftPeriodStarts()
                           throws BusinessObjectException
Gets the start hours of the shift periods in an array.

Overrides:
getShiftPeriodStarts in class com.primavera.integration.client.bo.base.ShiftBase
Returns:
the start hours of the shift periods in an int array
Throws:
BusinessObjectException - if something was wrong in this Business object

getShiftPeriodDurations

public int[] getShiftPeriodDurations()
                              throws BusinessObjectException
Gets the durations of the shift periods in an array.

Overrides:
getShiftPeriodDurations in class com.primavera.integration.client.bo.base.ShiftBase
Returns:
the durations of the shift periods in an int array
Throws:
BusinessObjectException - if something was wrong in this Business object

addShiftPeriod

public void addShiftPeriod(int iStartHour)
                    throws BusinessObjectException
Add a shift period with the start hour.

Overrides:
addShiftPeriod in class com.primavera.integration.client.bo.base.ShiftBase
Parameters:
iStartHour - the start hour of the shift period
Throws:
BusinessObjectException - if something was wrong in this Business object

removeShiftPeriod

public void removeShiftPeriod(int iStartHour)
                       throws BusinessObjectException
Remove a shift period with the start hour.

Overrides:
removeShiftPeriod in class com.primavera.integration.client.bo.base.ShiftBase
Parameters:
iStartHour - the start hour of the shift period
Throws:
BusinessObjectException - if something was wrong in this Business object

removeAllShiftPeriods

public void removeAllShiftPeriods()
                           throws BusinessObjectException
Remove all the shift periods.

Overrides:
removeAllShiftPeriods in class com.primavera.integration.client.bo.base.ShiftBase
Throws:
BusinessObjectException - if something was wrong in this Business object

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

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.

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

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the shift. 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 Name
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setName

public void setName(java.lang.String s)
             throws BusinessObjectException
Sets the name of the shift. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this shift was created.

Returns:
the value in the field CreateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws BusinessObjectException
Gets the date this shift was last updated.

Returns:
the value in the field LastUpdateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateUser

public java.lang.String getCreateUser()
                               throws BusinessObjectException
Gets the name of the user that created this shift.

Returns:
the value in the field CreateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateUser

public java.lang.String getLastUpdateUser()
                                   throws BusinessObjectException
Gets the name of the user that last updated this shift.

Returns:
the value in the field LastUpdateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRequiredCreateFields

public static java.lang.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 java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.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 java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.