Primavera Integration API 7.0

com.primavera.integration.client.bo.helper
Class ProjectSpendingPlanHelper

java.lang.Object
  extended by com.primavera.integration.client.BOHelperBase
      extended by com.primavera.integration.client.bo.BOHelperImpl<ProjectSpendingPlan>
          extended by com.primavera.integration.client.bo.helper.ProjectSpendingPlanHelper
All Implemented Interfaces:
BOHelper<ProjectSpendingPlan>, InternalBOHelper<ProjectSpendingPlan>

public class ProjectSpendingPlanHelper
extends BOHelperImpl<ProjectSpendingPlan>
implements InternalBOHelper<ProjectSpendingPlan>

Business object helper class used to simplify access to ProjectSpendingPlan objects.


Method Summary
 ObjectId[] create(Session session, java.util.List alObjects)
          Creates multiple business objects of this type in the database.
 ProjectSpendingPlan[] createBusinessObjectArray(int iSize)
          Creates an array of a particular business object type.
 void delete(Session session, java.util.List alObjects)
          Deletes business objects of this type.
 void delete(Session session, java.util.List alObjects, ObjectId replacementParent)
          Deletes business objects of this type, specifying a replacement parent
 java.lang.String[] getAllFields()
          Gets all non-code and non-UDF fields for this business object
 java.lang.String[] getFilterableFields()
          Gets all non-code and non-UDF fields for this business object.
 java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 java.lang.String[] getMainFields()
          Gets all fields that are not code, UDF, or summary fields.
 java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String[] getRequiredCreateFields()
          Gets all fields that are filterable.
 java.lang.String[] getWritableFields()
          Gets all writable non-code and non-UDF fields for this business object
 BOIterator<ProjectSpendingPlan> load(Session session, BusinessObject boParent, java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads business objects of this type from a given parent.
 BOIterator<ProjectSpendingPlan> load(Session session, BusinessObject boParent, java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy, com.primavera.bo.common.PRequestOptions options, com.primavera.bo.base.RemoteTXId txId)
          An internal load method that should not be called directly from client code.
 ProjectSpendingPlan load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a business object of this type by ObjectId.
 BOIterator<ProjectSpendingPlan> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple business objects of this type by ObjectId.
 BOIterator<ProjectSpendingPlan> load(Session session, java.lang.String[] fields, ObjectId[] objIds, com.primavera.bo.common.PRequestOptions options, com.primavera.bo.base.RemoteTXId txId)
          An internal load method that should not be called directly from client code.
 BOIterator<ProjectSpendingPlan> load(Session session, java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy, com.primavera.bo.common.PRequestOptions options, com.primavera.bo.base.RemoteTXId txId)
          An internal load method that should not be called directly from client code.
 ProjectSpendingPlan newBusinessObject(Session session)
          Creates a new client-side instance of this type of business object; call create() on the object to add it to the database.
 ProjectSpendingPlan newBusinessObject(Session session, ObjectId objectId)
          Creates a new client-side instance of this type of business object and sets its unique ID.
 void update(Session session, java.util.List alObjects)
          Updates business objects of this type.
 
Methods inherited from class com.primavera.integration.client.bo.BOHelperImpl
canCreate, canDelete, canUpdate, create, delete, getAllParentClassNames, getBODef, getClassName, getClassNameFromObjectIdFieldName, getCodeValue, getCodeValueObjectId, getDefaultParentClassName, getDeleteAssociations, getDrivingReferences, getEnumDefaultValue, getEnumObject, getFieldType, getFillDownFields, getKeyFields, getLoadAssociations, getLoggingFieldName, getMaxFieldLength, getMaxFieldLengthMap, getNonDrivingReferences, getObjectIdFieldNames, getPluralName, getReferencedObject, getUDFValue, getUDFValueAsObject, getUserDefinedFieldLengthLimits, getValue, getValueAsObject, getVarCharLengths, getWSDLGroup, hasField, hasFieldValue, hasMultiPartKey, internalGetValue, internalSetValue, isAssociatedClass, isField, isFilterableField, isGlobal, isHierarchical, isNullableField, isScriptableField, isSingular, isWritableField, newBusinessObject, newBusinessObject, setCodeValueObjectId, setRawValue, setRawValue, setUDFValue, setValue, setValues, supportsCodes, supportsLiveSpreads, supportsSummarizedSreads, supportsUDF, supportsUDFCode, update
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.primavera.integration.client.bo.InternalBOHelper
create, delete, getBODef, getDrivingReferences, getEnumDefaultValue, getEnumObject, getFillDownFields, getLoggingFieldName, getMaxFieldLengthMap, getNonDrivingReferences, getReferencedObject, getUserDefinedFieldLengthLimits, getVarCharLengths, getWSDLGroup, hasField, internalGetValue, internalSetValue, isNullableField, newBusinessObject, setRawValue, setRawValue, update
 
Methods inherited from interface com.primavera.integration.client.bo.BOHelper
canCreate, canDelete, canUpdate, getAllParentClassNames, getClassName, getClassNameFromObjectIdFieldName, getCodeValue, getCodeValueObjectId, getDefaultParentClassName, getDeleteAssociations, getFieldType, getKeyFields, getLoadAssociations, getMaxFieldLength, getObjectIdFieldNames, getPluralName, getUDFValue, getUDFValueAsObject, getValue, getValueAsObject, hasFieldValue, hasMultiPartKey, isAssociatedClass, isField, isFilterableField, isGlobal, isHierarchical, isScriptableField, isSingular, isWritableField, newBusinessObject, setCodeValueObjectId, setUDFValue, setValue, setValues, supportsCodes, supportsLiveSpreads, supportsSummarizedSreads, supportsUDF, supportsUDFCode
 

Method Detail

getRequiredCreateFields

public java.lang.String[] getRequiredCreateFields()
Description copied from interface: BOHelper
Gets all fields that are filterable.

Specified by:
getRequiredCreateFields in interface BOHelper<ProjectSpendingPlan>
Specified by:
getRequiredCreateFields in class BOHelperImpl<ProjectSpendingPlan>
Returns:
String[] an array of filterable fields

getAllFields

public java.lang.String[] getAllFields()
Description copied from interface: BOHelper
Gets all non-code and non-UDF fields for this business object

Specified by:
getAllFields in interface BOHelper<ProjectSpendingPlan>
Specified by:
getAllFields in class BOHelperImpl<ProjectSpendingPlan>
Returns:
String[] an array of all non-code and non-UDF fields

getFilterableFields

public java.lang.String[] getFilterableFields()
Description copied from interface: BOHelper
Gets all non-code and non-UDF fields for this business object.

Specified by:
getFilterableFields in interface BOHelper<ProjectSpendingPlan>
Specified by:
getFilterableFields in class BOHelperImpl<ProjectSpendingPlan>
Returns:
String[] an array of all non-code fields

getWritableFields

public java.lang.String[] getWritableFields()
Description copied from interface: BOHelper
Gets all writable non-code and non-UDF fields for this business object

Specified by:
getWritableFields in interface BOHelper<ProjectSpendingPlan>
Specified by:
getWritableFields in class BOHelperImpl<ProjectSpendingPlan>
Returns:
String[] an array of all writable non-code and non-UDF fields

getInternalDefaultLoadFields

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

Specified by:
getInternalDefaultLoadFields in interface InternalBOHelper<ProjectSpendingPlan>
Specified by:
getInternalDefaultLoadFields in class BOHelperImpl<ProjectSpendingPlan>
Returns:
String[] an internal array

getMinimumXMLExportFields

public java.lang.String[] getMinimumXMLExportFields()
Description copied from interface: BOHelper
Gets all fields that are always exported at a minimum by the new flat XML exporter

Specified by:
getMinimumXMLExportFields in interface BOHelper<ProjectSpendingPlan>
Specified by:
getMinimumXMLExportFields in class BOHelperImpl<ProjectSpendingPlan>
Returns:
String[] an array of exported fields

getMainFields

public java.lang.String[] getMainFields()
Description copied from interface: BOHelper
Gets all fields that are not code, UDF, or summary fields. Code types assigned and UDF types assigned fields are also not included.

Specified by:
getMainFields in interface BOHelper<ProjectSpendingPlan>
Specified by:
getMainFields in class BOHelperImpl<ProjectSpendingPlan>
Returns:
String[] an array of all non-code fields

newBusinessObject

public ProjectSpendingPlan newBusinessObject(Session session)
Description copied from interface: BOHelper
Creates a new client-side instance of this type of business object; call create() on the object to add it to the database.

Specified by:
newBusinessObject in interface BOHelper<ProjectSpendingPlan>
Specified by:
newBusinessObject in class BOHelperImpl<ProjectSpendingPlan>
Parameters:
session - the current session
Returns:
BusinessObject a client-side business object

newBusinessObject

public ProjectSpendingPlan newBusinessObject(Session session,
                                             ObjectId objectId)
                                      throws BusinessObjectException
Description copied from interface: BOHelper
Creates a new client-side instance of this type of business object and sets its unique ID.

Specified by:
newBusinessObject in interface BOHelper<ProjectSpendingPlan>
Specified by:
newBusinessObject in class BOHelperImpl<ProjectSpendingPlan>
Parameters:
session - the current session
objectId - the ObjectId of the business object
Returns:
BusinessObject a client-side business object
Throws:
BusinessObjectException - if the object could not be created

createBusinessObjectArray

public ProjectSpendingPlan[] createBusinessObjectArray(int iSize)
Description copied from interface: BOHelper
Creates an array of a particular business object type. The returned array is of the specified size, but each index contains null.

Specified by:
createBusinessObjectArray in interface BOHelper<ProjectSpendingPlan>
Specified by:
createBusinessObjectArray in class BOHelperImpl<ProjectSpendingPlan>
Parameters:
iSize - the size of the array
Returns:
BusinessObject[] a business object array, initialized to this specific type

load

public BOIterator<ProjectSpendingPlan> load(Session session,
                                            java.lang.String[] fields,
                                            java.lang.String sWhereClause,
                                            java.lang.String sOrderBy,
                                            com.primavera.bo.common.PRequestOptions options,
                                            com.primavera.bo.base.RemoteTXId txId)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
An internal load method that should not be called directly from client code.

Specified by:
load in interface InternalBOHelper<ProjectSpendingPlan>
Parameters:
session - the Session object
fields - fields to load
sWhereClause - the where clause
sOrderBy - the order by clause
options - an internal parameter
txId - an internal key
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

load

public BOIterator<ProjectSpendingPlan> load(Session session,
                                            java.lang.String[] fields,
                                            ObjectId[] objIds,
                                            com.primavera.bo.common.PRequestOptions options,
                                            com.primavera.bo.base.RemoteTXId txId)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
An internal load method that should not be called directly from client code.

Specified by:
load in interface InternalBOHelper<ProjectSpendingPlan>
Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the business objects
options - an internal parameter
txId - an internal key
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

create

public ObjectId[] create(Session session,
                         java.util.List alObjects)
                  throws ServerException,
                         NetworkException,
                         BusinessObjectException
Description copied from interface: BOHelper
Creates multiple business objects of this type in the database.

Specified by:
create in interface BOHelper<ProjectSpendingPlan>
Specified by:
create in class BOHelperImpl<ProjectSpendingPlan>
Parameters:
session - the current session
alObjects - a list of objects to be created, all of this type
Returns:
ObjectId[] the array of unique IDs of newly created business 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 BOIterator<ProjectSpendingPlan> load(Session session,
                                            BusinessObject boParent,
                                            java.lang.String[] fields,
                                            java.lang.String sWhereClause,
                                            java.lang.String sOrderBy)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
Description copied from interface: BOHelper
Loads business objects of this type from a given parent.

Specified by:
load in interface BOHelper<ProjectSpendingPlan>
Specified by:
load in class BOHelperImpl<ProjectSpendingPlan>
Parameters:
session - the current session
boParent - the parent business object
fields - the fields to load
sWhereClause - the where clause
sOrderBy - the 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

load

public BOIterator<ProjectSpendingPlan> load(Session session,
                                            BusinessObject boParent,
                                            java.lang.String[] fields,
                                            java.lang.String sWhereClause,
                                            java.lang.String sOrderBy,
                                            com.primavera.bo.common.PRequestOptions options,
                                            com.primavera.bo.base.RemoteTXId txId)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
An internal load method that should not be called directly from client code.

Specified by:
load in interface InternalBOHelper<ProjectSpendingPlan>
Parameters:
session - the current session
boParent - the parent business object
fields - the fields to load
sWhereClause - the where clause
sOrderBy - the order by clause
txId - an internal key
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

load

public BOIterator<ProjectSpendingPlan> load(Session session,
                                            java.lang.String[] fields,
                                            ObjectId[] objIds)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
Description copied from interface: BOHelper
Loads multiple business objects of this type by ObjectId.

Specified by:
load in interface BOHelper<ProjectSpendingPlan>
Specified by:
load in class BOHelperImpl<ProjectSpendingPlan>
Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the business 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

load

public ProjectSpendingPlan load(Session session,
                                java.lang.String[] fields,
                                ObjectId objId)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Description copied from interface: BOHelper
Loads a business object of this type by ObjectId.

Specified by:
load in interface BOHelper<ProjectSpendingPlan>
Specified by:
load in class BOHelperImpl<ProjectSpendingPlan>
Parameters:
session - the Session object
fields - fields to load
objId - object id of the business object
Returns:
BusinessObject business object of the type
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(Session session,
                   java.util.List alObjects)
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Description copied from interface: BOHelper
Updates business objects of this type.

Specified by:
update in interface BOHelper<ProjectSpendingPlan>
Specified by:
update in class BOHelperImpl<ProjectSpendingPlan>
Parameters:
session - the current session
alObjects - a list of objects to update, all of this type
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(Session session,
                   java.util.List alObjects)
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Description copied from interface: BOHelper
Deletes business objects of this type.

Specified by:
delete in interface BOHelper<ProjectSpendingPlan>
Specified by:
delete in class BOHelperImpl<ProjectSpendingPlan>
Parameters:
session - the current session
alObjects - a list of objects to delete, all of this type
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(Session session,
                   java.util.List alObjects,
                   ObjectId replacementParent)
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Description copied from interface: BOHelper
Deletes business objects of this type, specifying a replacement parent

Specified by:
delete in interface BOHelper<ProjectSpendingPlan>
Specified by:
delete in class BOHelperImpl<ProjectSpendingPlan>
Parameters:
session - the current session
alObjects - a list of objects to delete, all of this type
replacementParent - replacement parent 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

Primavera Integration API 7.0

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