Primavera Integration API 7.0

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

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

public class EPSFunding
extends BusinessObject

An EPS funding represents the assignment of a funding source to a particular EPS. The assigned funding source has an amount and fund share, or percentage.

See Also:   Quick reference of EPSFunding fields


Constructor Summary
EPSFunding(Session session)
          Class constructor specifying the Session.
EPSFunding(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
EPSFunding(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 EPSFunding object in the database.
static ObjectId[] create(Session session, EPSFunding[] epsfundings)
          Creates multiple EPSFunding objects in the database.
 void delete()
          Deletes this EPSFunding object from the database.
static void delete(Session session, EPSFunding[] epsfundings)
          Deletes multiple EPSFunding objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 Cost getAmount()
          Gets the amount of a funding source that is allocated to the EPS.
 java.util.Date getCreateDate()
          Gets the date this epsfunding was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this epsfunding.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 java.lang.String getEPSId()
          Gets the short code assigned to the associated EPS.
 java.lang.String getEPSName()
          Gets the name of the EPS element associated with this funding.
 ObjectId getEPSObjectId()
          Gets the unique ID of the associated EPS for this EPS funding.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 ObjectId getFundingSourceObjectId()
          Gets the unique ID of the associated funding source for this EPS funding.
 Percent getFundShare()
          Gets the percentage of the total fund that is allocated to the EPS.
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 epsfunding was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this epsfunding.
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.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static EPSFunding load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single EPSFunding object from the database.
static BOIterator<EPSFunding> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple EPSFunding objects from the database.
 EPS loadEPS(java.lang.String[] fields)
          Loads an associated EPS object from the database.
 FundingSource loadFundingSource(java.lang.String[] fields)
          Loads an associated FundingSource object from the database.
 void setAmount(Cost c)
          Sets the amount of a funding source that is allocated to the EPS.
 void setEPSObjectId(ObjectId o)
          Sets the unique ID of the associated EPS for this EPS funding.
 void setFundingSourceObjectId(ObjectId o)
          Sets the unique ID of the associated funding source for this EPS funding.
 void setFundShare(Percent p)
          Sets the percentage of the total fund that is allocated to the EPS.
 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 EPSFunding object in the database.
static void update(Session session, EPSFunding[] epsfundings)
          Updates multiple EPSFunding 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

EPSFunding

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

EPSFunding

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

EPSFunding

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

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

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

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

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

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

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

loadEPS

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

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

loadFundingSource

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

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

getAmount

public Cost getAmount()
               throws BusinessObjectException
Gets the amount of a funding source that is allocated to the EPS.

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

setAmount

public void setAmount(Cost c)
               throws BusinessObjectException
Sets the amount of a funding source that is allocated to the EPS.

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

getFundShare

public Percent getFundShare()
                     throws BusinessObjectException
Gets the percentage of the total fund that is allocated to the EPS.

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

setFundShare

public void setFundShare(Percent p)
                  throws BusinessObjectException
Sets the percentage of the total fund that is allocated to the EPS.

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

getFundingSourceObjectId

public ObjectId getFundingSourceObjectId()
                                  throws BusinessObjectException
Gets the unique ID of the associated funding source for this EPS funding. 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 FundingSourceObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setFundingSourceObjectId

public void setFundingSourceObjectId(ObjectId o)
                              throws BusinessObjectException
Sets the unique ID of the associated funding source for this EPS funding. 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

getEPSObjectId

public ObjectId getEPSObjectId()
                        throws BusinessObjectException
Gets the unique ID of the associated EPS for this EPS funding. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setEPSObjectId

public void setEPSObjectId(ObjectId o)
                    throws BusinessObjectException
Sets the unique ID of the associated EPS for this EPS funding. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getEPSId

public java.lang.String getEPSId()
                          throws BusinessObjectException
Gets the short code assigned to the associated EPS.

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

getEPSName

public java.lang.String getEPSName()
                            throws BusinessObjectException
Gets the name of the EPS element associated with this funding.

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

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this epsfunding 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 epsfunding 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 epsfunding.

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

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.