|
Primavera Integration API Release 8 | |||||||||
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<RiskMatrixScore>
com.primavera.integration.client.bo.helper.RiskMatrixScoreHelper
public class RiskMatrixScoreHelper
Business object helper class used to simplify access to RiskMatrixScore objects.
Method Summary | |
---|---|
ObjectId[] |
create(Session session,
List<? extends BusinessObject> alObjects)
Creates multiple business objects of this type in the database. |
RiskMatrixScore[] |
createBusinessObjectArray(int iSize)
Creates an array of a particular business object type. |
void |
delete(Session session,
List<? extends BusinessObject> alObjects)
Deletes business objects of this type. |
void |
delete(Session session,
List<? extends BusinessObject> alObjects,
ObjectId replacementParent)
Deletes business objects of this type, specifying a replacement parent |
String[] |
getAllFields()
Gets all non-code and non-UDF fields for this business object |
String[] |
getFilterableFields()
Gets all non-code and non-UDF fields for this business object. |
String[] |
getInternalDefaultLoadFields()
An internal method that should not be called directly by client code. |
String[] |
getMainFields()
Gets all fields that are not code, UDF, or summary fields. |
String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
String[] |
getRequiredCreateFields()
Gets all fields that are filterable. |
String[] |
getWritableFields()
Gets all writable non-code and non-UDF fields for this business object |
BOIterator<RiskMatrixScore> |
load(Session session,
BusinessObject boParent,
String[] fields,
String sWhereClause,
String sOrderBy)
Loads business objects of this type from a given parent. |
BOIterator<RiskMatrixScore> |
load(Session session,
BusinessObject boParent,
String[] fields,
String sWhereClause,
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. |
RiskMatrixScore |
load(Session session,
String[] fields,
ObjectId objId)
Loads a business object of this type by ObjectId. |
BOIterator<RiskMatrixScore> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple business objects of this type by ObjectId. |
BOIterator<RiskMatrixScore> |
load(Session session,
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<RiskMatrixScore> |
load(Session session,
String[] fields,
String sWhereClause,
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. |
RiskMatrixScore |
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. |
RiskMatrixScore |
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,
List<? extends BusinessObject> 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, getDefaultParentClassName, getDeleteAssociations, getDrivingReferences, getEnumDefaultValue, getEnumObject, getFieldType, getFillDownFields, getKeyFields, getLoadAssociations, getLoggingFieldName, getMaxFieldLength, getMaxFieldLengthMap, getNonDrivingReferences, getObjectIdFieldNames, getPluralName, getReferencedObject, getUserDefinedFieldLengthLimits, getValue, getValueAsObject, getVarCharLengths, getWSDLGroup, hasField, hasFieldValue, hasMultiPartKey, internalGetValue, internalSetValue, isAssociatedClass, isField, isFilterableField, isGlobal, isHierarchical, isNullableField, isScriptableField, isSingular, isWritableField, newBusinessObject, newBusinessObject, setRawValue, setRawValue, 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, getDefaultParentClassName, getDeleteAssociations, getFieldType, getKeyFields, getLoadAssociations, getMaxFieldLength, getObjectIdFieldNames, getPluralName, getValue, getValueAsObject, hasFieldValue, hasMultiPartKey, isAssociatedClass, isField, isFilterableField, isGlobal, isHierarchical, isScriptableField, isSingular, isWritableField, newBusinessObject, setValue, setValues, supportsCodes, supportsLiveSpreads, supportsSummarizedSreads, supportsUDF, supportsUDFCode |
Method Detail |
---|
public String[] getRequiredCreateFields()
BOHelper
getRequiredCreateFields
in interface BOHelper<RiskMatrixScore>
getRequiredCreateFields
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
public String[] getAllFields()
BOHelper
getAllFields
in interface BOHelper<RiskMatrixScore>
getAllFields
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
public String[] getFilterableFields()
BOHelper
getFilterableFields
in interface BOHelper<RiskMatrixScore>
getFilterableFields
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
public String[] getWritableFields()
BOHelper
getWritableFields
in interface BOHelper<RiskMatrixScore>
getWritableFields
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
public String[] getInternalDefaultLoadFields()
getInternalDefaultLoadFields
in interface com.primavera.integration.client.bo.InternalBOHelper<RiskMatrixScore>
getInternalDefaultLoadFields
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
public String[] getMinimumXMLExportFields()
BOHelper
getMinimumXMLExportFields
in interface BOHelper<RiskMatrixScore>
getMinimumXMLExportFields
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
public String[] getMainFields()
BOHelper
getMainFields
in interface BOHelper<RiskMatrixScore>
getMainFields
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
public RiskMatrixScore newBusinessObject(Session session)
BOHelper
newBusinessObject
in interface BOHelper<RiskMatrixScore>
newBusinessObject
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
session
- the current session
public RiskMatrixScore newBusinessObject(Session session, ObjectId objectId) throws BusinessObjectException
BOHelper
newBusinessObject
in interface BOHelper<RiskMatrixScore>
newBusinessObject
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
session
- the current sessionobjectId
- the ObjectId of the business object
BusinessObjectException
- if the object could not be createdpublic RiskMatrixScore[] createBusinessObjectArray(int iSize)
BOHelper
createBusinessObjectArray
in interface BOHelper<RiskMatrixScore>
createBusinessObjectArray
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
iSize
- the size of the array
public BOIterator<RiskMatrixScore> load(Session session, String[] fields, String sWhereClause, String sOrderBy, com.primavera.bo.common.PRequestOptions options, com.primavera.bo.base.RemoteTXId txId) throws ServerException, NetworkException, BusinessObjectException
load
in interface com.primavera.integration.client.bo.InternalBOHelper<RiskMatrixScore>
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<RiskMatrixScore> load(Session session, String[] fields, ObjectId[] objIds, com.primavera.bo.common.PRequestOptions options, com.primavera.bo.base.RemoteTXId txId) throws ServerException, NetworkException, BusinessObjectException
load
in interface com.primavera.integration.client.bo.InternalBOHelper<RiskMatrixScore>
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, List<? extends BusinessObject> alObjects) throws ServerException, NetworkException, BusinessObjectException
BOHelper
create
in interface BOHelper<RiskMatrixScore>
create
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
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<RiskMatrixScore> load(Session session, BusinessObject boParent, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
BOHelper
load
in interface BOHelper<RiskMatrixScore>
load
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
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<RiskMatrixScore> load(Session session, BusinessObject boParent, String[] fields, String sWhereClause, String sOrderBy, com.primavera.bo.common.PRequestOptions options, com.primavera.bo.base.RemoteTXId txId) throws ServerException, NetworkException, BusinessObjectException
load
in interface com.primavera.integration.client.bo.InternalBOHelper<RiskMatrixScore>
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<RiskMatrixScore> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
BOHelper
load
in interface BOHelper<RiskMatrixScore>
load
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
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 RiskMatrixScore load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
BOHelper
load
in interface BOHelper<RiskMatrixScore>
load
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
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, List<? extends BusinessObject> alObjects) throws ServerException, NetworkException, BusinessObjectException
BOHelper
update
in interface BOHelper<RiskMatrixScore>
update
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
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, List<? extends BusinessObject> alObjects) throws ServerException, NetworkException, BusinessObjectException
BOHelper
delete
in interface BOHelper<RiskMatrixScore>
delete
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
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, List<? extends BusinessObject> alObjects, ObjectId replacementParent) throws ServerException, NetworkException, BusinessObjectException
BOHelper
delete
in interface BOHelper<RiskMatrixScore>
delete
in class com.primavera.integration.client.bo.BOHelperImpl<RiskMatrixScore>
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 Release 8 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |