Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
PKPReviewAssignment Class Reference
Inheritance diagram for PKPReviewAssignment:
DataObject ReviewAssignment

Public Member Functions

 getCancelled ()
 
 getComments ()
 
 getCompetingInterests ()
 
 getDateAcknowledged ()
 
 getDateAssigned ()
 
 getDateCompleted ()
 
 getDateConfirmed ()
 
 getDateDue ()
 
 getDateNotified ()
 
 getDateRated ()
 
 getDateReminded ()
 
 getDateResponseDue ()
 
 getDeclined ()
 
 getLastModified ()
 
 getMostRecentPeerReviewComment ()
 
 getQuality ()
 
 getRecommendation ()
 
 getRegretMessage ()
 
 getReminderWasAutomatic ()
 
 getReplaced ()
 
getReviewerFile ()
 
 getReviewerFileId ()
 
 getReviewerFileRevisions ()
 
 getReviewerFileViewable ()
 
 getReviewerFullName ()
 
 getReviewerId ()
 
getReviewFile ()
 
 getReviewFileId ()
 
 getReviewFormId ()
 
 getReviewId ()
 
 getReviewMethod ()
 
 getReviewRevision ()
 
 getReviewRoundId ()
 
 getRound ()
 
 getStageId ()
 
 getSubmissionId ()
 
getSuppFiles ()
 
 getUnconsidered ()
 
 getWeeksDue ()
 
 PKPReviewAssignment ()
 
 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)
 
 setMostRecentPeerReviewComment ($peerReviewComment)
 
 setQuality ($quality)
 
 setRecommendation ($recommendation)
 
 setRegretMessage ($regretMessage)
 
 setReminderWasAutomatic ($wasAutomatic)
 
 setReplaced ($replaced)
 
 setReviewerFile ($reviewerFile)
 
 setReviewerFileId ($reviewerFileId)
 
 setReviewerFileRevisions ($reviewerFileRevisions)
 
 setReviewerFileViewable ($reviewerFileViewable)
 
 setReviewerFullName ($reviewerFullName)
 
 setReviewerId ($reviewerId)
 
 setReviewFile ($reviewFile)
 
 setReviewFileId ($reviewFileId)
 
 setReviewFormId ($reviewFormId)
 
 setReviewId ($reviewId)
 
 setReviewMethod ($method)
 
 setReviewRevision ($reviewRevision)
 
 setReviewRoundId ($reviewRoundId)
 
 setRound ($round)
 
 setStageId ($stageId)
 
 setSubmissionId ($submissionId)
 
 setSuppFiles ($suppFiles)
 
 setUnconsidered ($unconsidered)
 
 stampModified ()
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
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()
 

Detailed Description

Describes review assignment properties (abstracted for PKP library).

See Also
ReviewAssignmentDAO

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

Member Function Documentation

PKPReviewAssignment::getCancelled ( )

Get the cancelled value.

Returns
boolean

Definition at line 466 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getComments ( )

Get reviewer comments.

Returns
string

Definition at line 123 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getCompetingInterests ( )

Get competing interests.

Returns
string

Definition at line 139 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getDateAcknowledged ( )

Get the reviewer's acknowledged date.

Returns
string

Definition at line 354 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getDateAssigned ( )

Get the reviewer's assigned date.

Returns
string

Definition at line 290 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getDateCompleted ( )

Get the reviewer's completed date.

Returns
string

Definition at line 338 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getDateConfirmed ( )

Get the reviewer's confirmed date.

Returns
string

Definition at line 322 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getDateDue ( )

Get the reviewer's due date.

Returns
string

Definition at line 386 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

Referenced by getWeeksDue().

PKPReviewAssignment::getDateNotified ( )

Get the reviewer's notified date.

Returns
string

Definition at line 306 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getDateRated ( )

Get the date the reviewer was rated.

Returns
string

Definition at line 251 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getDateReminded ( )

Get the reviewer's last reminder date.

Returns
string

Definition at line 370 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getDateResponseDue ( )

Get the reviewer's response due date.

Returns
string

Definition at line 402 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getDeclined ( )

Get the declined value.

Returns
boolean

Definition at line 418 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getLastModified ( )

Get the date of the last modification.

Returns
date

