sapphire.stability

Class StabilityStudyFactory

java.lang.Object

com.labvantage.sapphire.BaseCustom

sapphire.stability.StabilityStudyFactory

All Implemented Interfaces:

StabilityConstants

public class StabilityStudyFactory
extends com.labvantage.sapphire.BaseCustom
implements StabilityConstants

The StabilityStudyFactory class is responsible for creating and manipulating StabilityStudy objects. It provides methods for creating studies from scratch or from a given protocol, adding plans to studies, copying studies from another study, and loading studies from either the server or a JSON object.

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
StabilityStudyFactory(java.io.File rakFile, java.lang.String connectionid) StabilityStudyFactory is a factory class for creating StabilityStudy objects.
StabilityStudyFactory(PageContext pageContext) Creates a StabilityStudyFactory object with the given page context.
StabilityStudyFactory(java.lang.String connectionid) StabilityStudyFactory is a factory class for creating StabilityStudy objects.

Method Summary

Modifier and Type	Method and Description
StabilityStudy	addPlanCreatedFromScratch(java.lang.String studyid) Adds a plan created from scratch to the ScheduleGrid.
StabilityStudy	addPlanCreatedFromScratch(java.lang.String studyid, java.lang.String planlabel) Adds a plan created from scratch to the ScheduleGrid.
StabilityStudy	addPlanCreatedFromTemplate(java.lang.String studyid, java.lang.String planid) Adds a plan created from a template to the ScheduleGrid.
StabilityStudy	addPlanCreatedFromTemplate(java.lang.String studyid, java.lang.String planid, java.lang.String planlabel) Adds a plan created from a template to the ScheduleGrid.
StabilityStudy	copyStudyFromAnotherStudy(java.lang.String studyid) Copies a StabilityStudy from another study.
StabilityStudy	createStudyFromProtocol(java.lang.String studyTemplateID, java.lang.String protocolID, java.lang.String protocolVersionID, java.lang.String productID) Creates a StabilityStudy object based on the given protocol information.
StabilityStudy	createStudyFromScratch(java.lang.String studyTemplateID) Create a new StabilityStudy object from scratch using a study template ID.
StabilityStudy	loadFromJson(JsonObject json) Loads a StabilityStudy object from a JsonObject.
StabilityStudy	loadStudy(java.lang.String studyid) Loads a StabilityStudy object based on the given study ID.
void	saveStudy(StabilityStudy study)

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

Constructor Detail

StabilityStudyFactory

public StabilityStudyFactory(java.lang.String connectionid)

StabilityStudyFactory is a factory class for creating StabilityStudy objects. It provides various methods to create and manipulate StabilityStudy objects.

StabilityStudyFactory

public StabilityStudyFactory(java.io.File rakFile,
                             java.lang.String connectionid)

StabilityStudyFactory is a factory class for creating StabilityStudy objects. It provides various methods to create and manipulate StabilityStudy objects.

Parameters:

rakFile - The File object representing the RAK file.

connectionid - The connection ID to be set.

StabilityStudyFactory

public StabilityStudyFactory(PageContext pageContext)

Creates a StabilityStudyFactory object with the given page context.

Parameters:

pageContext - The page context object.

Method Detail

createStudyFromScratch

public StabilityStudy createStudyFromScratch(java.lang.String studyTemplateID)
                                      throws SapphireException

Create a new StabilityStudy object from scratch using a study template ID.

Parameters:

studyTemplateID - The ID of the study template to use.

Returns:

The newly created StabilityStudy object.

Throws:

SapphireException - If there is an error creating the study from scratch.

createStudyFromProtocol

public StabilityStudy createStudyFromProtocol(java.lang.String studyTemplateID,
                                              java.lang.String protocolID,
                                              java.lang.String protocolVersionID,
                                              java.lang.String productID)
                                       throws SapphireException

Creates a StabilityStudy object based on the given protocol information.

Parameters:

studyTemplateID - The ID of the study template to use.

protocolID - The ID of the protocol.

protocolVersionID - The ID of the protocol version.

productID - The ID of the product.

Returns:

The newly created StabilityStudy object.

Throws:

SapphireException - If there is an error creating the study from the protocol.

addPlanCreatedFromScratch

public StabilityStudy addPlanCreatedFromScratch(java.lang.String studyid)
                                         throws SapphireException

Adds a plan created from scratch to the ScheduleGrid.

Parameters:

studyid - The ID of the study for which the plan is being created.

Returns:

The updated ScheduleGrid object.

Throws:

SapphireException - If there is an error adding the plan.

addPlanCreatedFromScratch

public StabilityStudy addPlanCreatedFromScratch(java.lang.String studyid,
                                                java.lang.String planlabel)
                                         throws SapphireException

Adds a plan created from scratch to the ScheduleGrid.

Parameters:

studyid - The ID of the study for which the plan is being created.

planlabel - The label of the plan being created.

Returns:

The updated Stability Study object.

Throws:

SapphireException - If there is an error adding the plan.

addPlanCreatedFromTemplate

public StabilityStudy addPlanCreatedFromTemplate(java.lang.String studyid,
                                                 java.lang.String planid)
                                          throws SapphireException

Adds a plan created from a template to the ScheduleGrid.

Parameters:

studyid - The ID of the study for which the plan is being created.

planid - The ID of the plan being created.

Returns:

The updated ScheduleGrid object.

Throws:

SapphireException - If there is an error adding the plan.

addPlanCreatedFromTemplate

public StabilityStudy addPlanCreatedFromTemplate(java.lang.String studyid,
                                                 java.lang.String planid,
                                                 java.lang.String planlabel)
                                          throws SapphireException

Adds a plan created from a template to the ScheduleGrid.

Parameters:

studyid - The ID of the study for which the plan is being created.

planid - The ID of the plan being created.

planlabel - The label of the plan being created.

Returns:

The updated ScheduleGrid object.

Throws:

SapphireException - If there is an error adding the plan.

copyStudyFromAnotherStudy

public StabilityStudy copyStudyFromAnotherStudy(java.lang.String studyid)
                                         throws SapphireException

Copies a StabilityStudy from another study.

Parameters:

studyid - The ID of the study to copy from.

Returns:

A new StabilityStudy object that is a copy of the study with the given ID.

Throws:

SapphireException

loadStudy

public StabilityStudy loadStudy(java.lang.String studyid)
                         throws SapphireException

Loads a StabilityStudy object based on the given study ID.

Parameters:

studyid - The ID of the study to load.

Returns:

The loaded StabilityStudy object.

Throws:

SapphireException - If there is an error loading the study.

loadFromJson

public StabilityStudy loadFromJson(JsonObject json)
                            throws SapphireException

Loads a StabilityStudy object from a JsonObject.

Parameters:

json - The JsonObject containing the data to load.

Returns:

The loaded StabilityStudy object.

Throws:

SapphireException - If there is an error loading the study.

saveStudy

public void saveStudy(StabilityStudy study)
               throws SapphireException

Parameters:

study -

Throws:

SapphireException