blackboard.data.content
Class EntityContentFile

java.lang.Object
  blackboard.data.BbObject
      blackboard.data.content.AbstractContentFile
          blackboard.data.content.EntityContentFile

All Implemented Interfaces:

IBbObject, Identifiable, java.lang.Cloneable

public class EntityContentFile
extends AbstractContentFile

The EntityContentFile class wraps a reference to a file that has been uploaded to a content area in a course. This object only represents the information in the database used to track the file reference. References to the actual file system objects must be obtained separately.

Note that EntityContentFile objects are only meant to deal with files associated with content. It does not deal with files in other contexts, such as user or group uploads.

Since:

Bb 7.2

Version:

$Revision: #1 $ $Date: 2007/06/27 $

Nested Class Summary

Nested classes/interfaces inherited from class blackboard.data.content.AbstractContentFile

AbstractContentFile.StorageType

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

EntityContentFile()
Default constructor.

Method Summary

DataType	getDataType() Returns the DataType identifier for this object.
Id	getEntityId() Returns the entity Id to which this ContentFile "belongs" (is part of).
void	setEntityId(Id iEntityId) Sets the entity Id value for this ContentFile.
void	validate() Validates the contents of this ContentFile.

Methods inherited from class blackboard.data.content.AbstractContentFile

getLinkName, getName, getSize, getStorageType, setLinkName, setName, setSize, setStorageType

Methods inherited from class blackboard.data.BbObject

clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString

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

EntityContentFile

public EntityContentFile()

Default constructor. Creates an instance of ContentFile with default property values.

Method Detail

getEntityId

public Id getEntityId()

Returns the entity Id to which this ContentFile "belongs" (is part of).

Returns:

content Id value for this content file

setEntityId

public void setEntityId(Id iEntityId)

Sets the entity Id value for this ContentFile.

Parameters:

iEntityId - the entity Id value to use for this content file

getDataType

public DataType getDataType()

Returns the DataType identifier for this object. Can be used to uniquely identify the "type" of this data object.

Specified by:

getDataType in interface IBbObject

Specified by:

getDataType in interface Identifiable

Specified by:

getDataType in class BbObject

Returns:

the DataType for this object

validate

public void validate()
              throws ValidationException

Validates the contents of this ContentFile. Internal consistency checks are also performed.

Specified by:

validate in interface IBbObject

Overrides:

validate in class BbObject

Throws:

ValidationException - if validation of this object fails