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

Class ShiftPeriod

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

Shift periods are segments of a shift. Each shift period starts on a unique hour and the duration of all shift periods in a shift always adds up to 24 hours. The minimum duration of a shift period is one hour.

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().

Shift periods may not be exported directly by the XMLExporter, but all child shift periods are exported automatically when exporting shifts.

See Also:   Quick reference of ShiftPeriod fields

  • Constructor Details

    • ShiftPeriod

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

    • ShiftPeriod

      public ShiftPeriod(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • ShiftPeriod

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

    • loadShift

      public Shift loadShift(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Shift object from the database.
      Parameters:
      fields - fields to load
      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

    • 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. This field must contain a valid value in order to create this type of business object in 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

    • getShiftObjectId

      public ObjectId getShiftObjectId() throws BusinessObjectException
      Gets the unique ID of the associated shift. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field ShiftObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStartHour

      public int getStartHour() throws BusinessObjectException
      Gets the start time of the shift that is displayed on screen. The values range from 0 to 23. This field must contain a valid value in order to create this type of business object in 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 StartHour
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this shift period 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 shift period 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 shift period.
      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 shift period.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • 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.

    • load

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