blackboard.data.content
Class AggregateReviewStatus

java.lang.Object
  extended by blackboard.data.BbObject
      extended by blackboard.data.content.AggregateReviewStatus
All Implemented Interfaces:
IBbObject, Identifiable, java.io.Serializable, java.lang.Cloneable

public class AggregateReviewStatus
extends BbObject

The AggregateReviewStatus object wraps the state of a user's interaction with a given piece of content and adaptive release status.

It is not a persistent object in the ordinary sense; it is loaded from the database, but combines information derived from different sources. With this in mind, one cannot "save" a AggregateReviewStatus object.

Since:
Bb 6.3
See Also:
Serialized Form

Field Summary
static DataType DATA_TYPE
           
 
Fields inherited from class blackboard.data.BbObject
_bbAttributes
 
Constructor Summary
AggregateReviewStatus()
          Default constructor.
 
Method Summary
 Id getCourseId()
          Returns the course id that this status is attached to
 DataType getDataType()
          Returns the DataType identifier for the given BbObject-derived object.
 int getReviewableCount()
          Returns the number of content items the user can review.
 int getReviewedCount()
          Returns the number of content items the user has reviewed.
 Id getUserId()
          The id of the user this status is for.
 
Methods inherited from class blackboard.data.BbObject
clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, matches, persist, setCreatedDate, setId, setModifiedDate, toString, validate
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DATA_TYPE

public static final DataType DATA_TYPE
Constructor Detail

AggregateReviewStatus

public AggregateReviewStatus()
Default constructor. This method is public because of requirements in the persistence framework. Instantiating on object in this way is not very useful, since the data cannot be persisted.

If you need to access status for a particular piece of content, use ContentDbLoader or AggregateReviewStatusDbLoader

Method Detail

getDataType

public DataType getDataType()
Description copied from class: BbObject
Returns the DataType identifier for the given BbObject-derived object. Can be used to uniquely identify the "type" of a data object.

Specified by:
getDataType in interface IBbObject
Specified by:
getDataType in interface Identifiable
Specified by:
getDataType in class BbObject
Returns:
the DataType for current object

getReviewableCount

public int getReviewableCount()
Returns the number of content items the user can review.

Returns:
Reviewable count.

getReviewedCount

public int getReviewedCount()
Returns the number of content items the user has reviewed.

Returns:
Reviewed count.

getUserId

public Id getUserId()
The id of the user this status is for. This value may be unset, even if loaded with a specific user id. That indicates that there is no "review" record for the user.

Returns:
Id of the user. May be unset.

getCourseId

public Id getCourseId()
Returns the course id that this status is attached to

Returns:
Course id


Copyright © 2012 Blackboard, Inc. All Rights Reserved.