sapphire.stability

Class ConditionAxis

java.lang.Object

sapphire.stability.ConditionAxis

All Implemented Interfaces:

StabilityConstants

public class ConditionAxis
extends java.lang.Object
implements StabilityConstants

The class represents a schedule grid's condition axis.

Example:

This class is used to add,copy, delete conditions from plan.

• ScheduleGridFactory factory = new ScheduleGridFactory( getConnectionid() );
• ScheduleGrid plan = factory.createPlanTemplateFromScratch( "test_PlanTemp1", "Test SchedulePlan Template" );
• String planid = plan.getPlanid();
• String conditionid = grid.getConditionAxis().addCondition( "ConditionLabel", "ConditionDes", storageenvid, "Upright" );
• String copiedConditionid1 = conditionAxis.copyCondition( conditionid1, "ConditionLabel_copy1" );

setter functions

• conditionAxis.setLabel( conditionid, "Condition Label" );
• conditionAxis.setDescription( conditionid, "Condition Description" );
• conditionAxis.setEnvironment( conditionid, storageenvid );
• conditionAxis.setOrientation( conditionid, "Upright" );
• conditionAxis.setReserveAmount( conditionid, "10" );
• conditionAxis.setReserveAmountUnit( conditionid, "ml" );
• conditionAxis.setReserveAmountUnitType( conditionid, "U" );
• conditionAxis.setPullAmount( conditionid, "100" );
• conditionAxis.setPullAmountUnit( conditionid, "ml" );
• conditionAxis.setPullAmountUnitType( conditionid, "U" );
• conditionAxis.setAutoCalcContainersFlag( conditionid, true );

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
ConditionAxis(ScheduleGrid grid)

Method Summary

Modifier and Type	Method and Description
java.lang.String	addCondition()
java.lang.String	addCondition(java.lang.String label)
java.lang.String	addCondition(java.lang.String label, java.lang.String description, java.lang.String environment, java.lang.String orientation)
int	addItem(java.util.HashMap values) Adds an item to the condition axis.
void	copyAllConditionsFromTemplate(java.lang.String planids) Copies all conditions from a template based on the provided plan IDs.
void	copyAllConditionsFromTemplate(java.lang.String planids, boolean includeAllTimepoints) Copies the conditions from a template to the current instance of ConditionAxis.
java.lang.String	copyCondition(java.lang.String fromconditionid, java.lang.String label)
java.lang.String	copyCondition(java.lang.String fromconditionid, java.lang.String label, java.lang.String description, java.lang.String environment, java.lang.String orientation)
void	copyConditionsFromTemplate(java.lang.String planids, java.lang.String conditionList) Copies the conditions from a template to the current instance of ConditionAxis.
void	copyConditionsFromTemplate(java.lang.String planids, java.lang.String conditionList, boolean includeAllTimePoints) Copies the conditions from a template to the current instance of ConditionAxis.
com.labvantage.sapphire.stability.ConditionAxis	dangerouslyGetConditionAxis()
void	deleteCondition(java.lang.String conditionid) Deletes a condition based on the given condition ID.
void	editItem(int row, java.util.HashMap values) Edits an item at the specified row in the condition axis.
java.lang.String	findConditionIdByProtocolPlanConditionId(java.lang.String protocolPlanConditionId) Finds the condition ID by the given protocol plan condition ID.
int	findRowById(java.lang.String conditionid)
java.lang.String	getActualRemainingQuantity(java.lang.String conditionid) Returns the actual remaining quantity for a given condition ID.
java.lang.String	getActualReserveQuantity(java.lang.String conditionid) Returns the actual reserve quantity for a given condition ID.
java.lang.String	getAutoCalcContainersFlag(java.lang.String conditionid) Retrieves the auto calculation containers flag for a given condition ID.
DataStore	getConditionAxisItems() Retrieves the condition axis items from the data store.
java.lang.String	getConditionId(int row)
java.lang.String[]	getConditionIds()
java.lang.String	getDescription(java.lang.String conditionid) Retrieves the description of a given condition.
java.lang.String	getEnvironment(java.lang.String conditionid) Retrieves the environment based on the given condition ID.
java.lang.String	getFutureQuantity(java.lang.String conditionid) Retrieves the future quantity data based on the given condition ID.
java.lang.String	getInitialActualQuantity(java.lang.String conditionid) Retrieves the initial actual quantity for a given condition ID.
java.lang.String	getInitialRecommendedQuantity(java.lang.String conditionid) Retrieves the initial recommended quantity for a given condition ID.
java.lang.String	getLabel(java.lang.String conditionid) Retrieves the label associated with the given condition ID.
java.lang.String	getNotes(java.lang.String conditionid) Retrieves the notes for a given condition ID.
java.lang.String	getOrientation(java.lang.String conditionid) Retrieves the orientation for a given condition ID.
java.lang.String	getPullAmount(java.lang.String conditionid) Retrieves the pull amount for the given condition ID.
java.lang.String	getPullAmountUnit(java.lang.String conditionid) Retrieves the unit for the pull amount based on the given condition ID.
java.lang.String	getPullAmountUnitType(java.lang.String conditionid) Retrieves the Pull AmountUnit Type for the given condition ID.
java.lang.String	getReserveAmount(java.lang.String conditionid) Retrieves the reserve amount for a given condition ID.
java.lang.String	getReserveAmountUnit(java.lang.String conditionid) Retrieves the reserve amount unit for the given condition ID.
java.lang.String	getReserveAmountUnitType(java.lang.String conditionid) Retrieves the reserve amount unit type based on the given condition ID.
java.lang.String	getStartCriteria(java.lang.String conditionid) Retrieves the start criteria for the given condition ID.
PropertyList	getTaskDefaults(java.lang.String conditionid, java.lang.String propertyTreeid) Gets a COPY of the default properties for the selected Task for a specific condition.
PropertyList	getTaskDefaults(java.lang.String conditionid, java.lang.String propertyTreeid, boolean collapseAncestors) Gets a copy of the default properties for the selected Task for a specific condition.
java.lang.String	getTotalRecommendedQuantity(java.lang.String conditionid) Retrieves the Total Recommended Quantity for the given condition ID.
boolean	isConditionReadOnly(java.lang.String conditionid) Checks if the given condition is read-only.
void	setAutoCalcContainersFlag(java.lang.String conditionid, boolean autoCalcFlag) Sets the auto calculate containers flag for a given condition ID.
void	setDescription(java.lang.String conditionid, java.lang.String description) Sets the description for a given condition.
void	setEnvironment(java.lang.String conditionid, java.lang.String environment) Sets the environment for a given condition ID.
void	setLabel(java.lang.String conditionid, java.lang.String label) Sets a label for a specific condition.
void	setNotes(java.lang.String conditionid, java.lang.String notes) Sets the notes for a given condition ID.
void	setOrientation(java.lang.String conditionid, java.lang.String orientation) Sets the orientation for a given condition ID.
void	setPullAmount(java.lang.String conditionid, java.lang.String pullAmount) Sets the pull amount of a given condition ID.
void	setPullAmountUnit(java.lang.String conditionid, java.lang.String pullAmountUnit) Sets the pull amount unit for a given condition ID.
void	setPullAmountUnitType(java.lang.String conditionid, java.lang.String pullAmountUnitType) Sets the pull amount unit type for a given condition ID.
void	setReserveAmount(java.lang.String conditionid, java.lang.String reserveAmount) Sets the reserve amount for a given condition ID.
void	setReserveAmountUnit(java.lang.String conditionid, java.lang.String reserveAmountUnit) Sets the reserve amount unit for a given condition ID.
void	setReserveAmountUnitType(java.lang.String conditionid, java.lang.String reserveAmountUnitType) Sets the reserve amount unit type for the given condition ID.
void	setStartCriteria(java.lang.String conditionid, java.lang.String criteria) Sets the start criteria for the specified condition.
void	setTaskDefaults(java.lang.String conditionid, java.lang.String propertyTreeid, PropertyList propertyList) Sets the task default properties for a column Note that if any collectionitem is missing an internal-id or sequence number, this method will fill those in
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionAxis

public ConditionAxis(ScheduleGrid grid)

Method Detail

dangerouslyGetConditionAxis

public com.labvantage.sapphire.stability.ConditionAxis dangerouslyGetConditionAxis()

addCondition

public java.lang.String addCondition(java.lang.String label)

Parameters:

label -

Returns:

addCondition

public java.lang.String addCondition()

Returns:

addCondition

public java.lang.String addCondition(java.lang.String label,
                                     java.lang.String description,
                                     java.lang.String environment,
                                     java.lang.String orientation)

Parameters:

label -

description -

environment -

orientation -

Returns:

copyCondition

public java.lang.String copyCondition(java.lang.String fromconditionid,
                                      java.lang.String label)
                               throws SapphireException

Throws:

SapphireException

copyCondition

public java.lang.String copyCondition(java.lang.String fromconditionid,
                                      java.lang.String label,
                                      java.lang.String description,
                                      java.lang.String environment,
                                      java.lang.String orientation)
                               throws SapphireException

Parameters:

fromconditionid -

label -

description -

environment -

orientation -

Returns:

Throws:

SapphireException

setLabel

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

Sets a label for a specific condition.

Parameters:

conditionid - the ID of the condition

label - the label to be set for the condition

getLabel

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

Retrieves the label associated with the given condition ID.

Parameters:

conditionid - The ID of the condition.

Returns:

The label associated with the condition ID.

setDescription

public void setDescription(java.lang.String conditionid,
                           java.lang.String description)

Sets the description for a given condition.

Parameters:

conditionid - the ID of the condition to set the description for

description - the description to set for the condition

getDescription

public java.lang.String getDescription(java.lang.String conditionid)

Retrieves the description of a given condition.

Parameters:

conditionid - The unique identifier of the condition.

Returns:

The description of the condition identified by conditionid.

setEnvironment

public void setEnvironment(java.lang.String conditionid,
                           java.lang.String environment)

Sets the environment for a given condition ID.

Parameters:

conditionid - The ID of the condition.

environment - The environment to set for the condition.

getEnvironment

public java.lang.String getEnvironment(java.lang.String conditionid)

Retrieves the environment based on the given condition ID.

Parameters:

conditionid - the condition ID to retrieve the environment for

Returns:

the environment associated with the given condition ID

setOrientation

public void setOrientation(java.lang.String conditionid,
                           java.lang.String orientation)

Sets the orientation for a given condition ID.

Parameters:

conditionid - the ID of the condition

orientation - the orientation to set

getOrientation

public java.lang.String getOrientation(java.lang.String conditionid)

Retrieves the orientation for a given condition ID.

Parameters:

conditionid - the ID of the condition

Returns:

the orientation value associated with the condition ID

setNotes

public void setNotes(java.lang.String conditionid,
                     java.lang.String notes)

Sets the notes for a given condition ID.

Parameters:

conditionid - the ID of the condition

notes - the notes to be set

getNotes

public java.lang.String getNotes(java.lang.String conditionid)

Retrieves the notes for a given condition ID.

Parameters:

conditionid - the ID of the condition to get notes for

Returns:

the notes associated with the condition ID

setReserveAmount

public void setReserveAmount(java.lang.String conditionid,
                             java.lang.String reserveAmount)

Sets the reserve amount for a given condition ID.

Parameters:

conditionid - The condition ID for which the reserve amount will be set.

reserveAmount - The reserve amount to be set.

getReserveAmount

public java.lang.String getReserveAmount(java.lang.String conditionid)

Retrieves the reserve amount for a given condition ID.

Parameters:

conditionid - the ID of the condition to get the reserve amount for

Returns:

the reserve amount as a string

setReserveAmountUnit

public void setReserveAmountUnit(java.lang.String conditionid,
                                 java.lang.String reserveAmountUnit)

Sets the reserve amount unit for a given condition ID.

Parameters:

conditionid - the ID of the condition

reserveAmountUnit - the unit of measurement for the reserve amount

setReserveAmountUnitType

public void setReserveAmountUnitType(java.lang.String conditionid,
                                     java.lang.String reserveAmountUnitType)

Sets the reserve amount unit type for the given condition ID.

Parameters:

conditionid - the ID of the condition to set the reserve amount unit type for

reserveAmountUnitType - the unit type to set for the reserve amount

getReserveAmountUnit

public java.lang.String getReserveAmountUnit(java.lang.String conditionid)

Retrieves the reserve amount unit for the given condition ID.

Parameters:

conditionid - the condition ID to retrieve the reserve amount unit for

Returns:

the reserve amount unit of the given condition ID

getReserveAmountUnitType

public java.lang.String getReserveAmountUnitType(java.lang.String conditionid)

Retrieves the reserve amount unit type based on the given condition ID.

Parameters:

conditionid - the condition ID for which to retrieve the reserve amount unit type

Returns:

the reserve amount unit type

setAutoCalcContainersFlag

public void setAutoCalcContainersFlag(java.lang.String conditionid,
                                      boolean autoCalcFlag)

Sets the auto calculate containers flag for a given condition ID.

Parameters:

conditionid - the condition ID for which to set the auto calculate containers flag

autoCalcFlag - the boolean value indicating whether to enable or disable auto calculate containers flag

getAutoCalcContainersFlag

public java.lang.String getAutoCalcContainersFlag(java.lang.String conditionid)

Retrieves the auto calculation containers flag for a given condition ID.

Parameters:

conditionid - The ID of the condition.

Returns:

The auto calculation containers flag as a string.

setPullAmount

public void setPullAmount(java.lang.String conditionid,
                          java.lang.String pullAmount)

Sets the pull amount of a given condition ID.

Parameters:

conditionid - the ID of the condition

pullAmount - the pull amount to set

getPullAmount

public java.lang.String getPullAmount(java.lang.String conditionid)

Retrieves the pull amount for the given condition ID.

Parameters:

conditionid - the ID of the condition to retrieve the pull amount for

Returns:

the pull amount as a string

setPullAmountUnit

public void setPullAmountUnit(java.lang.String conditionid,
                              java.lang.String pullAmountUnit)

Sets the pull amount unit for a given condition ID.

Parameters:

conditionid - The ID of the condition.

pullAmountUnit - The pull amount unit to be set.

getPullAmountUnit

public java.lang.String getPullAmountUnit(java.lang.String conditionid)

Retrieves the unit for the pull amount based on the given condition ID.

Parameters:

conditionid - the ID of the condition

Returns:

the unit for the pull amount

getTotalRecommendedQuantity

public java.lang.String getTotalRecommendedQuantity(java.lang.String conditionid)

Retrieves the Total Recommended Quantity for the given condition ID.

Parameters:

conditionid - the ID of the condition

Returns:

the unit for the pull amount

setPullAmountUnitType

public void setPullAmountUnitType(java.lang.String conditionid,
                                  java.lang.String pullAmountUnitType)

Sets the pull amount unit type for a given condition ID.

Parameters:

conditionid - the condition ID to set the pull amount unit type for

pullAmountUnitType - the pull amount unit type to set

getPullAmountUnitType

public java.lang.String getPullAmountUnitType(java.lang.String conditionid)

Retrieves the Pull AmountUnit Type for the given condition ID.

Parameters:

conditionid - the ID of the condition

Returns:

the unit type for the pull amount

getInitialRecommendedQuantity

public java.lang.String getInitialRecommendedQuantity(java.lang.String conditionid)

Retrieves the initial recommended quantity for a given condition ID.

Parameters:

conditionid - the ID of the condition

Returns:

the initial recommended quantity as a string

getInitialActualQuantity

public java.lang.String getInitialActualQuantity(java.lang.String conditionid)
                                          throws SapphireException

Retrieves the initial actual quantity for a given condition ID.

Parameters:

conditionid - the ID of the condition

Returns:

the initial actual quantity

Throws:

SapphireException

getActualRemainingQuantity

public java.lang.String getActualRemainingQuantity(java.lang.String conditionid)
                                            throws SapphireException

Returns the actual remaining quantity for a given condition ID.

Parameters:

conditionid - the condition ID to retrieve the actual remaining quantity for

Returns:

the actual remaining quantity as a String

Throws:

SapphireException

getFutureQuantity

public java.lang.String getFutureQuantity(java.lang.String conditionid)

Retrieves the future quantity data based on the given condition ID.

Parameters:

conditionid - the ID of the condition

Returns:

the future quantity data in String format

setStartCriteria

public void setStartCriteria(java.lang.String conditionid,
                             java.lang.String criteria)

Sets the start criteria for the specified condition.

Parameters:

conditionid - The ID of the condition to set the start criteria for.

criteria - The criteria to set as the start criteria.

getActualReserveQuantity

public java.lang.String getActualReserveQuantity(java.lang.String conditionid)
                                          throws SapphireException

Returns the actual reserve quantity for a given condition ID.

Parameters:

conditionid - the condition ID to retrieve the actual remaining quantity for

Returns:

the actual reserve quantity as a String

Throws:

SapphireException

getStartCriteria

public java.lang.String getStartCriteria(java.lang.String conditionid)

Retrieves the start criteria for the given condition ID.

Parameters:

conditionid - the ID of the condition

Returns:

the start criteria for the condition

deleteCondition

public void deleteCondition(java.lang.String conditionid)

Deletes a condition based on the given condition ID.

Parameters:

conditionid - The ID of the condition to be deleted.

isConditionReadOnly

public boolean isConditionReadOnly(java.lang.String conditionid)

Checks if the given condition is read-only.

Parameters:

conditionid - the ID of the condition to check

Returns:

true if the condition is read-only, false otherwise

copyAllConditionsFromTemplate

public void copyAllConditionsFromTemplate(java.lang.String planids)
                                   throws java.lang.Exception

Copies all conditions from a template based on the provided plan IDs.

Parameters:

planids - the plan IDs to copy conditions from

Throws:

java.lang.Exception - if an error occurs during the copy process

copyAllConditionsFromTemplate

public void copyAllConditionsFromTemplate(java.lang.String planids,
                                          boolean includeAllTimepoints)
                                   throws java.lang.Exception

Copies the conditions from a template to the current instance of ConditionAxis.

Parameters:

planids - a string of plan IDs separated by ";"

includeAllTimepoints - specifies whether to copy all time points or only those with at least one plan item defined

Throws:

java.lang.Exception - if an error occurs during the copying process

copyConditionsFromTemplate

public void copyConditionsFromTemplate(java.lang.String planids,
                                       java.lang.String conditionList)
                                throws java.lang.Exception

Copies the conditions from a template to the current instance of ConditionAxis.

Parameters:

planids - a string of plan IDs separated by ";"

conditionList - a string of condition IDs separated by ";"

Throws:

java.lang.Exception - if an error occurs during the copying process

copyConditionsFromTemplate

public void copyConditionsFromTemplate(java.lang.String planids,
                                       java.lang.String conditionList,
                                       boolean includeAllTimePoints)
                                throws java.lang.Exception

Copies the conditions from a template to the current instance of ConditionAxis.

Parameters:

planids - a string of plan IDs separated by ";"

conditionList - a string of condition IDs separated by ";"

includeAllTimePoints - specifies whether to copy all time points or only those with at least one plan item defined

Throws:

java.lang.Exception - if an error occurs during the copying process

getTaskDefaults

public PropertyList getTaskDefaults(java.lang.String conditionid,
                                    java.lang.String propertyTreeid)

Gets a COPY of the default properties for the selected Task for a specific condition. IMPORTANT: Any changes to the returned PropertyList will NOT be honored by the API until the setTaskDefault() method is called.

Parameters:

conditionid - the id of the condition

propertyTreeid - the id of the task

Returns:

the task default properties

Throws:

SapphireException

getTaskDefaults

public PropertyList getTaskDefaults(java.lang.String conditionid,
                                    java.lang.String propertyTreeid,
                                    boolean collapseAncestors)

Gets a copy of the default properties for the selected Task for a specific condition. IMPORTANT: If not collapsing ancestors, any changes to the returned PropertyList will NOT be honored by the API until the setTaskDefault() method is called.

Parameters:

conditionid - the id of the condition

propertyTreeid - the id of the task

collapseAncestors - whether to include all properties including those from the plan defaults and above.

Returns:

the task default properties

Throws:

SapphireException

setTaskDefaults

public void setTaskDefaults(java.lang.String conditionid,
                            java.lang.String propertyTreeid,
                            PropertyList propertyList)

Sets the task default properties for a column Note that if any collectionitem is missing an internal-id or sequence number, this method will fill those in

Parameters:

conditionid - the id of the condition

propertyTreeid - The id of the task

propertyList - The task defaults

findRowById

public int findRowById(java.lang.String conditionid)

getConditionId

public java.lang.String getConditionId(int row)

size

public int size()

getConditionIds

public java.lang.String[] getConditionIds()

getConditionAxisItems

public DataStore getConditionAxisItems()

Retrieves the condition axis items from the data store.

Returns:

The condition axis items stored in the data store.

findConditionIdByProtocolPlanConditionId

public java.lang.String findConditionIdByProtocolPlanConditionId(java.lang.String protocolPlanConditionId)

Finds the condition ID by the given protocol plan condition ID.

Parameters:

protocolPlanConditionId - the protocol plan condition ID

Returns:

the schedule condition ID associated with the given protocol plan condition ID

editItem

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

Edits an item at the specified row in the condition axis.

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

addItem

public int addItem(java.util.HashMap values)

Adds an item to the condition axis.

Parameters:

values - the values of the item to be added