com.xerceo.learn
Class SCOData

java.lang.Object
  com.xerceo.learn.SCOData

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class SCOData
extends java.lang.Object
implements java.io.Externalizable

Encapsulates a runtime data model for a SCO as defined by the SCORM 2004 runtime environment specification. A SCOData represents a higher-order view of the SCORM runtime environment data model.

Version:

#xerceo-1.0#

Author:

tim.potter@xerceo.com

See Also:

Serialized Form

Field Summary

int	attempts
CMI	cmi
java.lang.String	courseId
java.lang.String	learnerId
java.lang.String	navRequest
java.lang.String	scoId

Constructor Summary

SCOData()
Do not use! For de-Serialization support only.

Method Summary

boolean	equals(java.lang.Object obj)
CMI	getCMI()
java.lang.String	getCompletionDate(java.util.Locale locale)
java.lang.String	getCourseId()
java.lang.String	getInitialLaunchDate(java.util.Locale locale)
java.lang.String	getKey()
java.lang.String	getLastModifiedDate(java.util.Locale locale)
java.lang.String	getLearnerId()
java.lang.String	getScoId()
java.lang.String	getValue(java.lang.String name)
int	hashCode()
boolean	isSCOComplete()
static SCOData	newInstance(java.lang.String learnerId, java.lang.String courseId, java.lang.String scoId, java.lang.String learnerName, java.lang.String creditMode, InitParams init) Creates a new SCOData instance for a specific learner in a specific course.
void	readExternal(java.io.ObjectInput in)
static SCOData	readInstance(java.io.InputStream in) Reads an existing SCOData instance from a Externalized object byte stream.
void	save(java.io.OutputStream out)
void	setCompletionDate(java.util.Locale locale, java.lang.String date)
void	setInitialLaunchDate(java.util.Locale locale, java.lang.String date)
void	setLastModifiedDate(java.util.Locale locale, java.lang.String date)
void	setValue(java.lang.String name, java.lang.String value)
java.lang.String	toString()
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

learnerId

public java.lang.String learnerId

courseId

public java.lang.String courseId

scoId

public java.lang.String scoId

navRequest

public java.lang.String navRequest

cmi

public CMI cmi

attempts

public int attempts

Constructor Detail

SCOData

public SCOData()

Do not use! For de-Serialization support only. Objects created with this constructor can only be utilized after the readExternal method is called to read an previously externalized instance from an InputStream.

Method Detail

newInstance

public static final SCOData newInstance(java.lang.String learnerId,
                                        java.lang.String courseId,
                                        java.lang.String scoId,
                                        java.lang.String learnerName,
                                        java.lang.String creditMode,
                                        InitParams init)

Creates a new SCOData instance for a specific learner in a specific course.

readInstance

public static final SCOData readInstance(java.io.InputStream in)
                                  throws java.io.IOException

Reads an existing SCOData instance from a Externalized object byte stream.

Parameters:

in - An input stream containing the bytes of an Externalized SCOData instance.

Returns:

A new SCOData instance.

Throws:

java.io.IOException - if an error occurs while reading the Externalized instance from the input stream.

getLastModifiedDate

public java.lang.String getLastModifiedDate(java.util.Locale locale)

setLastModifiedDate

public void setLastModifiedDate(java.util.Locale locale,
                                java.lang.String date)

getInitialLaunchDate

public java.lang.String getInitialLaunchDate(java.util.Locale locale)

setInitialLaunchDate

public void setInitialLaunchDate(java.util.Locale locale,
                                 java.lang.String date)

getCompletionDate

public java.lang.String getCompletionDate(java.util.Locale locale)

setCompletionDate

public void setCompletionDate(java.util.Locale locale,
                              java.lang.String date)

setValue

public void setValue(java.lang.String name,
                     java.lang.String value)

getValue

public java.lang.String getValue(java.lang.String name)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

save

public void save(java.io.OutputStream out)
          throws java.io.IOException

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

getLearnerId

public java.lang.String getLearnerId()

getCourseId

public java.lang.String getCourseId()

getScoId

public java.lang.String getScoId()

getKey

public java.lang.String getKey()

getCMI

public CMI getCMI()

isSCOComplete

public boolean isSCOComplete()