ReviewAssignment Class Reference
[Submission]

Describes review assignment properties. More...

List of all members.

Public Member Functions
	getCancelled ()
	getComments ()
	getDateAcknowledged ()
	getDateAssigned ()
	getDateCompleted ()
	getDateConfirmed ()
	getDateDue ()
	getDateNotified ()
	getDateRated ()
	getDateReminded ()
	getDeclined ()
	getLastModified ()
	getMostRecentPeerReviewComment ()
	getPaperId ()
	getQuality ()
	getRecommendation ()
	getReminderWasAutomatic ()
	getReplaced ()
&	getReviewerFile ()
	getReviewerFileId ()
	getReviewerFileRevisions ()
	getReviewerFileViewable ()
	getReviewerFullName ()
	getReviewerId ()
&	getReviewerRatingOptions ()
&	getReviewerRecommendationOptions ()
&	getReviewFile ()
	getReviewFileId ()
	getReviewFormId ()
	getReviewId ()
	getReviewRevision ()
	getStage ()
&	getSuppFiles ()
	getWeeksDue ()
	ReviewAssignment ()
	setCancelled ($cancelled)
	setComments ($comments)
	setDateAcknowledged ($dateAcknowledged)
	setDateAssigned ($dateAssigned)
	setDateCompleted ($dateCompleted)
	setDateConfirmed ($dateConfirmed)
	setDateDue ($dateDue)
	setDateNotified ($dateNotified)
	setDateRated ($dateRated)
	setDateReminded ($dateReminded)
	setDeclined ($declined)
	setLastModified ($dateModified)
	setMostRecentPeerReviewComment ($peerReviewComment)
	setPaperId ($paperId)
	setQuality ($quality)
	setRecommendation ($recommendation)
	setReminderWasAutomatic ($wasAutomatic)
	setReplaced ($replaced)
	setReviewerFile ($reviewerFile)
	setReviewerFileId ($reviewerFileId)
	setReviewerFileRevisions ($reviewerFileRevisions)
	setReviewerFileViewable ($reviewerFileViewable)
	setReviewerFullName ($reviewerFullName)
	setReviewerId ($reviewerId)
	setReviewFile ($reviewFile)
	setReviewFileId ($reviewFileId)
	setReviewFormId ($reviewFormId)
	setReviewId ($reviewId)
	setReviewRevision ($reviewRevision)
	setStage ($stage)
	setSuppFiles ($suppFiles)
	stampModified ()
Public Attributes
	$reviewerFileRevisions

---

Detailed Description

Describes review assignment properties.

See also:

ReviewAssignmentDAO

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

---

Member Function Documentation

ReviewAssignment.getCancelled

(

)

Get the cancelled value.

Returns:

boolean

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

ReviewAssignment.getComments

(

)

Get reviewer comments.

Returns:

string

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

ReviewAssignment.getDateAcknowledged

(

)

Get the reviewer's acknowledged date.

Returns:

string

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

ReviewAssignment.getDateAssigned

(

)

Get the reviewer's assigned date.

Returns:

string

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

ReviewAssignment.getDateCompleted

(

)

Get the reviewer's completed date.

Returns:

string

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

ReviewAssignment.getDateConfirmed

(

)

Get the reviewer's confirmed date.

Returns:

string

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

ReviewAssignment.getDateDue

(

)

Get the reviewer's due date.

Returns:

string

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

Referenced by getWeeksDue().

ReviewAssignment.getDateNotified

(

)

Get the reviewer's notified date.

Returns:

string

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

ReviewAssignment.getDateRated

(

)

Get the date the reviewer was rated.

Returns:

string

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

ReviewAssignment.getDateReminded

(

)

Get the reviewer's last reminder date.

Returns:

string

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

ReviewAssignment.getDeclined

(

)

Get the declined value.

Returns:

boolean

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

ReviewAssignment.getLastModified

(

)

Get the date of the last modification.

Returns:

date

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

ReviewAssignment.getMostRecentPeerReviewComment

(

)

Get most recent peer review comment.

Returns:

PaperComment

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

ReviewAssignment.getPaperId

(

)

Get ID of paper.

Returns:

int

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

ReviewAssignment.getQuality

(

)

Get quality.

Returns:

int

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

ReviewAssignment.getRecommendation

(

)

Get reviewer recommendation.

Returns:

string

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

ReviewAssignment.getReminderWasAutomatic

(

)

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

Returns:

boolean

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

ReviewAssignment.getReplaced

(

)

Get the replaced value.

Returns:

boolean

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

& ReviewAssignment.getReviewerFile

(

)

Get reviewer file.

Returns:

PaperFile

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

ReviewAssignment.getReviewerFileId

(

)

Get reviewer file id.

Returns:

int

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

ReviewAssignment.getReviewerFileRevisions

(

)

Get all reviewer file revisions.

Returns:

array PaperFiles

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

ReviewAssignment.getReviewerFileViewable

(

)

Get reviewer file viewable.

Returns:

boolean

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

ReviewAssignment.getReviewerFullName

(

)

Get full name of reviewer.

Returns:

string

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

ReviewAssignment.getReviewerId

(

)

Get ID of reviewer.

Returns:

int

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

& ReviewAssignment.getReviewerRatingOptions

(

)

Get an associative array matching reviewer rating codes with locale strings.

Returns:

array recommendation => localeString

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

Referenced by SubmissionEditHandler.submissionRegrets(), and SubmissionEditHandler.submissionReview().

& 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 577 of file ReviewAssignment.inc.php.

Referenced by ReviewReportPlugin.display(), SubmissionEditHandler.enterReviewerRecommendation(), ReviewerHandler.index(), ReviewerAction.recordRecommendation(), SubmissionReviewHandler.submission(), SubmissionEditHandler.submissionRegrets(), and SubmissionEditHandler.submissionReview().

