blackboard.cms.metadata
Class XythosMetadata

java.lang.Object
  blackboard.cms.metadata.XythosMetadata

All Implemented Interfaces:

blackboard.data.IBbObject, blackboard.data.Identifiable, blackboard.platform.forms.FormEditable

public class XythosMetadata
extends java.lang.Object
implements blackboard.data.IBbObject, blackboard.platform.forms.FormEditable

Data encapsulation for information corresponding to they properties that can be dynamically associated with xythos entities.

Field Summary

protected blackboard.data.BbAttributes	_bbAttributes
static blackboard.persist.DataType	DATA_TYPE

Fields inherited from interface blackboard.platform.forms.FormEditable

FORM_ID_ATTRIBUTE

Constructor Summary

XythosMetadata()
Default constructor

Method Summary

blackboard.persist.Id	getAssociatedFormId()
java.lang.String	getBaseName()
blackboard.data.BbAttributes	getBbAttributes() Returns the BbAttributes associated with this BbObject.
java.util.Calendar	getCreatedDate() Deprecated.
blackboard.persist.DataType	getDataType()
com.xythos.storageServer.api.FileSystemEntry	getFileSystemEntry()
blackboard.persist.Id	getId() Returns the Id associated with this Identifiable object.
java.lang.String	getIdentifier()
java.util.Calendar	getModifiedDate() Returns the date on which this IBbObject was last modified.
java.lang.String	getXythosId()
void	setAssociatedFormId(blackboard.persist.Id formId)
void	setBaseName(java.lang.String val)
void	setCreatedDate(java.util.Calendar cCreatedDate) Deprecated.
void	setFileSystemEntry(com.xythos.storageServer.api.FileSystemEntry val)
void	setId(blackboard.persist.Id id) Sets the Id value for this Identifiable object.
void	setIdentifier(java.lang.String val)
void	setModifiedDate(java.util.Calendar cModifiedDate) Sets the last modified date for this IBbObject.
void	setXythosId(java.lang.String val)
void	validate() Validates the contents of this BbObject.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATA_TYPE

public static final blackboard.persist.DataType DATA_TYPE

_bbAttributes

protected blackboard.data.BbAttributes _bbAttributes

Constructor Detail

XythosMetadata

public XythosMetadata()

Default constructor

Method Detail

getBbAttributes

public blackboard.data.BbAttributes getBbAttributes()

Returns the BbAttributes associated with this BbObject.

Specified by:

getBbAttributes in interface blackboard.data.IBbObject

Returns:

BbAttributes value for this BbObject

getDataType

public blackboard.persist.DataType getDataType()

Specified by:

getDataType in interface blackboard.data.IBbObject

Specified by:

getDataType in interface blackboard.data.Identifiable

getAssociatedFormId

public blackboard.persist.Id getAssociatedFormId()

Specified by:

getAssociatedFormId in interface blackboard.platform.forms.FormEditable

setAssociatedFormId

public void setAssociatedFormId(blackboard.persist.Id formId)

Specified by:

setAssociatedFormId in interface blackboard.platform.forms.FormEditable

getBaseName

public java.lang.String getBaseName()

setBaseName

public void setBaseName(java.lang.String val)

getIdentifier

public java.lang.String getIdentifier()

setIdentifier

public void setIdentifier(java.lang.String val)

getXythosId

public java.lang.String getXythosId()

setXythosId

public void setXythosId(java.lang.String val)

getFileSystemEntry

public com.xythos.storageServer.api.FileSystemEntry getFileSystemEntry()

setFileSystemEntry

public void setFileSystemEntry(com.xythos.storageServer.api.FileSystemEntry val)

getCreatedDate

public java.util.Calendar getCreatedDate()

Deprecated.

In Bb6, schema level changes have caused a created date value to no longer be a reliable property of all Blackboard objects. As a result, this method should no longer be used as its behavior can not be guaranteed.

Specified by:

getCreatedDate in interface blackboard.data.IBbObject

setCreatedDate

public void setCreatedDate(java.util.Calendar cCreatedDate)

Deprecated.

In Bb6, schema level changes have caused a created date value to no longer be a reliable property of all Blackboard objects. As a result, this method should no longer be used as its behavior can not be guaranteed.

Specified by:

setCreatedDate in interface blackboard.data.IBbObject

getModifiedDate

public java.util.Calendar getModifiedDate()

Returns the date on which this IBbObject was last modified.

Specified by:

getModifiedDate in interface blackboard.data.IBbObject

Returns:

a Calendar representing the modified date of this IBbObject

setModifiedDate

public void setModifiedDate(java.util.Calendar cModifiedDate)

Sets the last modified date for this IBbObject.

The modified date value is controlled by the database (automatically updated by) and should generally not be directly manipulated by code.

Specified by:

setModifiedDate in interface blackboard.data.IBbObject

Parameters:

cModifiedDate - a Calendar to use for the modified date

getId

public blackboard.persist.Id getId()

Returns the Id associated with this Identifiable object.

Specified by:

getId in interface blackboard.data.Identifiable

Returns:

Id value for this Identifiable object

setId

public void setId(blackboard.persist.Id id)

Sets the Id value for this Identifiable object.

Specified by:

setId in interface blackboard.data.Identifiable

Parameters:

id - an Id value to use for this Identifiable object

validate

public void validate()
              throws blackboard.data.ValidationException

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

Specified by:

validate in interface blackboard.data.IBbObject

Throws:

blackboard.data.ValidationException - if validation of this object fails