Definition at line 267 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getMostRecentPeerReviewComment ( )

Get most recent peer review comment.

Returns
ArticleComment

Definition at line 679 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getQuality ( )

Get quality.

Returns
int

Definition at line 514 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getRecommendation ( )

Get reviewer recommendation.

Returns
string

Definition at line 219 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getRegretMessage ( )

Get regret message.

Returns
string

Definition at line 203 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getReminderWasAutomatic ( )

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

Returns
boolean

Definition at line 450 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getReplaced ( )

Get the replaced value.

Returns
boolean

Definition at line 434 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

& PKPReviewAssignment::getReviewerFile ( )

Get reviewer file.

Returns
ArticleFile

Definition at line 615 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getReviewerFileId ( )

Get reviewer file id.

Returns
int

Definition at line 482 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getReviewerFileRevisions ( )

Get all reviewer file revisions.

Returns
array ArticleFiles

Definition at line 632 of file PKPReviewAssignment.inc.php.

PKPReviewAssignment::getReviewerFileViewable ( )

Get reviewer file viewable.

Returns
boolean

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

References DataObject\getData().

PKPReviewAssignment::getReviewerFullName ( )

Get full name of reviewer.

Returns
string

Definition at line 107 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getReviewerId ( )

Get ID of reviewer.

Returns
int

Definition at line 91 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

& PKPReviewAssignment::getReviewFile ( )

Get review file.

Returns
object

Definition at line 562 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getReviewFileId ( )

Get review file id.

Returns
int

Definition at line 546 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getReviewFormId ( )

Get review form id.

Returns
int

Definition at line 595 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getReviewId ( )

Get ID of review assignment.

Returns
int

Definition at line 73 of file PKPReviewAssignment.inc.php.

References DataObject\getId(), and Config\getVar().

PKPReviewAssignment::getReviewMethod ( )

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

Returns
int

Definition at line 171 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getReviewRevision ( )

Get review revision.

Returns
int

Definition at line 579 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getReviewRoundId ( )

Get review round id.

Returns
int

Definition at line 187 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getRound ( )

Get round.

Returns
int

Definition at line 530 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getStageId ( )

Get the workflow stage id.

Returns
int

Definition at line 155 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getSubmissionId ( )

Get ID of review assignment's submission.

Returns
int

Definition at line 57 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

Referenced by ReviewAssignment\getArticleId().

& PKPReviewAssignment::getSuppFiles ( )

Get supplementary files for this article.

Returns
array SuppFiles

Definition at line 648 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getUnconsidered ( )

Get unconsidered state.

Returns
int

Definition at line 235 of file PKPReviewAssignment.inc.php.

References DataObject\getData().

PKPReviewAssignment::getWeeksDue ( )

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

Returns
int

Definition at line 665 of file PKPReviewAssignment.inc.php.

References getDateDue().

PKPReviewAssignment::PKPReviewAssignment ( )

Constructor.

Definition at line 45 of file PKPReviewAssignment.inc.php.

PKPReviewAssignment::setCancelled (   $cancelled)

Set the reviewer's cancelled value.

Parameters
$cancelledboolean

Definition at line 474 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setComments (   $comments)

Set reviewer comments.

Parameters
$commentsstring

Definition at line 131 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setCompetingInterests (   $competingInterests)

Set competing interests.

Parameters
$competingInterestsstring

Definition at line 147 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setDateAcknowledged (   $dateAcknowledged)

Set the reviewer's acknowledged date.

Parameters
$dateAcknowledgedstring

Definition at line 362 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setDateAssigned (   $dateAssigned)

Set the reviewer's assigned date.

Parameters
$dateAssignedstring

Definition at line 298 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setDateCompleted (   $dateCompleted)

Set the reviewer's completed date.

Parameters
$dateCompletedstring

Definition at line 346 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setDateConfirmed (   $dateConfirmed)

Set the reviewer's confirmed date.

Parameters
$dateConfirmedstring

Definition at line 330 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setDateDue (   $dateDue)

Set the reviewer's due date.

Parameters
$dateDuestring

Definition at line 394 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setDateNotified (   $dateNotified)

Set the reviewer's notified date.

Parameters
$dateNotifiedstring

Definition at line 314 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setDateRated (   $dateRated)

