sapphire.action

Class BaseAdvancedPullSample

java.lang.Object

com.labvantage.sapphire.BaseCustom

sapphire.action.BaseAction

com.labvantage.sapphire.scheduler.BaseScheduleTask

com.labvantage.opal.actions.tasks.AdvancedPullSample

sapphire.action.BaseAdvancedPullSample

All Implemented Interfaces:

com.labvantage.sapphire.modules.wap.activity.WAPConstants, com.labvantage.sapphire.stability.task.GridTask, com.labvantage.sapphire.stability.task.GridTaskStatus, com.labvantage.sapphire.stability.task.HasDetails, com.labvantage.sapphire.stability.task.PullAmount, com.labvantage.sapphire.stability.task.WorkOrderCallbackable

public class BaseAdvancedPullSample
extends com.labvantage.opal.actions.tasks.AdvancedPullSample

Public API of the class com.labvantage.opal.actions.tasks.AdvancedPullSample

Field Summary

Fields inherited from class com.labvantage.opal.actions.tasks.AdvancedPullSample

LOG_NAME

Fields inherited from class com.labvantage.sapphire.scheduler.BaseScheduleTask

createMonitorGroup, eventDateList, instanceCount, monitorGroupId, newKeyidsMap, scheduleEvents, schedulePlanidList, schedulePlanitemidList, scheduleProperties, sourceKeyid1List, sourceKeyid2List, sourceKeyid3List, sourceSdcidList

Fields inherited from class sapphire.action.BaseAction

connectionInfo, database, DEFAULT_SEPARATOR, ESC_SEMICOLON, NO, NULL, POLL, RETURN, RETURN_FAILURE, RETURN_SUCCESS, TYPE_CONFIRM, TYPE_FAILURE, TYPE_INFORMATION, TYPE_VALIDATION, VERSION, YES

Fields inherited from class com.labvantage.sapphire.BaseCustom

FAILURE, logger, logName, SUCCESS

Fields inherited from interface com.labvantage.sapphire.modules.wap.activity.WAPConstants

ACTIVITYCONTEXTSDCID_REQUEST, ANALYSTTYPE_ANALYST, DEFAULT_MAXACTIVITYSIZE, RESERVATIONCONTEXT_PARAMLIST, RESERVATIONCONTEXT_PARAMLISTVERSION, RESERVATIONCONTEXT_REQUESTITEM, RESERVATIONCONTEXT_VARIANT, RESERVATIONCONTEXT_WORKITEM, RESERVATIONCONTEXT_WORKITEMITEM, RESERVATIONCONTEXT_WORKITEMVERSION, RESERVATIONTYPE_REQUESTITEMSAMPLE, RESERVATIONTYPE_REQUESTITEMWORKITEM, RESERVATIONTYPE_REQUESTITEMWORKITEMITEM, RESOURCESDCID_DEPARTMENT, RESOURCESDCID_INSTRUMENT, RESOURCESDCID_USER, RESOURCETYPE_ANALYST, RESOURCETYPE_INSTRUMENT, STATUS_ACTIVATED, STATUS_CANCELLED, STATUS_COMPLETED, STATUS_DRAFT, STATUS_INPROGRESS, TIMEMODE_FIXED, TIMEMODE_FLOATING, TIMEMODE_NONE, WAPSTATUS_ASSIGNED, WAPSTATUS_CANCELLED, WAPSTATUS_PENDING, WORKCONTEXT_MASTERDATASDI, WORKCONTEXT_WORKAREA, WORKCONTEXT_WORKSDCID, WORKSDCID_ACTIVITY, WORKSDCID_DATASET, WORKSDCID_SAMPLE, WORKSDCID_SDIWORKITEM, WORKSDCID_WORKORDER

Constructor Summary

Constructors

Constructor and Description
BaseAdvancedPullSample()

Method Summary

Modifier and Type	Method and Description
protected void	addCustomSampleColumns(java.lang.String schedulePlanId, java.lang.String schedulePlanItemId, java.lang.String conditionid, DataSet studyDS, PropertyList sampleProps)
protected void	applySpec(java.lang.String keyIdList, PropertyListCollection specs, java.lang.String schedulePlanId, java.lang.String schedulePlanItemId, java.lang.String sdcid)
java.lang.String	getColor()
java.lang.String[]	getDetailLevels()
java.util.HashMap	getDetails(PropertyList properties)
protected java.lang.String	getFirstPlanItemId(java.lang.String schedulePlanId, java.lang.String schedulePlanItemId, java.lang.String workItemId)
protected DataSet	getFirstPlanItemSample(java.lang.String schedulePlanId, java.lang.String firstPlanItemId, java.lang.String workItemId)
protected java.lang.String	getLogName()
protected java.lang.StringBuffer	getPullAmounts(PropertyList propertyList)
protected java.lang.StringBuffer	getSummary(PropertyList propertyList)
java.lang.String	getSummaryHTML(PropertyList propertyList, java.lang.String detailLevel)
java.lang.String	getSummaryText(PropertyList propertyList, java.lang.String detailLevel)
java.lang.String	getTitle()
protected java.lang.StringBuffer	getWorkorder(PropertyList propertyList)
boolean	isComplete(java.lang.String planid, java.lang.String planitemid, DBAccess database) Default behaviour of task
protected boolean	isSampleLogged(java.lang.String scheduleplanid, java.lang.String scheduleplanitemid)
protected boolean	isTestLogged(java.lang.String scheduleplanid, java.lang.String scheduleplanitemid, java.lang.String workitemid)
protected boolean	isTimeZeroTask(java.lang.String scheduleplanid, java.lang.String scheduleplanitemid)
protected DataSet	loadStudy(java.lang.String schedulePlanId, java.lang.String schedulePlanItemId) This method returns dataset with the Study SDC columns and controlsubstanceflag, cocrequiredflag of the Product joined with the Study and may return extra columns of other SDCs joined with Study SDI
protected DataSet	loadTestProperties(java.lang.String scheduleplanid, java.lang.String scheduleplanitemid, boolean isTimeZeroTask)
protected void	postAddStabilitySample(java.lang.String sampleIds, java.lang.String schedulePlanId, java.lang.String schedulePlanItemId)
protected void	preAddStabilitySample(java.lang.String schedulePlanId, java.lang.String schedulePlanItemId)
protected void	processReuseSample(java.lang.String sampleId, java.lang.String workItemId, java.lang.String schedulePlanId, java.lang.String schedulePlanItemId, boolean firstTimePoint)

Methods inherited from class com.labvantage.opal.actions.tasks.AdvancedPullSample

execute, getQuantity, getStatusHTML, getUnits, preWOComplete, statusInit, workorderCompleted

Methods inherited from class com.labvantage.sapphire.scheduler.BaseScheduleTask

addNewKeyid, count, getDatabase, processAction, replaceSourceParentToken, setAdhocFlag, setCreateMonitorGroup, setDatabase, setInstanceCount, setMonitorGroupId, setNewKeyidsMap, setScheduleEvents, setScheduleProperties

Methods inherited from class sapphire.action.BaseAction

createDatabaseTransactionLogId, createDatabaseTransactionLogId, endAction, getErrorHandler, isDatabaseRequired, logError, logTrace, processAction, setError, setError, setError, setError, setError, setError, setErrors, setInfoError, setInfoError, startAction

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

BaseAdvancedPullSample

public BaseAdvancedPullSample()

Method Detail

loadTestProperties

protected DataSet loadTestProperties(java.lang.String scheduleplanid,
                                     java.lang.String scheduleplanitemid,
                                     boolean isTimeZeroTask)
                              throws SapphireException

Overrides:

loadTestProperties in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

scheduleplanid - : SchedulePlan Id

scheduleplanitemid - : Schedule planItem Id

isTimeZeroTask - : return value of isTimeZeroTask method call

Returns:

dataset Must contain the following columns: workitemid, departmentid, quantity, quantityunit, numrepeats, containerperrepeatflag, containerpertestflag, destructivetestflag, reusecontainerflag"

Throws:

SapphireException

loadStudy

protected DataSet loadStudy(java.lang.String schedulePlanId,
                            java.lang.String schedulePlanItemId)
                     throws SapphireException

Description copied from class: com.labvantage.opal.actions.tasks.AdvancedPullSample

This method returns dataset with the Study SDC columns and controlsubstanceflag, cocrequiredflag of the Product joined with the Study and may return extra columns of other SDCs joined with Study SDI

Overrides:

loadStudy in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

schedulePlanId - : PlanId of the task being executed

schedulePlanItemId - : PlanItemId of the task being exceuted

Returns:

dataset with all the Study SDC columns and controlsubstanceflag, cocrequiredflag of the Product joined with the Study and may return columns from other SDCs joined with the Study SDI

Throws:

SapphireException

applySpec

protected void applySpec(java.lang.String keyIdList,
                         PropertyListCollection specs,
                         java.lang.String schedulePlanId,
                         java.lang.String schedulePlanItemId,
                         java.lang.String sdcid)
                  throws SapphireException

Overrides:

applySpec in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

keyIdList - : Sample Ids created by the task separated by semicolon

specs - : PropertyList Collection Specs

schedulePlanId - : SchedulePlan Id

schedulePlanItemId: - SchedulePlan Item Id

sdcid - : Sample

Throws:

SapphireException

isTimeZeroTask

protected boolean isTimeZeroTask(java.lang.String scheduleplanid,
                                 java.lang.String scheduleplanitemid)
                          throws SapphireException

Overrides:

isTimeZeroTask in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Throws:

SapphireException

addCustomSampleColumns

protected void addCustomSampleColumns(java.lang.String schedulePlanId,
                                      java.lang.String schedulePlanItemId,
                                      java.lang.String conditionid,
                                      DataSet studyDS,
                                      PropertyList sampleProps)
                               throws SapphireException

Overrides:

addCustomSampleColumns in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

schedulePlanId - : PlanId of the task being executed

schedulePlanItemId - : PlanItemId of the task being executed

conditionid - : ConditionId of the task being executed

studyDS: - DataSet returned by the loadStudy method, which contains the Study columns and the columns from other SDCs, which are joined with the Study SDI in the sql executed by the loadStudy method

sampleProps - : The PropertyList, to be used in calling the AddSDI action, to create the task samples. Populating the custom columnid with value, in this PropertyList will end up in populating the corresponding columns of the the Samples, created by the task.

Throws:

SapphireException

getFirstPlanItemSample

protected DataSet getFirstPlanItemSample(java.lang.String schedulePlanId,
                                         java.lang.String firstPlanItemId,
                                         java.lang.String workItemId)
                                  throws SapphireException

Overrides:

getFirstPlanItemSample in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

schedulePlanId - : SchedulePlan Id

firstPlanItemId - : First planItem Id

workItemId - : Reuse Test Method Id

Returns:

dataset with the columns, 's_sampleid' and 'trackitemid', representing the sample created in the first planitem of the condition which is applied with the current reuse workitem.

Throws:

SapphireException

getFirstPlanItemId

protected java.lang.String getFirstPlanItemId(java.lang.String schedulePlanId,
                                              java.lang.String schedulePlanItemId,
                                              java.lang.String workItemId)
                                       throws SapphireException

Overrides:

getFirstPlanItemId in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

schedulePlanId - : SchedulePlan Id

schedulePlanItemId - : current planItem Id

workItemId - : Reuse Test Method Id

Returns:

first PlanItem Id of the condition to which the current planItem belongs, to be applied with the current workitem with reusecontainerflag = 'Y'

Throws:

SapphireException

postAddStabilitySample

protected void postAddStabilitySample(java.lang.String sampleIds,
                                      java.lang.String schedulePlanId,
                                      java.lang.String schedulePlanItemId)
                               throws SapphireException

Overrides:

postAddStabilitySample in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

sampleIds - : SampleIds created by the task

schedulePlanId - : schedule Plan Id of the task being executed

schedulePlanItemId - : schedule PlanItem Id of the task being executed

Throws:

SapphireException

preAddStabilitySample

protected void preAddStabilitySample(java.lang.String schedulePlanId,
                                     java.lang.String schedulePlanItemId)
                              throws SapphireException

Overrides:

preAddStabilitySample in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

schedulePlanId - : schedule Plan Id of the task being executed

schedulePlanItemId - : schedule PlanItem Id of the task being executed

Throws:

SapphireException

processReuseSample

protected void processReuseSample(java.lang.String sampleId,
                                  java.lang.String workItemId,
                                  java.lang.String schedulePlanId,
                                  java.lang.String schedulePlanItemId,
                                  boolean firstTimePoint)
                           throws SapphireException

Overrides:

processReuseSample in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

sampleId - sampleId to be reused in the current time point, on which test method is added

workItemId - Current Test Method with reuse flag set yes

schedulePlanId - SchedulePlanId of the time point of the task being executed

schedulePlanItemId - SchedulePlanItemId of the time point of the task being executed

firstTimePoint - true for first time point only

Throws:

SapphireException

getSummaryText

public java.lang.String getSummaryText(PropertyList propertyList,
                                       java.lang.String detailLevel)

Specified by:

getSummaryText in interface com.labvantage.sapphire.stability.task.GridTask

Overrides:

getSummaryText in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

propertyList - : PropertyList of the plan item

detailLevel - : Detail Level of the task as defined in 'Display Options', on the toolbar of ScheduleGrid page.

Returns:

Summary Text based on the task property list values

getDetails

public java.util.HashMap getDetails(PropertyList properties)

Specified by:

getDetails in interface com.labvantage.sapphire.stability.task.HasDetails

Overrides:

getDetails in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

properties: - task property list

Returns:

getSummary

protected java.lang.StringBuffer getSummary(PropertyList propertyList)

Overrides:

getSummary in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

propertyList - : PropertyList of the plan item

Returns:

Summary info of the task depending on the Detail Level specified for the task in ScheduleGrid page

getPullAmounts

protected java.lang.StringBuffer getPullAmounts(PropertyList propertyList)

Overrides:

getPullAmounts in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

propertyList - : PropertyList of the plan item

Returns:

Pull amount info of the task depending on the Detail Level specified for the task in ScheduleGrid page

getWorkorder

protected java.lang.StringBuffer getWorkorder(PropertyList propertyList)

Overrides:

getWorkorder in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

propertyList - : PropertyList of the plan item

Returns:

WorkOrder info of the task depending on the Detail Level specified for the task in ScheduleGrid page

isComplete

public boolean isComplete(java.lang.String planid,
                          java.lang.String planitemid,
                          DBAccess database)
                   throws SapphireException

Description copied from class: com.labvantage.sapphire.scheduler.BaseScheduleTask

Default behaviour of task

Overrides:

isComplete in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

planid - - Schedule Plan ID

planitemid - - Schedule Plan Item ID

database - - DBAccess

Returns:

true if related samples are in 'Reviewed' or 'Cancelled' status else return false

Throws:

SapphireException

isSampleLogged

protected boolean isSampleLogged(java.lang.String scheduleplanid,
                                 java.lang.String scheduleplanitemid)
                          throws SapphireException

Overrides:

isSampleLogged in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Throws:

SapphireException

isTestLogged

protected boolean isTestLogged(java.lang.String scheduleplanid,
                               java.lang.String scheduleplanitemid,
                               java.lang.String workitemid)
                        throws SapphireException

Overrides:

isTestLogged in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Throws:

SapphireException

getLogName

protected java.lang.String getLogName()

Overrides:

getLogName in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Returns:

Name of the class

getColor

public java.lang.String getColor()

Specified by:

getColor in interface com.labvantage.sapphire.stability.task.GridTask

Overrides:

getColor in class com.labvantage.opal.actions.tasks.AdvancedPullSample

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface com.labvantage.sapphire.stability.task.GridTask

Overrides:

getTitle in class com.labvantage.opal.actions.tasks.AdvancedPullSample

getDetailLevels

public java.lang.String[] getDetailLevels()

Specified by:

getDetailLevels in interface com.labvantage.sapphire.stability.task.GridTask

Overrides:

getDetailLevels in class com.labvantage.opal.actions.tasks.AdvancedPullSample

getSummaryHTML

public java.lang.String getSummaryHTML(PropertyList propertyList,
                                       java.lang.String detailLevel)

Specified by:

getSummaryHTML in interface com.labvantage.sapphire.stability.task.GridTask

Overrides:

getSummaryHTML in class com.labvantage.opal.actions.tasks.AdvancedPullSample

Parameters:

propertyList - : Task PropertyList

detailLevel - : Detail Level of the task as defined in 'Display Options', on the toolbar of ScheduleGrid page.

Returns:

the information about the task to be displayed in the task cell