sapphire.stability

Class TimeAxis

java.lang.Object

sapphire.stability.TimeAxis

All Implemented Interfaces:

StabilityConstants

public class TimeAxis
extends java.lang.Object
implements StabilityConstants

The TimeAxis class is used as a wrapper class for the private TimeAxis class.

Examples:

Create Schedule Grid object:

Using ConnectionId:

ScheduleGrid grid = new ScheduleGrid( getConnectionid() );

Loading data into grid object:

grid.retrieve( planid ); // load grid data using input scheduleplanid

Get TimeAxis from scheduleGrid object:

TimeAxis timeAxis = grid.getTimeAxis();

Add Timepoint

timeAxis.addTimepoint( "1", "Hour", "1 Hour please" ); // Add Timepoint Hour

timeAxis.addTimepoint( "2", "Day", "2 Days please" ); // Add Timepoint Day

timeAxis.addTimepointsForUnit( "3 4 5 6", "Day" ); // Add Timepoint Unit

timeAxis.addTimepointRecurring( "1", "Hour", 2, "7" ); // Add Timepoint Reccuring

timeAxis.findOrAddTimepoint( "Hour 1", "1 Hour please" );

timeAxis.addTimepointAbsolute( calendar ); // Add Timepoint Absolute

Copy Timepoint

timeAxis.copyTimepoint( String.valueOf( timeAxis.getTimepointId( 0 ) ), "2", "Hour", "New 2 hours please" ); // Copy Time point

timeAxis.copyTimepointAbsolute( String.valueOf( timeAxis.getTimepointId( 0 ) ), calendar ); // Copy Timepoint Absolute

timeAxis.copyTimepointRecurring( String.valueOf( timeAxis.getTimepointId( 0 ) ), "1", "Hour", 2, "6" ); // Copy Timepoint Reccuring

timeAxis.copyTimepointForMultiples( String.valueOf( timeAxis.getTimepointId( 0 ) ), "2 3 4", "Hour" ); // Copy Timepoint For Multiples

Set Label

timeAxis.setLabel( String.valueOf( timeAxis.getTimepointId( 0 ) ), "New Label 1 Hour please" ); // setter method to save label value

Set Offset Rule

timeAxis.setOffsetRule( timeAxis.getTimepointId( 0 ), 2, "Hour" );

String ScheduleRule = timeAxis.getRule( timeAxis.getTimepointId( 0 ) );

Set Absolute Date Rule

timeAxis.setAbsoluteDateRule( timeAxis.getTimepointId( 0 ), calendar );

String ScheduleRule = timeAxis.getRule( timeAxis.getTimepointId( 0 ) );

Set Execute Ahead

timeAxis.setExecuteAhead( timeAxis.getTimepointId( 0 ), 10 );

Delete Timepoint

timeAxis.deleteTimepoint( "0" );

Get TimepointId

timeAxis.getTimepointId( 0 );

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
TimeAxis(ScheduleGrid grid, ConnectionInfo connectionInfo)

Method Summary

Modifier and Type	Method and Description
int	addItem(java.util.HashMap values)
java.lang.String	addTimepoint(java.lang.String singleNumber, java.lang.String unit, java.lang.String label)
java.lang.String	addTimepointAbsolute(java.util.Calendar date)
java.lang.String	addTimepointRecurring(java.lang.String numberValue, java.lang.String unit, int repeats, java.lang.String startingValue)
java.lang.String	addTimepointsForUnit(java.lang.String listOfNumbers, java.lang.String unit)
java.lang.String	copyTimepoint(java.lang.String fromtimepointid, java.lang.String newNumber, java.lang.String newUnit, java.lang.String newLabel)
java.lang.String	copyTimepoint(java.lang.String fromtimepointid, java.lang.String newNumber, java.lang.String newUnit, java.lang.String newLabel, boolean copyPlanItems)
java.lang.String	copyTimepointAbsolute(java.lang.String fromtimepointid, java.util.Calendar date)
java.lang.String	copyTimepointAbsolute(java.lang.String fromtimepointid, java.util.Calendar date, boolean copyPlanItems)
java.lang.String	copyTimepointForMultiples(java.lang.String fromtimepointid, java.lang.String listOfNumbers, java.lang.String unit)
java.lang.String	copyTimepointForMultiples(java.lang.String fromtimepointid, java.lang.String listOfNumbers, java.lang.String unit, boolean copyPlanItems)
java.lang.String	copyTimepointRecurring(java.lang.String fromtimepointid, java.lang.String numberValue, java.lang.String unit, int repeats, java.lang.String startingValue)
java.lang.String	copyTimepointRecurring(java.lang.String fromtimepointid, java.lang.String numberValue, java.lang.String unit, int repeats, java.lang.String startingValue, boolean copyPlanItems)
com.labvantage.sapphire.stability.TimeAxis	dangerouslyGetTimeAxis()
void	deleteTimepoint(java.lang.String timepointid)
void	editItem(int row, java.util.HashMap values)
java.lang.String	findOrAddTimepoint(java.lang.String rule, java.lang.String label)
int	findRowById(java.lang.String timepointid)
java.lang.String	findTimepointByProtocolPlanTimepointId(java.lang.String protocolPlanTimepointId)
java.lang.String	getExecuteAhead(java.lang.String timepointid)
java.lang.String	getExecuteAheadUnit(java.lang.String timepointid)
java.lang.String	getLabel(java.lang.String timepointid)
java.lang.String	getRule(java.lang.String timepointid)
DataStore	getTimeAxisItems()
java.lang.String	getTimepointId(int row)
boolean	isTimepointReadOnly(java.lang.String timepointid)
void	setAbsoluteDateRule(java.lang.String timepointid, java.util.Calendar date)
void	setExecuteAhead(java.lang.String timepointid, double executeahead)
void	setExecuteAheadUnit(java.lang.String timepointid, java.lang.String unit)
void	setLabel(java.lang.String timepointid, java.lang.String label)
void	setOffsetRule(java.lang.String timepointid, double number, java.lang.String unit)
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeAxis

public TimeAxis(ScheduleGrid grid,
                ConnectionInfo connectionInfo)

Parameters:

grid -

connectionInfo -

Method Detail

dangerouslyGetTimeAxis

public com.labvantage.sapphire.stability.TimeAxis dangerouslyGetTimeAxis()

Returns:

addTimepoint

public java.lang.String addTimepoint(java.lang.String singleNumber,
                                     java.lang.String unit,
                                     java.lang.String label)

Parameters:

singleNumber -

unit -

label -

Returns:

addTimepointsForUnit

public java.lang.String addTimepointsForUnit(java.lang.String listOfNumbers,
                                             java.lang.String unit)

Parameters:

listOfNumbers -

unit -

Returns:

addTimepointRecurring

public java.lang.String addTimepointRecurring(java.lang.String numberValue,
                                              java.lang.String unit,
                                              int repeats,
                                              java.lang.String startingValue)

Parameters:

numberValue -

unit -

repeats -

startingValue -

Returns:

addTimepointAbsolute

public java.lang.String addTimepointAbsolute(java.util.Calendar date)

Parameters:

date -

Returns:

copyTimepoint

public java.lang.String copyTimepoint(java.lang.String fromtimepointid,
                                      java.lang.String newNumber,
                                      java.lang.String newUnit,
                                      java.lang.String newLabel)

Parameters:

fromtimepointid -

newNumber -

newUnit -

newLabel -

Returns:

copyTimepoint

public java.lang.String copyTimepoint(java.lang.String fromtimepointid,
                                      java.lang.String newNumber,
                                      java.lang.String newUnit,
                                      java.lang.String newLabel,
                                      boolean copyPlanItems)

Parameters:

fromtimepointid -

newNumber -

newUnit -

newLabel -

copyPlanItems -

Returns:

copyTimepointForMultiples

public java.lang.String copyTimepointForMultiples(java.lang.String fromtimepointid,
                                                  java.lang.String listOfNumbers,
                                                  java.lang.String unit)

Parameters:

fromtimepointid -

listOfNumbers -

unit -

Returns:

copyTimepointForMultiples

public java.lang.String copyTimepointForMultiples(java.lang.String fromtimepointid,
                                                  java.lang.String listOfNumbers,
                                                  java.lang.String unit,
                                                  boolean copyPlanItems)

Parameters:

fromtimepointid -

listOfNumbers -

unit -

copyPlanItems -

Returns:

copyTimepointRecurring

public java.lang.String copyTimepointRecurring(java.lang.String fromtimepointid,
                                               java.lang.String numberValue,
                                               java.lang.String unit,
                                               int repeats,
                                               java.lang.String startingValue)

Parameters:

fromtimepointid -

numberValue -

unit -

repeats -

startingValue -

Returns:

copyTimepointRecurring

public java.lang.String copyTimepointRecurring(java.lang.String fromtimepointid,
                                               java.lang.String numberValue,
                                               java.lang.String unit,
                                               int repeats,
                                               java.lang.String startingValue,
                                               boolean copyPlanItems)

Parameters:

fromtimepointid -

numberValue -

unit -

repeats -

startingValue -

copyPlanItems -

Returns:

copyTimepointAbsolute

public java.lang.String copyTimepointAbsolute(java.lang.String fromtimepointid,
                                              java.util.Calendar date)

Parameters:

fromtimepointid -

date -

Returns:

copyTimepointAbsolute

public java.lang.String copyTimepointAbsolute(java.lang.String fromtimepointid,
                                              java.util.Calendar date,
                                              boolean copyPlanItems)

Parameters:

fromtimepointid -

date -

copyPlanItems -

Returns:

findOrAddTimepoint

public java.lang.String findOrAddTimepoint(java.lang.String rule,
                                           java.lang.String label)

Parameters:

rule -

label -

Returns:

setLabel

public void setLabel(java.lang.String timepointid,
                     java.lang.String label)

Parameters:

timepointid -

label -

getLabel

public java.lang.String getLabel(java.lang.String timepointid)

Parameters:

timepointid -

Returns:

setOffsetRule

public void setOffsetRule(java.lang.String timepointid,
                          double number,
                          java.lang.String unit)

Parameters:

timepointid -

number -

unit -

getRule

public java.lang.String getRule(java.lang.String timepointid)

Parameters:

timepointid -

Returns:

setAbsoluteDateRule

public void setAbsoluteDateRule(java.lang.String timepointid,
                                java.util.Calendar date)

Parameters:

timepointid -

date -

setExecuteAhead

public void setExecuteAhead(java.lang.String timepointid,
                            double executeahead)

Parameters:

timepointid -

executeahead -

getExecuteAhead

public java.lang.String getExecuteAhead(java.lang.String timepointid)

Parameters:

timepointid -

Returns:

setExecuteAheadUnit

public void setExecuteAheadUnit(java.lang.String timepointid,
                                java.lang.String unit)

Parameters:

timepointid -

unit -

getExecuteAheadUnit

public java.lang.String getExecuteAheadUnit(java.lang.String timepointid)

Parameters:

timepointid -

Returns:

deleteTimepoint

public void deleteTimepoint(java.lang.String timepointid)

Parameters:

timepointid -

isTimepointReadOnly

public boolean isTimepointReadOnly(java.lang.String timepointid)

Parameters:

timepointid -

Returns:

true if the Timepoint is read-only, false otherwise

findRowById

public int findRowById(java.lang.String timepointid)

getTimepointId

public java.lang.String getTimepointId(int row)

findTimepointByProtocolPlanTimepointId

public java.lang.String findTimepointByProtocolPlanTimepointId(java.lang.String protocolPlanTimepointId)

Parameters:

protocolPlanTimepointId - the protocol plan Timepoint ID

Returns:

the Timepoint ID associated with the given protocol plan condition ID

size

public int size()

editItem

public void editItem(int row,
                     java.util.HashMap values)

Parameters:

row - the row index of the item to be edited

values - a HashMap containing the values to be assigned to the item's columns

getTimeAxisItems

public DataStore getTimeAxisItems()

Returns:

: The timeAxis items stored in the data store.

addItem

public int addItem(java.util.HashMap values)

Parameters:

values - : the values of the item to be added