sapphire.stability

Class PlanItem

java.lang.Object

sapphire.stability.PlanItem

All Implemented Interfaces:

StabilityConstants

public class PlanItem
extends java.lang.Object
implements StabilityConstants

The Planitem public API manages the details of a Planitem in the Scheduleplan.

Example:

Create Schedule Grid:

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

Get PlanItemList from scheduleGrid object:

PlanItemList planItemList = scheduleGrid.getPlanItemList();

Get PlanItem object:

ArrayList planitems = planItemList.findByCondition( conditionid );
ArrayList planitems = planItemList.findByTimepoint( timepointid );
PlanItem planItem = planitems.get( 0 );

Then use the following methods to manage the details of a Planitem.

planItem.setPropertyList( PropertyList propertyList )
planItem.setProtocolPlanId( String protocolPlanId )
planItem.setProtocolPlanItemId( String protocolPlanItemId )
planItem.deleteWorkItemByInstance( String workitemid, int workitemInstance )
planItem.addWorkItem( String workitemId )
planItem.addAttribute( String workitemid, String workiteminstance, String attributeid, String attributeinstance, String attributevalue )
planItem.editAttribute( String workitemid, String workiteminstance, String attributeid, String attributeinstance, String attributevalue )
planItem.deleteAttribute( String workitemid, String workiteminstance, String attributeid, String attributeinstance )

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
PlanItem(ScheduleGrid grid, com.labvantage.sapphire.stability.PlanItem planItem)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String workitemid, java.lang.String workiteminstance, java.lang.String attributeid, java.lang.String attributeinstance, java.lang.String attributevalue)
PlanItemWorkItem	addWorkItem(java.lang.String workitemId)
com.labvantage.sapphire.stability.PlanItem	dangerouslyGetPlanItem()
void	deleteAttribute(java.lang.String workitemid, java.lang.String workiteminstance, java.lang.String attributeid, java.lang.String attributeinstance)
void	deleteWorkItemByInstance(java.lang.String workitemid, int workitemInstance)
void	editAttribute(java.lang.String workitemid, java.lang.String workiteminstance, java.lang.String attributeid, java.lang.String attributeinstance, java.lang.String attributevalue)
java.lang.String	getConditionId()
java.lang.String	getEventStatus()
java.lang.String	getPlanItemId()
PlanItemWorkItemList	getPlanItemWorkitemList()
PropertyList	getPropertyList() Gets a COPY of the task properties for the planitem.
PropertyList	getPropertyList(boolean collapseAncestors) Gets a COPY of the task properties for the planitem.
java.lang.String	getPropertyTreeId()
java.lang.String	getProtocolPlanId()
java.lang.String	getProtocolPlanItemId()
java.lang.String	getSchedulePlanId()
java.lang.String	getStatus()
java.lang.String	getTimepointId()
PlanItemWorkItem	getWorkItem(java.lang.String workitemId)
PlanItemWorkItem	getWorkItemByInstance(java.lang.String workitemId, int workitemInstance)
boolean	isReadOnly()
void	setConditionId(java.lang.String conditionId)
void	setPropertyList(PropertyList propertyList) Sets the task properties for the planitem Note that if any collectionitem is missing an internal-id or sequence number, this method will fill those in
void	setProtocolPlanId(java.lang.String protocolPlanId)
void	setProtocolPlanItemId(java.lang.String protocolPlanItemId)
void	setTimepointId(java.lang.String timepointId)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanItem

public PlanItem(ScheduleGrid grid,
                com.labvantage.sapphire.stability.PlanItem planItem)

Parameters:

grid -

planItem -

Method Detail

dangerouslyGetPlanItem

public com.labvantage.sapphire.stability.PlanItem dangerouslyGetPlanItem()

Returns:

getPropertyList

public PropertyList getPropertyList()

Gets a COPY of the task properties for the planitem. IMPORTANT: Any changes to the returned PropertyList will NOT be honored by the API until the setPropertyList() method is called.

Returns:

the task properties

Throws:

SapphireException

getPropertyList

public PropertyList getPropertyList(boolean collapseAncestors)

Gets a COPY of the task properties for the planitem. IMPORTANT: if not collapsing ancestors, any changes to the returned PropertyList will NOT be honored by the API until the setPropertyList() method is called.

Parameters:

collapseAncestors - whether to include all properties including those from the condition, plan and above.

Returns:

the task properties

Throws:

SapphireException

setPropertyList

public void setPropertyList(PropertyList propertyList)
                     throws SapphireException

Sets the task properties for the planitem Note that if any collectionitem is missing an internal-id or sequence number, this method will fill those in

Parameters:

propertyList - The task properties

Throws:

SapphireException

getPlanItemId

public java.lang.String getPlanItemId()

Returns:

getStatus

public java.lang.String getStatus()

Returns:

getEventStatus

public java.lang.String getEventStatus()

Returns:

isReadOnly

public boolean isReadOnly()

Returns:

getTimepointId

public java.lang.String getTimepointId()

Returns:

setTimepointId

public void setTimepointId(java.lang.String timepointId)

getConditionId

public java.lang.String getConditionId()

Returns:

setConditionId

public void setConditionId(java.lang.String conditionId)

getPropertyTreeId

public java.lang.String getPropertyTreeId()

Returns:

getProtocolPlanId

public java.lang.String getProtocolPlanId()

Returns:

setProtocolPlanId

public void setProtocolPlanId(java.lang.String protocolPlanId)

Parameters:

protocolPlanId -

getProtocolPlanItemId

public java.lang.String getProtocolPlanItemId()

Returns:

setProtocolPlanItemId

public void setProtocolPlanItemId(java.lang.String protocolPlanItemId)

Parameters:

protocolPlanItemId -

getSchedulePlanId

public java.lang.String getSchedulePlanId()

Returns:

addWorkItem

public PlanItemWorkItem addWorkItem(java.lang.String workitemId)

Parameters:

workitemId -

Returns:

getWorkItemByInstance

public PlanItemWorkItem getWorkItemByInstance(java.lang.String workitemId,
                                              int workitemInstance)

Parameters:

workitemId -

workitemInstance -

Returns:

getWorkItem

public PlanItemWorkItem getWorkItem(java.lang.String workitemId)

Parameters:

workitemId -

Returns:

deleteWorkItemByInstance

public void deleteWorkItemByInstance(java.lang.String workitemid,
                                     int workitemInstance)

Parameters:

workitemid -

workitemInstance -

addAttribute

public void addAttribute(java.lang.String workitemid,
                         java.lang.String workiteminstance,
                         java.lang.String attributeid,
                         java.lang.String attributeinstance,
                         java.lang.String attributevalue)
                  throws SapphireException

Parameters:

workitemid -

workiteminstance -

attributeid -

attributeinstance -

attributevalue -

Throws:

SapphireException

editAttribute

public void editAttribute(java.lang.String workitemid,
                          java.lang.String workiteminstance,
                          java.lang.String attributeid,
                          java.lang.String attributeinstance,
                          java.lang.String attributevalue)
                   throws SapphireException

Parameters:

workitemid -

workiteminstance -

attributeid -

attributeinstance -

attributevalue -

Throws:

SapphireException

deleteAttribute

public void deleteAttribute(java.lang.String workitemid,
                            java.lang.String workiteminstance,
                            java.lang.String attributeid,
                            java.lang.String attributeinstance)
                     throws SapphireException

Parameters:

workitemid -

workiteminstance -

attributeid -

attributeinstance -

Throws:

SapphireException

getPlanItemWorkitemList

public PlanItemWorkItemList getPlanItemWorkitemList()

Returns: