OptimalTrace
5.2

com.compuware.optimaltrace.framework.business
Interface PersistentIfc

All Known Subinterfaces:
AbstractRequirementIfc, AbstractStepIfc, AlternativeScenarioIfc, BizObjectIfc, com.compuware.optimaltrace.tools.common.bizobjectslocal.ClearableSuspectLinkIfc, CustomPropertyTemplateIfc, CustomPropertyTemplateListIfc, GoalLevelIfc, GoalLevelsIfc, ItemIfc, ItemListIfc, MainSuccessScenarioIfc, ProjectIfc, RefinementIfc, ScenarioIfc, SimpleRequirementIfc, StepIfc, TableHolderListContainerIfc, ToolSettingsIfc, UseCaseIfc, UseCasePackageIfc
All Known Implementing Classes:
com.compuware.optimaltrace.framework.business.AbstractBizObject, com.compuware.optimaltrace.tools.common.bizobjects.AbstractStep, ProjectContainer, Step

public interface PersistentIfc

Interface PersistentIfc


Method Summary
 java.lang.Object[][] customPropertiesToDocArray()
          Gets the custom properties as the document array.
 java.util.List getChildDocPersistObjects()
          Gets the child document persist objects.
 java.lang.Object[][] toDocArray()
          Gets the document array.
 void toSQL(java.sql.Connection con)
          Persists an object to a database using the given connection.
 

Method Detail

toDocArray

java.lang.Object[][] toDocArray()
Gets the document array.

Returns:
Object[] Two dimensional array representing the values needed for generating the document

customPropertiesToDocArray

java.lang.Object[][] customPropertiesToDocArray()
Gets the custom properties as the document array. This function will default to returning null or an empty array, and is only implemented by those BizOBject types that have custom properties. We need 2 separate arrays because the custom properties can't re-use the normal docArray, as they can be called things like 'Name' which breaks the existing system.

Returns:
Object[] a 2d array representing the custom properties of the Bizobject

getChildDocPersistObjects

java.util.List getChildDocPersistObjects()
Gets the child document persist objects. This returns the child objects that this object takes care of when persisting itself to a Word Doc. For speed reasons, certain objects (e.g. Use Cases) have to send over some of their children at the same time. Most other BizObjects will just return .

Returns:
List, the child objects in question.

toSQL

void toSQL(java.sql.Connection con)
           throws java.sql.SQLException
Persists an object to a database using the given connection. It's expected that the caller creates the connection and cleans up any resources on the connection.

Parameters:
con -
Throws:
java.sql.SQLException

OptimalTrace
5.2

Compuware Corporation

OptimalTrace is a trademark or registered trademark of Compuware Corporation in the US and other countries.
Copyright 2008-2009 Compuware Corporation. One Campus Martius,
Detroit, Michigan, 48226, U.S.A. All Rights Reserved.