& ReviewAssignment.getReviewFile

(

)

Get review file.

Returns:

object

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

ReviewAssignment.getReviewFileId

(

)

Get review file id.

Returns:

int

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

ReviewAssignment.getReviewFormId

(

)

Get review form id.

Returns:

int

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

ReviewAssignment.getReviewId

(

)

Get ID of review assignment.

Returns:

int

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

ReviewAssignment.getReviewRevision

(

)

Get review revision.

Returns:

int

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

ReviewAssignment.getStage

(

)

Get stage.

Returns:

int

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

& ReviewAssignment.getSuppFiles

(

)

Get supplementary files for this paper.

Returns:

array SuppFiles

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

ReviewAssignment.getWeeksDue

(

)

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

Returns:

int

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

References getDateDue().

ReviewAssignment.ReviewAssignment

(

)

Constructor.

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

ReviewAssignment.setCancelled

(

$

cancelled

)

Set the reviewer's cancelled value.

Parameters:

$cancelled

boolean

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

ReviewAssignment.setComments

(

$

comments

)

Set reviewer comments.

Parameters:

$comments

string

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

ReviewAssignment.setDateAcknowledged

(

$

dateAcknowledged

)

Set the reviewer's acknowledged date.

Parameters:

$dateAcknowledged

string

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

ReviewAssignment.setDateAssigned

(

$

dateAssigned

)

Set the reviewer's assigned date.

Parameters:

$dateAssigned

string

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

ReviewAssignment.setDateCompleted

(

$

dateCompleted

)

Set the reviewer's completed date.

Parameters:

$dateCompleted

string

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

ReviewAssignment.setDateConfirmed

(

$

dateConfirmed

)

Set the reviewer's confirmed date.

Parameters:

$dateConfirmed

string

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

ReviewAssignment.setDateDue

(

$

dateDue

)

Set the reviewer's due date.

Parameters:

$dateDue

string

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

ReviewAssignment.setDateNotified

(

$

dateNotified

)

Set the reviewer's notified date.

Parameters:

$dateNotified

string

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

ReviewAssignment.setDateRated

(

$

dateRated

)

Set the date the reviewer was rated.

Parameters:

$dateRated

string

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

ReviewAssignment.setDateReminded

(

$

dateReminded

)

Set the reviewer's last reminder date.

Parameters:

$dateReminded

string

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

ReviewAssignment.setDeclined

(

$

declined

)

Set the reviewer's declined value.

Parameters:

$declined

boolean

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

ReviewAssignment.setLastModified

(

$

dateModified

)

Set the date of the last modification.

Parameters:

$dateModified

date

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

Referenced by stampModified().

ReviewAssignment.setMostRecentPeerReviewComment

(

$

peerReviewComment

)

Set most recent peer review comment.

Parameters:

$peerReviewComment

PaperComment

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

ReviewAssignment.setPaperId

(

$

paperId

)

Set ID of paper.

Parameters:

$paperId

int

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

ReviewAssignment.setQuality

(

$

quality

)

Set quality.

Parameters:

$quality

int

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

ReviewAssignment.setRecommendation

(

$

recommendation

)

Set reviewer recommendation.

Parameters:

$recommendation

string

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

ReviewAssignment.setReminderWasAutomatic

(

$

wasAutomatic

)

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

Parameters:

$wasAutomatic

boolean

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

ReviewAssignment.setReplaced

(

$

replaced

)

Set the reviewer's replaced value.

Parameters:

$replaced

boolean

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

ReviewAssignment.setReviewerFile

(

$

reviewerFile

)

Set reviewer file.

Parameters:

$reviewFile

PaperFile

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

ReviewAssignment.setReviewerFileId

(

$

reviewerFileId

)

Set reviewer file id.

Parameters:

$reviewerFileId

int

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

ReviewAssignment.setReviewerFileRevisions

(

$

reviewerFileRevisions

)

Set all reviewer file revisions.

Parameters:

$reviewerFileRevisions

array PaperFiles

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

References $reviewerFileRevisions.

ReviewAssignment.setReviewerFileViewable

(

$

reviewerFileViewable

)

Set reviewer file viewable.

Parameters:

$reviewerFileViewable

boolean

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

ReviewAssignment.setReviewerFullName

(

$

reviewerFullName

)

Set full name of reviewer.

Parameters:

$reviewerFullName

string

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

ReviewAssignment.setReviewerId

(

$

reviewerId

)

Set ID of reviewer.

Parameters:

$reviewerId

int

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

ReviewAssignment.setReviewFile

(

$

reviewFile

)

Set review file.

Parameters:

$reviewFile

object

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

ReviewAssignment.setReviewFileId

(

$

reviewFileId

)

Set review file id.

Parameters:

$reviewFileId

int

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

ReviewAssignment.setReviewFormId

(

$

reviewFormId

)

Set review form id.

Parameters:

$reviewFormId

int

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

ReviewAssignment.setReviewId

(

$

reviewId

)

Set ID of review assignment

Parameters:

$reviewId

int

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

ReviewAssignment.setReviewRevision

(

$

reviewRevision

)

Set review revision.

Parameters:

$reviewRevision

int

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

ReviewAssignment.setStage

(

$

stage

)

Set stage.

Parameters:

$stage

int

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

ReviewAssignment.setSuppFiles

(

$

suppFiles

)

Set supplementary file for this paper.

Parameters:

$suppFiles

array SuppFiles

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

ReviewAssignment.stampModified

(

)

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

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

References setLastModified().

---

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

• classes/submission/reviewAssignment/ReviewAssignment.inc.php

---