Set the date the reviewer was rated.

Parameters
$dateRatedstring

Definition at line 259 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setDateReminded (   $dateReminded)

Set the reviewer's last reminder date.

Parameters
$dateRemindedstring

Definition at line 378 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setDateResponseDue (   $dateResponseDue)

Set the reviewer's response due date.

Parameters
$dateResponseDuestring

Definition at line 410 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setDeclined (   $declined)

Set the reviewer's declined value.

Parameters
$declinedboolean

Definition at line 426 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setLastModified (   $dateModified)

Set the date of the last modification.

Parameters
$dateModifieddate

Definition at line 275 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

Referenced by stampModified().

PKPReviewAssignment::setMostRecentPeerReviewComment (   $peerReviewComment)

Set most recent peer review comment.

Parameters
$peerReviewCommentArticleComment

Definition at line 687 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setQuality (   $quality)

Set quality.

Parameters
$qualityint

Definition at line 522 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setRecommendation (   $recommendation)

Set reviewer recommendation.

Parameters
$recommendationstring

Definition at line 227 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setRegretMessage (   $regretMessage)

Set regret message.

Parameters
$regretMessagestring

Definition at line 211 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReminderWasAutomatic (   $wasAutomatic)

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

Parameters
$wasAutomaticboolean

Definition at line 458 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReplaced (   $replaced)

Set the reviewer's replaced value.

Parameters
$replacedboolean

Definition at line 442 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReviewerFile (   $reviewerFile)

Set reviewer file.

Parameters
$reviewFileArticleFile

Definition at line 624 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReviewerFileId (   $reviewerFileId)

Set reviewer file id.

Parameters
$reviewerFileIdint

Definition at line 490 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReviewerFileRevisions (   $reviewerFileRevisions)

Set all reviewer file revisions.

Parameters
$reviewerFileRevisionsarray ArticleFiles

Definition at line 640 of file PKPReviewAssignment.inc.php.

PKPReviewAssignment::setReviewerFileViewable (   $reviewerFileViewable)

Set reviewer file viewable.

Parameters
$reviewerFileViewableboolean

Definition at line 506 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReviewerFullName (   $reviewerFullName)

Set full name of reviewer.

Parameters
$reviewerFullNamestring

Definition at line 115 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReviewerId (   $reviewerId)

Set ID of reviewer.

Parameters
$reviewerIdint

Definition at line 99 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReviewFile (   $reviewFile)

Set review file.

Parameters
$reviewFileobject

Definition at line 571 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReviewFileId (   $reviewFileId)

Set review file id.

Parameters
$reviewFileIdint

Definition at line 554 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReviewFormId (   $reviewFormId)

Set review form id.

Parameters
$reviewFormIdint

Definition at line 603 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReviewId (   $reviewId)

Set ID of review assignment

Parameters
$reviewIdint

Definition at line 82 of file PKPReviewAssignment.inc.php.

References Config\getVar(), and DataObject\setId().

PKPReviewAssignment::setReviewMethod (   $method)

Set the type of review.

Parameters
$methodint

Definition at line 179 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReviewRevision (   $reviewRevision)

Set review revision.

Parameters
$reviewRevisionint

Definition at line 587 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setReviewRoundId (   $reviewRoundId)

Set review round id.

Parameters
$reviewRoundIdint

Definition at line 195 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setRound (   $round)

Set round.

Parameters
$roundint

Definition at line 538 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setStageId (   $stageId)

Set the workflow stage id.

Parameters
$stageIdint

Definition at line 163 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setSubmissionId (   $submissionId)

Set ID of review assignment's submission

Parameters
$submissionIdint

Definition at line 65 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

Referenced by ReviewAssignment\setArticleId().

PKPReviewAssignment::setSuppFiles (   $suppFiles)

Set supplementary file for this article.

Parameters
$suppFilesarray SuppFiles

Definition at line 657 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::setUnconsidered (   $unconsidered)

Set unconsidered state.

Parameters
$unconsideredint

Definition at line 243 of file PKPReviewAssignment.inc.php.

References DataObject\setData().

PKPReviewAssignment::stampModified ( )

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

Definition at line 282 of file PKPReviewAssignment.inc.php.

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


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