Package com.sas.lsaf.clinical.study

Class StudyComponentEditableStatus

java.lang.Object

com.sas.lsaf.clinical.study.StudyComponentEditableStatus

All Implemented Interfaces:

Serializable

public class StudyComponentEditableStatus
extends Object
implements Serializable

The class that represents the editable state of a study component. A study component must be set as editable before the component can be updated. The editable status indicates whether the component is being edited, by whom, and when it was marked for editing.

Since:

2.2

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StudyComponentEditableStatus(boolean isBeingEdited, String editedBy, Date editStartDate)	It is not intended or recommended that the consumer of the API construct these objects.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getEditedBy()	Gets the user who is editing the study component.
Date	getEditStartDate()	Gets the date on which the study component was marked for editing.
int	hashCode()
boolean	isBeingEdited()	Indicates whether the study component is being edited.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StudyComponentEditableStatus

public StudyComponentEditableStatus(boolean isBeingEdited,
 String editedBy,
 Date editStartDate)

It is not intended or recommended that the consumer of the API construct these objects. They should deal only with the StudyComponentEditableStatus returned by the API.

Parameters:

isBeingEdited - Indicates whether the study component is being edited.

editedBy - If the study component is being edited, the userId of the user who is editing it. Otherwise, null.

editStartDate - If the study component is being edited, the date on which it was marked for editing. Otherwise, null.

Method Details

isBeingEdited

public boolean isBeingEdited()

Indicates whether the study component is being edited.

Returns:

True, if the study component is being edited, false otherwise.

getEditedBy

public String getEditedBy()

Gets the user who is editing the study component. If the study component is not being edited, null is returned.

Returns:

The userId of the user who is editing the study component, if it is being edited. Otherwise, null.

getEditStartDate

public Date getEditStartDate()

Gets the date on which the study component was marked for editing. If the study component is not being edited, null is returned.

Returns:

The date on which the study component was marked for editing, if it is being edited. Otherwise, null.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object