Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
ReviewAssignment Class Reference
Inheritance diagram for ReviewAssignment:
DataObject

Public Member Functions

 getCancelled ()
 
 getComments ()
 
 getCompetingInterests ()
 
 getDateAcknowledged ()
 
 getDateAssigned ()
 
 getDateCompleted ()
 
 getDateConfirmed ()
 
 getDateDue ()
 
 getDateNotified ()
 
 getDateRated ()
 
 getDateReminded ()
 
 getDateResponseDue ()
 
 getDeclined ()
 
 getLastModified ()
 
 getLocalizedRecommendation ()
 
 getQuality ()
 
 getRecommendation ()
 
 getReminderWasAutomatic ()
 
 getReplaced ()
 
 getReviewerFullName ()
 
 getReviewerId ()
 
 getReviewerRecommendationOptions ()
 
 getReviewFormId ()
 
 getReviewMethod ()
 
 getReviewRoundId ()
 
 getRound ()
 
 getStageId ()
 
 getSubmissionId ()
 
 getUnconsidered ()
 
 getWeeksDue ()
 
 ReviewAssignment ()
 
 setCancelled ($cancelled)
 
 setComments ($comments)
 
 setCompetingInterests ($competingInterests)
 
 setDateAcknowledged ($dateAcknowledged)
 
 setDateAssigned ($dateAssigned)
 
 setDateCompleted ($dateCompleted)
 
 setDateConfirmed ($dateConfirmed)
 
 setDateDue ($dateDue)
 
 setDateNotified ($dateNotified)
 
 setDateRated ($dateRated)
 
 setDateReminded ($dateReminded)
 
 setDateResponseDue ($dateResponseDue)
 
 setDeclined ($declined)
 
 setLastModified ($dateModified)
 
 setQuality ($quality)
 
 setRecommendation ($recommendation)
 
 setReminderWasAutomatic ($wasAutomatic)
 
 setReplaced ($replaced)
 
 setReviewerFullName ($reviewerFullName)
 
 setReviewerId ($reviewerId)
 
 setReviewFormId ($reviewFormId)
 
 setReviewMethod ($method)
 
 setReviewRoundId ($reviewRoundId)
 
 setRound ($round)
 
 setStageId ($stageId)
 
 setSubmissionId ($submissionId)
 
 setUnconsidered ($unconsidered)
 
 stampModified ()
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Describes review assignment properties.

See Also
ReviewAssignmentDAO

Definition at line 38 of file ReviewAssignment.inc.php.

Member Function Documentation

ReviewAssignment::getCancelled ( )

Get the cancelled value.

Returns
boolean

Definition at line 430 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getComments ( )

Get reviewer comments.

Returns
string

Definition at line 103 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getCompetingInterests ( )

Get competing interests.

Returns
string

Definition at line 119 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getDateAcknowledged ( )

Get the reviewer's acknowledged date.

Returns
string

Definition at line 318 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getDateAssigned ( )

Get the reviewer's assigned date.

Returns
string

Definition at line 254 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getDateCompleted ( )

Get the reviewer's completed date.

Returns
string

Definition at line 302 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getDateConfirmed ( )

Get the reviewer's confirmed date.

Returns
string

Definition at line 286 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getDateDue ( )

Get the reviewer's due date.

Returns
string

Definition at line 350 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by getWeeksDue().

ReviewAssignment::getDateNotified ( )

Get the reviewer's notified date.

Returns
string

Definition at line 270 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getDateRated ( )

Get the date the reviewer was rated.

Returns
string

Definition at line 215 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getDateReminded ( )

Get the reviewer's last reminder date.

Returns
string

Definition at line 334 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getDateResponseDue ( )

Get the reviewer's response due date.

Returns
string

Definition at line 366 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getDeclined ( )

Get the declined value.

Returns
boolean

Definition at line 382 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getLastModified ( )

Get the date of the last modification.

Returns
date

Definition at line 231 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getLocalizedRecommendation ( )

Return a localized string representing the reviewer recommendation.

Definition at line 526 of file ReviewAssignment.inc.php.

References getRecommendation().

ReviewAssignment::getQuality ( )

Get quality.

Returns
int

Definition at line 446 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getRecommendation ( )

Get reviewer recommendation.

Returns
string

Definition at line 183 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by getLocalizedRecommendation().

ReviewAssignment::getReminderWasAutomatic ( )

Get a boolean indicating whether or not the last reminder was automatic.

Returns
boolean

Definition at line 414 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getReplaced ( )

Get the replaced value.

Returns
boolean

Definition at line 398 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getReviewerFullName ( )

Get full name of reviewer.

Returns
string

Definition at line 87 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getReviewerId ( )

Get ID of reviewer.

Returns
int

Definition at line 71 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getReviewerRecommendationOptions ( )

Get an associative array matching reviewer recommendation codes with locale strings. (Includes default '' => "Choose One" string.)

Returns
array recommendation => localeString

Definition at line 509 of file ReviewAssignment.inc.php.

Referenced by ReviewerReviewStep3Form\fetch().

ReviewAssignment::getReviewFormId ( )

Get review form id.

Returns
int

Definition at line 478 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getReviewMethod ( )

Get the method of the review (open, blind, or double-blind).

Returns
int

Definition at line 151 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getReviewRoundId ( )

Get review round id.

Returns
int

Definition at line 167 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getRound ( )

Get round.

Returns
int

Definition at line 462 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getStageId ( )

Get the workflow stage id.

Returns
int

Definition at line 135 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getSubmissionId ( )

Get ID of review assignment's submission.

Returns
int

Definition at line 55 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getUnconsidered ( )

Get unconsidered state.

Returns
int

Definition at line 199 of file ReviewAssignment.inc.php.

References DataObject\getData().

ReviewAssignment::getWeeksDue ( )

Get number of weeks until review is due (or number of weeks overdue).

Returns
int

Definition at line 498 of file ReviewAssignment.inc.php.

References getDateDue().

ReviewAssignment::ReviewAssignment ( )

Constructor.

Definition at line 43 of file ReviewAssignment.inc.php.

ReviewAssignment::setCancelled (   $cancelled)

Set the reviewer's cancelled value.

Parameters
$cancelledboolean

Definition at line 438 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setComments (   $comments)

Set reviewer comments.

Parameters
$commentsstring

Definition at line 111 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setCompetingInterests (   $competingInterests)

Set competing interests.

Parameters
$competingInterestsstring

Definition at line 127 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setDateAcknowledged (   $dateAcknowledged)

Set the reviewer's acknowledged date.

Parameters
$dateAcknowledgedstring

Definition at line 326 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setDateAssigned (   $dateAssigned)

Set the reviewer's assigned date.

Parameters
$dateAssignedstring

Definition at line 262 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setDateCompleted (   $dateCompleted)

Set the reviewer's completed date.

Parameters
$dateCompletedstring

Definition at line 310 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setDateConfirmed (   $dateConfirmed)

Set the reviewer's confirmed date.

Parameters
$dateConfirmedstring

Definition at line 294 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setDateDue (   $dateDue)

Set the reviewer's due date.

Parameters
$dateDuestring

Definition at line 358 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setDateNotified (   $dateNotified)

Set the reviewer's notified date.

Parameters
$dateNotifiedstring

Definition at line 278 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setDateRated (   $dateRated)

Set the date the reviewer was rated.

Parameters
$dateRatedstring

Definition at line 223 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setDateReminded (   $dateReminded)

Set the reviewer's last reminder date.

Parameters
$dateRemindedstring

Definition at line 342 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setDateResponseDue (   $dateResponseDue)

Set the reviewer's response due date.

Parameters
$dateResponseDuestring

Definition at line 374 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setDeclined (   $declined)

Set the reviewer's declined value.

Parameters
$declinedboolean

Definition at line 390 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setLastModified (   $dateModified)

Set the date of the last modification.

Parameters
$dateModifieddate

Definition at line 239 of file ReviewAssignment.inc.php.

References DataObject\setData().

Referenced by stampModified().

ReviewAssignment::setQuality (   $quality)

Set quality.

Parameters
$qualityint

Definition at line 454 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setRecommendation (   $recommendation)

Set reviewer recommendation.

Parameters
$recommendationstring

Definition at line 191 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setReminderWasAutomatic (   $wasAutomatic)

Set the boolean indicating whether or not the last reminder was automatic.

Parameters
$wasAutomaticboolean

Definition at line 422 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setReplaced (   $replaced)

Set the reviewer's replaced value.

Parameters
$replacedboolean

Definition at line 406 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setReviewerFullName (   $reviewerFullName)

Set full name of reviewer.

Parameters
$reviewerFullNamestring

Definition at line 95 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setReviewerId (   $reviewerId)

Set ID of reviewer.

Parameters
$reviewerIdint

Definition at line 79 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setReviewFormId (   $reviewFormId)

Set review form id.

Parameters
$reviewFormIdint

Definition at line 486 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setReviewMethod (   $method)

Set the type of review.

Parameters
$methodint

Definition at line 159 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setReviewRoundId (   $reviewRoundId)

Set review round id.

Parameters
$reviewRoundIdint

Definition at line 175 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setRound (   $round)

Set round.

Parameters
$roundint

Definition at line 470 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setStageId (   $stageId)

Set the workflow stage id.

Parameters
$stageIdint

Definition at line 143 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setSubmissionId (   $submissionId)

Set ID of review assignment's submission

Parameters
$submissionIdint

Definition at line 63 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::setUnconsidered (   $unconsidered)

Set unconsidered state.

Parameters
$unconsideredint

Definition at line 207 of file ReviewAssignment.inc.php.

References DataObject\setData().

ReviewAssignment::stampModified ( )

Stamp the date of the last modification to the current time.

Definition at line 246 of file ReviewAssignment.inc.php.

References Core\getCurrentDate(), and setLastModified().


The documentation for this class was generated from the following file: