|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOHelperBase
com.primavera.integration.client.bo.BOHelperImpl<CostAccount>
com.primavera.integration.client.bo.helper.CostAccountHelper
public class CostAccountHelper
Business object helper class used to simplify access to CostAccount objects.
Method Summary | |
---|---|
ObjectId[] |
create(Session session,
java.util.List alObjects)
Creates multiple business objects of this type in the database. |
CostAccount[] |
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<CostAccount> |
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<CostAccount> |
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. |
CostAccount |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a business object of this type by ObjectId. |
BOIterator<CostAccount> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple business objects of this type by ObjectId. |
BOIterator<CostAccount> |
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<CostAccount> |
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. |
CostAccount |
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. |
CostAccount |
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 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 |
Method Detail |
---|
public java.lang.String[] getRequiredCreateFields()
BOHelper
getRequiredCreateFields
in interface BOHelper<CostAccount>
getRequiredCreateFields
in class BOHelperImpl<CostAccount>
public java.lang.String[] getAllFields()
BOHelper
getAllFields
in interface BOHelper<CostAccount>
getAllFields
in class BOHelperImpl<CostAccount>
public java.lang.String[] getFilterableFields()
BOHelper
getFilterableFields
in interface BOHelper<CostAccount>
getFilterableFields
in class BOHelperImpl<CostAccount>
public java.lang.String[] getWritableFields()
BOHelper
getWritableFields
in interface BOHelper<CostAccount>
getWritableFields
in class BOHelperImpl<CostAccount>
public java.lang.String[] getInternalDefaultLoadFields()
getInternalDefaultLoadFields
in interface InternalBOHelper<CostAccount>
getInternalDefaultLoadFields
in class BOHelperImpl<CostAccount>
public java.lang.String[] getMinimumXMLExportFields()
BOHelper
getMinimumXMLExportFields
in interface BOHelper<CostAccount>
getMinimumXMLExportFields
in class BOHelperImpl<CostAccount>
public java.lang.String[] getMainFields()
BOHelper
getMainFields
in interface BOHelper<CostAccount>
getMainFields
in class BOHelperImpl<CostAccount>
public CostAccount newBusinessObject(Session session)
BOHelper
newBusinessObject
in interface BOHelper<CostAccount>
newBusinessObject
in class BOHelperImpl<CostAccount>
session
- the current session
public CostAccount newBusinessObject(Session session, ObjectId objectId) throws BusinessObjectException
BOHelper
newBusinessObject
in interface BOHelper<CostAccount>
newBusinessObject
in class BOHelperImpl<CostAccount>
session
- the current sessionobjectId
- the ObjectId of the business object
BusinessObjectException
- if the object could not be createdpublic CostAccount[] createBusinessObjectArray(int iSize)
BOHelper
createBusinessObjectArray
in interface BOHelper<CostAccount>
createBusinessObjectArray
in class BOHelperImpl<CostAccount>
iSize
- the size of the array
public BOIterator<CostAccount> 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
load
in interface InternalBOHelper<CostAccount>
session
- the Session objectfields
- fields to loadsWhereClause
- the where clausesOrderBy
- the order by clauseoptions
- an internal parametertxId
- an internal key
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 objectspublic BOIterator<CostAccount> 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
load
in interface InternalBOHelper<CostAccount>
session
- the Session objectfields
- fields to loadobjIds
- object ids of the business objectsoptions
- an internal parametertxId
- an internal key
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 objectspublic ObjectId[] create(Session session, java.util.List alObjects) throws ServerException, NetworkException, BusinessObjectException
BOHelper
create
in interface BOHelper<CostAccount>
create
in class BOHelperImpl<CostAccount>
session
- the current sessionalObjects
- a list of objects to be created, all of this type
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 objectspublic BOIterator<CostAccount> load(Session session, BusinessObject boParent, java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
BOHelper
load
in interface BOHelper<CostAccount>
load
in class BOHelperImpl<CostAccount>
session
- the current sessionboParent
- the parent business objectfields
- the fields to loadsWhereClause
- the where clausesOrderBy
- the order by clause
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 objectspublic BOIterator<CostAccount> 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
load
in interface InternalBOHelper<CostAccount>
session
- the current sessionboParent
- the parent business objectfields
- the fields to loadsWhereClause
- the where clausesOrderBy
- the order by clausetxId
- an internal key
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 objectspublic BOIterator<CostAccount> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
BOHelper
load
in interface BOHelper<CostAccount>
load
in class BOHelperImpl<CostAccount>
session
- the Session objectfields
- fields to loadobjIds
- object ids of the business objects
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 objectspublic CostAccount load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
BOHelper
load
in interface BOHelper<CostAccount>
load
in class BOHelperImpl<CostAccount>
session
- the Session objectfields
- fields to loadobjId
- object id of the business object
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 objectspublic void update(Session session, java.util.List alObjects) throws ServerException, NetworkException, BusinessObjectException
BOHelper
update
in interface BOHelper<CostAccount>
update
in class BOHelperImpl<CostAccount>
session
- the current sessionalObjects
- a list of objects to update, all of this type
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 objectspublic void delete(Session session, java.util.List alObjects) throws ServerException, NetworkException, BusinessObjectException
BOHelper
delete
in interface BOHelper<CostAccount>
delete
in class BOHelperImpl<CostAccount>
session
- the current sessionalObjects
- a list of objects to delete, all of this type
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 objectspublic void delete(Session session, java.util.List alObjects, ObjectId replacementParent) throws ServerException, NetworkException, BusinessObjectException
BOHelper
delete
in interface BOHelper<CostAccount>
delete
in class BOHelperImpl<CostAccount>
session
- the current sessionalObjects
- a list of objects to delete, all of this typereplacementParent
- replacement parent object
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 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |