Primavera Integration API 7.0

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

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.object.RoleLimit

public class RoleLimit
extends BusinessObject

Role limits define the limits of the maximum work units per time for a Role in a time period.

See Also:   Quick reference of RoleLimit fields


Constructor Summary
RoleLimit(Session session)
          Class constructor specifying the Session.
RoleLimit(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
RoleLimit(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 RoleLimit object in the database.
static ObjectId[] create(Session session, RoleLimit[] rolelimits)
          Creates multiple RoleLimit objects in the database.
 void delete()
          Deletes this RoleLimit object from the database.
static void delete(Session session, RoleLimit[] rolelimits)
          Deletes multiple RoleLimit objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.util.Date getCreateDate()
          Gets the date this role limit was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this role limit.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 BeginDate getEffectiveDate()
          Gets the effective date for the role maximum units per time.
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 role limit was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this role limit.
 UnitsPerTime getMaxUnitsPerTime()
          Gets the maximum work units per time this role can perform on all their assigned activities.
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.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 ObjectId getRoleObjectId()
          Gets the unique ID of the associated role.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static RoleLimit load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single RoleLimit object from the database.
static BOIterator<RoleLimit> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple RoleLimit objects from the database.
 Role loadRole(java.lang.String[] fields)
          Loads an associated Role object from the database.
 void setEffectiveDate(BeginDate d)
          Sets the effective date for the role maximum units per time.
 void setMaxUnitsPerTime(UnitsPerTime d)
          Sets the maximum work units per time this role can perform on all their assigned activities.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setRoleObjectId(ObjectId o)
          Sets the unique ID of the associated role.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this RoleLimit object in the database.
static void update(Session session, RoleLimit[] rolelimits)
          Updates multiple RoleLimit 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

RoleLimit

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

RoleLimit

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

RoleLimit

public RoleLimit(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 RoleLimit object in the database.

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

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

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

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the RoleLimit 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 RoleLimit 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,
                          RoleLimit[] rolelimits)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple RoleLimit objects in the database.

Parameters:
session - the Session object
rolelimits - array of RoleLimit 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 RoleLimit 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,
                          RoleLimit[] rolelimits)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple RoleLimit objects from the database.

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

loadRole

public Role loadRole(java.lang.String[] fields)
              throws ServerException,
                     NetworkException,
                     BusinessObjectException
Loads an associated Role object from the database.

Parameters:
fields - fields to load
Returns:
Role the Role 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.

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

getRoleObjectId

public ObjectId getRoleObjectId()
                         throws BusinessObjectException
Gets the unique ID of the associated role. 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.

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

setRoleObjectId

public void setRoleObjectId(ObjectId o)
                     throws BusinessObjectException
Sets the unique ID of the associated role. 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.

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

getEffectiveDate

public BeginDate getEffectiveDate()
                           throws BusinessObjectException
Gets the effective date for the role maximum units per time. 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 EffectiveDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setEffectiveDate

public void setEffectiveDate(BeginDate d)
                      throws BusinessObjectException
Sets the effective date for the role maximum units per time. This field must contain a valid value in order to create this type of business object in the database.

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

getMaxUnitsPerTime

public UnitsPerTime getMaxUnitsPerTime()
                                throws BusinessObjectException
Gets the maximum work units per time this role can perform on all their assigned activities. This number should correspond to the number of people who can fill this role.

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

setMaxUnitsPerTime

public void setMaxUnitsPerTime(UnitsPerTime d)
                        throws BusinessObjectException
Sets the maximum work units per time this role can perform on all their assigned activities. This number should correspond to the number of people who can fill this role.

Parameters:
d - 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 role limit 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 role limit 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 role limit.

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 role limit.

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.