sapphire.stability

Class PlanItemList

java.lang.Object

sapphire.stability.PlanItemList

All Implemented Interfaces:

StabilityConstants

public class PlanItemList
extends java.lang.Object
implements StabilityConstants

The Planitemlist manages the list of Planitems in the Scheduleplan.

Example:

Create Schedule Grid:

ScheduleGrid scheduleGrid = new ScheduleGrid( getConnectionid() );
grid.retrieve( planid );

Get PlanItemList from scheduleGrid object:

PlanItemList planItemList = scheduleGrid.getPlanItemList();

Then use the following methods to manage the list of Planitems.

planItemList.addPlanItem( String timepointid, String conditionid, String propertytreeid, PropertyList propertyList, String status )
planItemList.deletePlanItem( String planitemidlist )
planItemList.deleteConditionItems( String conditionid )
planItemList.deleteTimepointItems( String timepointid )
etc...

Field Summary

Fields inherited from interface sapphire.stability.StabilityConstants

ADVANCEDPULLSAMPLE_ASSIGNDEPARTMENT, ADVANCEDPULLSAMPLE_ASSIGNTO, ADVANCEDPULLSAMPLE_COLUMNVALUES, ADVANCEDPULLSAMPLE_COPIES, ADVANCEDPULLSAMPLE_CREATE, ADVANCEDPULLSAMPLE_CREATEDDISTINCTLABORATORYSAMPLES, ADVANCEDPULLSAMPLE_CREATEMULTIPLEREUSETESTINGSAMPLE, ADVANCEDPULLSAMPLE_CREATESDI, ADVANCEDPULLSAMPLE_CREATEUNIQUESAMPLEPERCONTAINER, ADVANCEDPULLSAMPLE_DEFERSAMPLECREATION, ADVANCEDPULLSAMPLE_DEVIATION, ADVANCEDPULLSAMPLE_DEVIATIONFLAG, ADVANCEDPULLSAMPLE_EARLYGRACEPERIOD, ADVANCEDPULLSAMPLE_GRACEPERIOD, ADVANCEDPULLSAMPLE_GRACEPERIODDETAILS, ADVANCEDPULLSAMPLE_GRACEPERIODUNIT, ADVANCEDPULLSAMPLE_GRCPERIOD, ADVANCEDPULLSAMPLE_INCIDENTTEMPLATE, ADVANCEDPULLSAMPLE_MESSAGE, ADVANCEDPULLSAMPLE_MULTIPLYQTYBYSAMPLECOUNT, ADVANCEDPULLSAMPLE_PULLAMOUNT, ADVANCEDPULLSAMPLE_QUANTITY, ADVANCEDPULLSAMPLE_SPECS, ADVANCEDPULLSAMPLE_TEMPLATEID, ADVANCEDPULLSAMPLE_UNITS, ADVANCEDPULLSAMPLE_WORKITEMS, ADVANCEDPULLSAMPLE_WORKORDER, CONDITION_COLUMNLABELS, CONDITION_COLUMNS, DAY, EVENT_STATUS_CANCELLED, EVENT_STATUS_DONE, EVENT_STATUS_ERROR, EVENT_STATUS_ERRORACKNOWLEDGED, EVENT_STATUS_SCHEDULED, EXECUTEAHEADUNIT_DAY, EXECUTEAHEADUNIT_MONTH, EXECUTEAHEADUNIT_WEEK, EXECUTEAHEADUNIT_YEAR, FROM_WHEN, GRACE_PERIOD_UNIT, HOUR, ITEM_CONDITIONS, ITEM_PLANITEMWORKITEMS, ITEM_PLANWORKITEMS, ITEM_TIMEPOINTS, MONTH, ORIENTATION_INVERTED, ORIENTATION_UPRIGHT, PLANITEM_ROWSTATUS_DELETE, PLANITEM_ROWSTATUS_INSERT, PLANITEM_ROWSTATUS_RETRIEVE, PLANITEM_ROWSTATUS_UPDATE, PLANITEM_STATUS_DISABLED, PLANITEMWORKITEM_SCHEDULEPLANITEMID, PLANTYPE_PROTOCOL, PLANTYPE_STUDY, PLANTYPE_TEMPLATE, PLANWORKITEM_COLUMNLABELS, PLANWORKITEM_COLUMNS, PLANWORKITEM_CONTAINERPERREPEATFLAG, PLANWORKITEM_CONTAINERPERTESTFLAG, PLANWORKITEM_CONTINGENTFLAG, PLANWORKITEM_DEPARTMENTID, PLANWORKITEM_DESTRUCTIVETESTFLAG, PLANWORKITEM_DUEDTOFFSET, PLANWORKITEM_DUEDTOFFSETTIMEUNIT, PLANWORKITEM_NUMREPEATS, PLANWORKITEM_QUANTITY, PLANWORKITEM_QUANTITYTYPE, PLANWORKITEM_QUANTITYUNIT, PLANWORKITEM_REUSECONTAINERFLAG, PLANWORKITEM_SCHEDULEPLANID, PLANWORKITEM_WORKITEMID, PLANWORKITEM_WORKITEMINSTANCE, PLANWORKITEM_WORKITEMVERSIONID, SCHEDULECONDITIONID, SCHEDULEPLANID, SCHEDULETIMEPOINTID, SDC_LV_SCHEDULECONDITION, SDC_PROTOCOLSDC, SDC_SCHEDULEPLAN, SDC_SCHEDULEPLANITEM, SDC_SDIWORKITEM, SDC_STORAGEENVSDC, SDC_STUDYSDC, STABILITYTASK_ADVANCEDPULLSAMPLE, STABILITYTASK_CREATEWORKORDER, STABILITYTASK_DISPOSE, STABILITYTASK_MOVE, STABILITYTASK_PULLSAMPLE, STABILITYTASK_SHAKE, STUDY_STATUS_ACTIVE, STUDY_STATUS_CANCELLED, STUDY_STATUS_COMPLETED, STUDY_STATUS_NOTSTARTED, STUDY_STATUS_PENDINGAPPROVAL, STUDY_STATUS_REJECT, STUDY_STATUS_REQUESTDRAFT, STUDY_STATUS_SUSPENDED, TIMEPOINT_COLUMNLABELS, TIMEPOINT_COLUMNS, TIMEUNIT_DAY, TIMEUNIT_HOUR, TIMEUNIT_MONTH, TIMEUNIT_WEEK, TIMEUNIT_YEAR, VALIDEXECUTEAHEADUNIT, VALIDORIENTATION, VALIDSTARTCRITERIA, VALIDTIMEUNITUNIT, WEEK, YEAR

