sapphire.stability

Class Workitem

java.lang.Object

sapphire.stability.Workitem

All Implemented Interfaces:

StabilityConstants

Direct Known Subclasses:

PlanItemWorkItem, PlanWorkItem

public class Workitem
extends java.lang.Object
implements StabilityConstants

This class represents workitems.

Example:

Adding workitems into plan.

• ScheduleGridFactory factory = new ScheduleGridFactory( getConnectionid() );
• ScheduleGrid plan = factory.createPlanTemplateFromScratch( "test_PlanTemp1", "Test SchedulePlan Template" );
• PlanWorkItemList planWorkItemList = plan.getPlanWorkItemList();
• PlanWorkItem planWorkItem1 = planWorkItemList.addWorkItem( workitem1, workitem1Ver );
• planWorkItem1.setQuantity( 5 );
• planWorkItem1.setQuantityUnit( UNIT_ML );

Field Summary

Fields

Modifier and Type	Field and Description
DataStore	item
int	row

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
Workitem(DataStore item, int row)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDepartmentId() Retrieves the department ID of the plan item work item.
java.lang.String	getDueDateOffset() Retrieves the due date offset for the plan item work item.
java.lang.String	getDueDateOffsetUnit() Retrieves the due date offset unit of the plan item work item.
java.lang.String	getNumRepeats() Retrieves the number of repeats for the plan item work item.
java.lang.String	getPlanId() Retrieves the plan ID of the current work item.
java.lang.String	getQuantity() Retrieves the quantity of the plan work item at the specified row.
java.lang.String	getQuantityUnit() Returns the quantity unit of the plan item work item.
java.lang.String	getQuantityUnitType() Returns the quantity unit type of the plan item work item.
java.lang.String	getWorkItemId() Retrieves the work item ID of the current work item.
int	getWorkItemInstance() Retrieves the work item instance of the current work item.
java.lang.String	getWorkItemVersionId() Retrieves the work item version ID of the current work item.
boolean	isContainerPerRepeat() Returns true if the container per repeat flag is set for the plan item work item, false otherwise.
boolean	isContainerPerTest() Returns true if the container per test flag is set for the plan item work item, false otherwise.
boolean	isContingent() Checks if the plan item work item is contingent.
boolean	isDestructiveTest() Checks if the destructive test flag is set for the plan item work item.
boolean	isReuseContainer() Checks if the reuse container flag is set for the plan item work item.
void	setContainerPerRepeat(boolean flag) Sets the container per repeat flag for the plan item work item.
void	setContainerPerTest(boolean flag) Sets the container per test flag for the plan item work item.
void	setContingent(boolean flag) Sets the contingent flag for the plan item work item.
void	setDepartmentId(java.lang.String departmentId) Sets the department ID for the plan item work item.
void	setDestructiveTest(boolean flag) Sets the destructive test flag for the plan item work item.
void	setDueDateOffset(double offset) Sets the due date offset for the plan item work item.
void	setDueDateOffsetUnit(java.lang.String unit) Sets the due date offset unit for the plan item work item.
void	setNumRepeats(int numRepeats) Sets the number of repeats for the plan item work item.
void	setQuantity(double quantity) Sets the quantity of the plan item work item.
void	setQuantityUnit(java.lang.String unit) Sets the quantity unit of the plan item work item.
void	setReuseContainer(boolean flag) Sets the reuse container flag for the plan item work item.

Methods inherited from class java.lang.Object

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

Field Detail

item

public DataStore item

row

public int row

Constructor Detail

Workitem

public Workitem(DataStore item,
                int row)

Method Detail

getPlanId

public java.lang.String getPlanId()

Retrieves the plan ID of the current work item.

Returns:

The plan ID as a String.

getWorkItemId

public java.lang.String getWorkItemId()

Retrieves the work item ID of the current work item.

Returns:

The work item ID as a String.

getWorkItemVersionId

public java.lang.String getWorkItemVersionId()

Retrieves the work item version ID of the current work item.

Returns:

The work item version ID as a String.

getWorkItemInstance

public int getWorkItemInstance()

Retrieves the work item instance of the current work item.

Returns:

The work item instance as an integer.

setQuantity

public void setQuantity(double quantity)

Sets the quantity of the plan item work item.

Parameters:

quantity - The quantity to be set for the plan item work item.

getQuantity

public java.lang.String getQuantity()

Retrieves the quantity of the plan work item at the specified row.

Returns:

the quantity of the plan work item as a string

setQuantityUnit

public void setQuantityUnit(java.lang.String unit)

Sets the quantity unit of the plan item work item.

Parameters:

unit - the quantity unit to be set

getQuantityUnit

public java.lang.String getQuantityUnit()

Returns the quantity unit of the plan item work item.

Returns:

The quantity unit of the plan item work item.

getQuantityUnitType

public java.lang.String getQuantityUnitType()

Returns the quantity unit type of the plan item work item.

Returns:

The quantity unit type of the plan item work item.

setNumRepeats

public void setNumRepeats(int numRepeats)

Sets the number of repeats for the plan item work item.

Parameters:

numRepeats - the number of repeats to be set

getNumRepeats

public java.lang.String getNumRepeats()

Retrieves the number of repeats for the plan item work item.

Returns:

The number of repeats for the plan item work item.

setContainerPerRepeat

public void setContainerPerRepeat(boolean flag)

Sets the container per repeat flag for the plan item work item.

Parameters:

flag - the flag value to be set. If true, the container is per repeat, otherwise it is not.

Throws:

java.lang.IllegalArgumentException - if the flag is null

isContainerPerRepeat

public boolean isContainerPerRepeat()

Returns true if the container per repeat flag is set for the plan item work item, false otherwise.

Returns:

True if the container per repeat flag is set, false otherwise.

setContainerPerTest

public void setContainerPerTest(boolean flag)

Sets the container per test flag for the plan item work item.

Parameters:

flag - the flag value to be set. If true, the container is per test, otherwise it is not.

Throws:

java.lang.IllegalArgumentException - if the flag is null

isContainerPerTest

public boolean isContainerPerTest()

Returns true if the container per test flag is set for the plan item work item, false otherwise.

Returns:

True if the container per test flag is set, false otherwise.

setDestructiveTest

public void setDestructiveTest(boolean flag)

Sets the destructive test flag for the plan item work item.

Parameters:

flag - the flag value to be set. If true, the destructive test flag is set to "Y", otherwise it is set to "N".

isDestructiveTest

public boolean isDestructiveTest()

Checks if the destructive test flag is set for the plan item work item.

Returns:

true if the destructive test flag is set to "Y", false otherwise.

setReuseContainer

public void setReuseContainer(boolean flag)

Sets the reuse container flag for the plan item work item.

Parameters:

flag - the flag value to be set. If true, the reuse container flag is set to "Y", otherwise it is set to "N".

isReuseContainer

public boolean isReuseContainer()

Checks if the reuse container flag is set for the plan item work item.

Returns:

true if the reuse container flag is set to "Y", false otherwise.

setContingent

public void setContingent(boolean flag)

Sets the contingent flag for the plan item work item.

Parameters:

flag - the flag value to be set. If true, the contingent flag is set to "Y", otherwise it is set to "N".

isContingent

public boolean isContingent()

Checks if the plan item work item is contingent.

Returns:

true if the contingent flag is set to "Y", false otherwise

setDepartmentId

public void setDepartmentId(java.lang.String departmentId)

Sets the department ID for the plan item work item.

Parameters:

departmentId - the department ID to be set for the plan item work item

getDepartmentId

public java.lang.String getDepartmentId()

Retrieves the department ID of the plan item work item.

Returns:

The department ID of the plan item work item.

setDueDateOffset

public void setDueDateOffset(double offset)

Sets the due date offset for the plan item work item.

Parameters:

offset - the offset value to set the due date offset

getDueDateOffset

public java.lang.String getDueDateOffset()

Retrieves the due date offset for the plan item work item.

Returns:

The due date offset of the plan item work item as a String.

setDueDateOffsetUnit

public void setDueDateOffsetUnit(java.lang.String unit)

Sets the due date offset unit for the plan item work item.

Parameters:

unit - the due date offset unit to be set

getDueDateOffsetUnit

public java.lang.String getDueDateOffsetUnit()

Retrieves the due date offset unit of the plan item work item.

Returns:

The due date offset unit of the plan item work item.