ScheduleGrid

java.lang.Object
- com.labvantage.sapphire.BaseCustom
- - sapphire.stability.ScheduleGrid

All Implemented Interfaces:

StabilityConstants
```
public class ScheduleGrid
extends com.labvantage.sapphire.BaseCustom
implements StabilityConstants
```
The ScheduleGrid class is used as a wrapper class for the private ScheduleGrid class.

Examples:

Create Schedule Grid object:

Using ConnectionId:

ScheduleGrid grid = new ScheduleGrid( getConnectionid() );

Using rakFile and ConnectionId:

ScheduleGrid grid = new ScheduleGrid( getRakFile(), getConnectionid() );

Using rakFile,ConnectionId and private grid object:

com.labvantage.sapphire.stability.ScheduleGrid grid = new com.labvantage.sapphire.stability.ScheduleGrid( getConnectionId() );

ScheduleGrid publicGrid = new ScheduleGrid( getRakFile(), getConnectionid(), grid );

Using ConnectionId and private grid object:

com.labvantage.sapphire.stability.ScheduleGrid grid = new com.labvantage.sapphire.stability.ScheduleGrid( getConnectionId() );

ScheduleGrid publicGrid = new ScheduleGrid( getConnectionid(), grid );

Loading data into grid object:

ScheduleGrid grid = new ScheduleGrid( getConnectionid() );

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

Convert ScheduleGrid object to Json representation:

ScheduleGrid grid = new ScheduleGrid( getConnectionid() );

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

grid.toJson();

Load data for ScheduleGrid object using Json object:

ScheduleGrid grid = new ScheduleGrid( getRakFile(), getConnectionid() );

grid.loadFromJson( json ); // json object containing json representation of a grid

Make changes and save data for ScheduleGrid object:

ScheduleGrid grid = new ScheduleGrid( getConnectionid() );

grid.retrieve( planId );

grid.setLabel( label ); // setter method to save label value

grid.setExecuteAhead( 5 ); //setter method to set executeahead value

grid.save( new SapphireConnection( database.getConnection(), connectionInfo ), (DBUtil)database );

Field Summary

Fields
Modifier and Type Field and Description

boolean skipValidationFlag
- Fields inherited from class com.labvantage.sapphire.BaseCustom
  FAILURE, logger, logName, SUCCESS
- 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

Fields
Modifier and Type	Field and Description
`boolean`	`skipValidationFlag`

Constructor Summary

Constructors
Constructor and Description
`ScheduleGrid(java.io.File rakFile, java.lang.String connectionid)`
`ScheduleGrid(java.io.File rakFile, java.lang.String connectionid, com.labvantage.sapphire.stability.ScheduleGrid scheduleGrid)`
`ScheduleGrid(java.lang.String connectionid)`
`ScheduleGrid(java.lang.String connectionid, com.labvantage.sapphire.stability.ScheduleGrid scheduleGrid)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.labvantage.sapphire.stability.ScheduleGrid`	`dangerouslyGetGrid()`
`ConditionAxis`	`getConditionAxis()`
`DataStore`	`getConditionsWithReadOnlyPlanItem()`
`DataStore`	`getConditionsWithSampleWO()`
`java.lang.String`	`getExecuteAhead()`
`java.lang.String`	`getExecuteAheadUnit()`
`java.lang.String`	`getLabel()`
`java.util.Calendar`	`getModDate()`
`java.lang.String`	`getPlanid()`
`PlanItemList`	`getPlanItemList()`
`java.lang.String`	`getPlanType()`
`PlanWorkItemList`	`getPlanWorkItemList()`
`com.labvantage.sapphire.xml.PropertyTree`	`getPropertyTree(java.lang.String propertytreeid)`
`PropertyList`	`getTaskDefaults(java.lang.String propertyTreeid)` Gets a COPY of the default properties for the selected Task at the plan level.
`TaskTypeList`	`getTaskTypeList()`
`TimeAxis`	`getTimeAxis()`
`boolean`	`isEligibleForPlanWorkItemListEdit()`
`boolean`	`isPlanReadOnly()`
`boolean`	`isProtocolCurrent()`
`boolean`	`isTemplate()`
`void`	`loadFromJson(JsonObject json)`
`void`	`retrieve(java.lang.String planid)`
`void`	`save(com.labvantage.sapphire.services.SapphireConnection sapphireConnection, com.labvantage.sapphire.DBUtil database)`
`void`	`setExecuteAhead(double executeAhead)`
`void`	`setExecuteAhead(double executeAhead, java.lang.String executeaheadUnit)`
`void`	`setExecuteAheadUnit(java.lang.String executeaheadUnit)`
`void`	`setLabel(java.lang.String label)`
`void`	`setPropertyTree(java.lang.String propertyTreeid, com.labvantage.sapphire.xml.PropertyTree tree)`
`void`	`setTaskDefaults(java.lang.String propertyTreeid, PropertyList propertyList)` Sets the task default properties.
`JsonObject`	`toJson()`
`JsonObject`	`toJson(boolean onlyChanges)`

Methods inherited from class com.labvantage.sapphire.BaseCustom
getAccessorErrorIds, getAccessorErrorMsgs, getActionProcessor, getConfigurationProcessor, getConnectionid, getConnectionId, getConnectionProcessor, getDAMProcessor, getDepartmentList, getHttpProcessor, getQueryProcessor, getRakFile, getSDCProcessor, getSDIProcessor, getSequenceProcessor, getTranslationProcessor, setConnectionId, setLanguage, setRakFile

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - skipValidationFlag
```
public boolean skipValidationFlag
```
- Constructor Detail
  - ScheduleGrid
```
public ScheduleGrid(java.lang.String connectionid)
```
    Parameters:
    
    connectionid -
  - ScheduleGrid
```
public ScheduleGrid(java.io.File rakFile,
                    java.lang.String connectionid)
```
    Parameters:
    
    rakFile -
    
    connectionid -
  - ScheduleGrid
```
public ScheduleGrid(java.io.File rakFile,
                    java.lang.String connectionid,
                    com.labvantage.sapphire.stability.ScheduleGrid scheduleGrid)
```
    Parameters:
    
    rakFile -
    
    connectionid -
    
    scheduleGrid -
  - ScheduleGrid
```
public ScheduleGrid(java.lang.String connectionid,
                    com.labvantage.sapphire.stability.ScheduleGrid scheduleGrid)
```
    Parameters:
    
    connectionid -
    
    scheduleGrid -
- Method Detail
  - retrieve
```
public void retrieve(java.lang.String planid)
              throws SapphireException
```
    Parameters:
    
    planid -
    
    Throws:
    
    SapphireException
  - save
```
public void save(com.labvantage.sapphire.services.SapphireConnection sapphireConnection,
                 com.labvantage.sapphire.DBUtil database)
          throws java.lang.Exception
```
    Parameters:
    
    sapphireConnection -
    
    database -
    
    Throws:
    
    java.lang.Exception
  - toJson
```
public JsonObject toJson()
                  throws SapphireException
```
    Returns:
    
    The JSON representation of the ScheduleGrid object.
    
    Throws:
    
    SapphireException
  - toJson
```
public JsonObject toJson(boolean onlyChanges)
                  throws SapphireException
```
    Parameters:
    
    onlyChanges -
    
    Returns:
    
    returns a JsonObject representation of the ScheduleGrid object only containing the inserted and updated data using the toJson method for private ScheduleGrid class
    
    Throws:
    
    SapphireException
  - loadFromJson
```
public void loadFromJson(JsonObject json)
                  throws SapphireException
```
    Parameters:
    
    json -
    
    Throws:
    
    SapphireException
  - getPlanid
```
public java.lang.String getPlanid()
```
    Returns:
    
    Returns the scheduleplanid for the grid object
  - getLabel
```
public java.lang.String getLabel()
```
    Returns:
    
    Returns the label for the grid object
  - setLabel
```
public void setLabel(java.lang.String label)
```
    Parameters:
    
    label -
  - isTemplate
```
public boolean isTemplate()
```
    Returns:
    
    returns true if the scheduleplan is a template
  - getPlanType
```
public java.lang.String getPlanType()
```
    Returns:
    
    returns the plan type, whether it belongs to Protocol or Study
  - setExecuteAhead
```
public void setExecuteAhead(double executeAhead)
```
    Parameters:
    
    executeAhead -
  - setExecuteAhead
```
public void setExecuteAhead(double executeAhead,
                            java.lang.String executeaheadUnit)
```
    Parameters:
    
    executeAhead -
    
    executeaheadUnit -
  - getExecuteAhead
```
public java.lang.String getExecuteAhead()
```
    Returns:
  - setExecuteAheadUnit
```
public void setExecuteAheadUnit(java.lang.String executeaheadUnit)
```
    Parameters:
    
    executeaheadUnit -
  - getExecuteAheadUnit
```
public java.lang.String getExecuteAheadUnit()
```
    Returns:
    
    returns the executeaheadunit
  - getModDate
```
public java.util.Calendar getModDate()
```
    Returns:
    
    returns the last modified date for the grid
  - getTimeAxis
```
public TimeAxis getTimeAxis()
```
    Returns:
    
    returns the public TimeAxis object for grid
  - getConditionAxis
```
public ConditionAxis getConditionAxis()
```
    Returns:
    
    returns the public ConditionAxis object for grid
  - getTaskTypeList
```
public TaskTypeList getTaskTypeList()
```
    Returns:
    
    returns the public TaskTypeList object for grid
  - getTaskDefaults
```
public PropertyList getTaskDefaults(java.lang.String propertyTreeid)
                             throws SapphireException
```
    Gets a COPY of the default properties for the selected Task at the plan level. IMPORTANT: Any changes to the returned PropertyList will NOT be honored by the API until the setTaskDefault() method is called.
    
    Parameters:
    
    propertyTreeid - the id of the task
    
    Returns:
    
    the task default properties
    
    Throws:
    
    SapphireException
  - setTaskDefaults
```
public void setTaskDefaults(java.lang.String propertyTreeid,
                            PropertyList propertyList)
```
    Sets the task default properties. Note that if any collectionitem is missing an internal-id or sequence number, this method will fill those in
    
    Parameters:
    
    propertyTreeid - The id of the task
    
    propertyList -
  - getPlanItemList
```
public PlanItemList getPlanItemList()
```
    Returns:
    
    returns the public PlanItemList object for grid
  - getPlanWorkItemList
```
public PlanWorkItemList getPlanWorkItemList()
```
    Returns:
    
    returns the public PlanWorkItemList object for grid
  - getPropertyTree
```
public com.labvantage.sapphire.xml.PropertyTree getPropertyTree(java.lang.String propertytreeid)
```
    Parameters:
    
    propertytreeid -
    
    Returns:
    
    returns the PropertyTree object for a given propertytreeid
  - setPropertyTree
```
public void setPropertyTree(java.lang.String propertyTreeid,
                            com.labvantage.sapphire.xml.PropertyTree tree)
```
    Parameters:
    
    propertyTreeid -
    
    tree -
  - getConditionsWithSampleWO
```
public DataStore getConditionsWithSampleWO()
```
    Returns:
    
    returns DataStore object containing the conditions of the plan with samples and or workOrders
  - getConditionsWithReadOnlyPlanItem
```
public DataStore getConditionsWithReadOnlyPlanItem()
```
    Returns:
    
    returns DataStore object containing the conditions with scheduleplanitems having scheduleevent in Done status
  - dangerouslyGetGrid
```
public com.labvantage.sapphire.stability.ScheduleGrid dangerouslyGetGrid()
```
    Returns:
    
    returns the private ScheduleGrid object
  - isPlanReadOnly
```
public boolean isPlanReadOnly()
```
    Returns:
    
    returns true if the scheduleplan is readonly
  - isEligibleForPlanWorkItemListEdit
```
public boolean isEligibleForPlanWorkItemListEdit()
```
    Returns:
    
    returns true if plan is eligible for editing PlanWorkItemList
  - isProtocolCurrent
```
public boolean isProtocolCurrent()
```
    Returns:
    
    returns true if the protocol version is Current, Active or Expired

Class ScheduleGrid

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

Examples:

Create Schedule Grid object:

Using ConnectionId:

Using rakFile and ConnectionId:

Using rakFile,ConnectionId and private grid object:

Using ConnectionId and private grid object:

Loading data into grid object:

Convert ScheduleGrid object to Json representation:

Load data for ScheduleGrid object using Json object:

Make changes and save data for ScheduleGrid object:

Field Summary

Fields inherited from class com.labvantage.sapphire.BaseCustom

Fields inherited from interface sapphire.stability.StabilityConstants

Constructor Summary

Method Summary

Methods inherited from class com.labvantage.sapphire.BaseCustom

Methods inherited from class java.lang.Object

Field Detail

skipValidationFlag

Constructor Detail

ScheduleGrid

ScheduleGrid

ScheduleGrid

ScheduleGrid

Method Detail

retrieve

save

toJson

toJson

loadFromJson

getPlanid

getLabel

setLabel

isTemplate

getPlanType

setExecuteAhead

setExecuteAhead

getExecuteAhead

setExecuteAheadUnit

getExecuteAheadUnit

getModDate

getTimeAxis

getConditionAxis

getTaskTypeList

getTaskDefaults

setTaskDefaults

getPlanItemList

getPlanWorkItemList

getPropertyTree

setPropertyTree

getConditionsWithSampleWO

getConditionsWithReadOnlyPlanItem

dangerouslyGetGrid

isPlanReadOnly

isEligibleForPlanWorkItemListEdit

isProtocolCurrent