Constructor Summary

Constructors

Constructor and Description
PlanItemList(ScheduleGrid grid)

Method Summary

Modifier and Type	Method and Description
PlanItem	addPlanItem(java.lang.String timepointid, java.lang.String conditionid, java.lang.String propertytreeid, PropertyList propertyList)
PlanItem	addPlanItem(java.lang.String timepointid, java.lang.String conditionid, java.lang.String propertytreeid, PropertyList propertyList, java.lang.String status)
com.labvantage.sapphire.stability.PlanItemList	dangerouslyGetPlanItemList()
void	deleteConditionItems(java.lang.String conditionid)
void	deletePlanItem(java.lang.String planitemidlist)
void	deleteTimepointItems(java.lang.String timepointid)
java.util.ArrayList<PlanItem>	findByCondition(java.lang.String conditionid)
PlanItem	findById(java.lang.String id)
PlanItem	findByProtocolPlanItemId(java.lang.String protocolid, java.lang.String protocolplanitemid)
java.util.ArrayList<PlanItem>	findByTimeConditionPropertyTree(java.lang.String timepointid, java.lang.String conditionid, java.lang.String propertyTreeid)
java.util.ArrayList<PlanItem>	findByTimepoint(java.lang.String timepointid)
java.lang.String	getActualRemainingQuantityForPlanItem(java.lang.String planitemid)
java.lang.String	getActualRemainingQuantityUnitsForPlanItem(java.lang.String planitemid)
java.lang.String	getActualRemainingQuantityUnitsTypeForPlanItem(java.lang.String planitemid)
java.util.ArrayList<PlanItem>	getAllPlanItems()
java.lang.String	getFutureQuantityForPlanItem(java.lang.String planitemid)
java.lang.String	getFutureQuantityUnitsForPlanItem(java.lang.String planitemid)
java.lang.String	getFutureQuantityUnitsTypeForPlanItem(java.lang.String planitemid)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlanItemList

public PlanItemList(ScheduleGrid grid)

Parameters:

grid -

Method Detail

dangerouslyGetPlanItemList

public com.labvantage.sapphire.stability.PlanItemList dangerouslyGetPlanItemList()

Returns:

addPlanItem

public PlanItem addPlanItem(java.lang.String timepointid,
                            java.lang.String conditionid,
                            java.lang.String propertytreeid,
                            PropertyList propertyList,
                            java.lang.String status)
                     throws SapphireException

Parameters:

timepointid -

conditionid -

propertytreeid -

propertyList -

status -

Returns:

Throws:

SapphireException

addPlanItem

public PlanItem addPlanItem(java.lang.String timepointid,
                            java.lang.String conditionid,
                            java.lang.String propertytreeid,
                            PropertyList propertyList)
                     throws SapphireException

Parameters:

timepointid -

conditionid -

propertytreeid -

propertyList -

Returns:

Throws:

SapphireException

deletePlanItem

public void deletePlanItem(java.lang.String planitemidlist)

Parameters:

planitemidlist -

deleteConditionItems

public void deleteConditionItems(java.lang.String conditionid)

Parameters:

conditionid -

deleteTimepointItems

public void deleteTimepointItems(java.lang.String timepointid)

Parameters:

timepointid -

findByTimeConditionPropertyTree

public java.util.ArrayList<PlanItem> findByTimeConditionPropertyTree(java.lang.String timepointid,
                                                                     java.lang.String conditionid,
                                                                     java.lang.String propertyTreeid)

Parameters:

timepointid -

conditionid -

propertyTreeid -

Returns:

findByTimepoint

public java.util.ArrayList<PlanItem> findByTimepoint(java.lang.String timepointid)

Parameters:

timepointid -

Returns:

findByCondition

public java.util.ArrayList<PlanItem> findByCondition(java.lang.String conditionid)

Parameters:

conditionid -

Returns:

findById

public PlanItem findById(java.lang.String id)

Parameters:

id -

Returns:

findByProtocolPlanItemId

public PlanItem findByProtocolPlanItemId(java.lang.String protocolid,
                                         java.lang.String protocolplanitemid)

Parameters:

protocolid -

protocolplanitemid -

Returns:

getFutureQuantityForPlanItem

public java.lang.String getFutureQuantityForPlanItem(java.lang.String planitemid)

Parameters:

planitemid -

Returns:

getFutureQuantityUnitsForPlanItem

public java.lang.String getFutureQuantityUnitsForPlanItem(java.lang.String planitemid)

Parameters:

planitemid -

Returns:

getFutureQuantityUnitsTypeForPlanItem

public java.lang.String getFutureQuantityUnitsTypeForPlanItem(java.lang.String planitemid)

Parameters:

planitemid -

Returns:

getActualRemainingQuantityForPlanItem

public java.lang.String getActualRemainingQuantityForPlanItem(java.lang.String planitemid)

Parameters:

planitemid -

Returns:

getActualRemainingQuantityUnitsForPlanItem

public java.lang.String getActualRemainingQuantityUnitsForPlanItem(java.lang.String planitemid)

Parameters:

planitemid -

Returns:

getActualRemainingQuantityUnitsTypeForPlanItem

public java.lang.String getActualRemainingQuantityUnitsTypeForPlanItem(java.lang.String planitemid)

Parameters:

planitemid -

Returns:

getAllPlanItems

public java.util.ArrayList<PlanItem> getAllPlanItems()

Returns: