Primavera Integration API Release 8

com.primavera.integration.client.bo
Class SpreadOptions

java.lang.Object
  extended by com.primavera.integration.client.bo.SpreadOptions
Direct Known Subclasses:
SpreadOptions.ExpenseCategorySpreadOptions, SpreadOptions.PrimarySpreadOptions, SpreadOptions.ProjectSpreadOptions, SpreadOptions.ResourceSpreadOptions, SpreadOptions.RoleSpreadOptions, SpreadOptions.WBSSpreadOptions

public abstract class SpreadOptions
extends Object

Spread Options is used to load business objects with summary data.


Nested Class Summary
static class SpreadOptions.ExpenseCategorySpreadOptions
          A SpreadOptions type to load the ExpenseCategory categorized spread on the business object
static class SpreadOptions.PrimarySpreadOptions
          A SpreadOptions type to load uncategorized spread on the business object
static class SpreadOptions.ProjectSpreadOptions
          A SpreadOptions type to load the Project categorized spread on the business object
static class SpreadOptions.ResourceSpreadOptions
          A SpreadOptions type to load the Resource categorized on the business object
static class SpreadOptions.RoleSpreadOptions
          A SpreadOptions type to load the Role categorized spread on the business object
static class SpreadOptions.WBSSpreadOptions
          A SpreadOptions type to load the WBS categorized spread on the business object
 
Method Summary
 Date getEndDate()
           
 ObjectId[] getObjectIds()
           
 SpreadPeriodType getPeriodType()
           
 String[] getSpreadFields()
           
 com.primavera.bo.base.SpreadParam getSpreadParam(com.primavera.bo.defs.BusinessObjectDef def)
           
abstract  String getSpreadPrimaryField(com.primavera.bo.defs.BusinessObjectDef def)
           
 Date getStartDate()
           
 boolean isIncludeCumulative()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getSpreadFields

public String[] getSpreadFields()

getPeriodType

public SpreadPeriodType getPeriodType()

getStartDate

public Date getStartDate()

getEndDate

public Date getEndDate()

isIncludeCumulative

public boolean isIncludeCumulative()

getObjectIds

public ObjectId[] getObjectIds()

getSpreadPrimaryField

public abstract String getSpreadPrimaryField(com.primavera.bo.defs.BusinessObjectDef def)

getSpreadParam

public com.primavera.bo.base.SpreadParam getSpreadParam(com.primavera.bo.defs.BusinessObjectDef def)
                                                 throws BusinessObjectException
Throws:
BusinessObjectException

Primavera Integration API Release 8

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