blackboard.cms.metadata
Class XythosMetadata

java.lang.Object
  extended by blackboard.cms.metadata.XythosMetadata
All Implemented Interfaces:
IBbObject, Identifiable, blackboard.platform.forms.FormEditable

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

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


Field Summary
protected  BbAttributes _bbAttributes
           
static DataType DATA_TYPE
           
 
Fields inherited from interface blackboard.platform.forms.FormEditable
FORM_ID_ATTRIBUTE
 
Constructor Summary
XythosMetadata()
          Default constructor
 
Method Summary
 Id getAssociatedFormId()
           
 java.lang.String getBaseName()
           
 BbAttributes getBbAttributes()
          Returns the BbAttributes associated with this BbObject.
 java.util.Calendar getCreatedDate()
          Deprecated. Since 9.1 or before (non-public API)
 DataType getDataType()
          Returns the DataType identifier for the given IBbObject-derived object.
 com.xythos.storageServer.api.FileSystemEntry getFileSystemEntry()
           
 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(Id formId)
           
 void setBaseName(java.lang.String val)
           
 void setCreatedDate(java.util.Calendar cCreatedDate)
          Deprecated. Since 9.1 or before (non-public API)
 void setFileSystemEntry(com.xythos.storageServer.api.FileSystemEntry val)
           
 void setId(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 DataType DATA_TYPE

_bbAttributes

protected BbAttributes _bbAttributes
Constructor Detail

XythosMetadata

public XythosMetadata()
Default constructor

Method Detail

getBbAttributes

public BbAttributes getBbAttributes()
Returns the BbAttributes associated with this BbObject.

Specified by:
getBbAttributes in interface IBbObject
Returns:
BbAttributes value for this BbObject

getDataType

public DataType getDataType()
Description copied from interface: IBbObject
Returns the DataType identifier for the given IBbObject-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
Returns:
the DataType for current object

getAssociatedFormId

public Id getAssociatedFormId()
Specified by:
getAssociatedFormId in interface blackboard.platform.forms.FormEditable

setAssociatedFormId

public void setAssociatedFormId(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

@Deprecated
public java.util.Calendar getCreatedDate()
Deprecated. Since 9.1 or before (non-public API)

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 IBbObject

setCreatedDate

@Deprecated
public void setCreatedDate(java.util.Calendar cCreatedDate)
Deprecated. Since 9.1 or before (non-public API)

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 IBbObject

getModifiedDate

public java.util.Calendar getModifiedDate()
Returns the date on which this IBbObject was last modified.

Specified by:
getModifiedDate in interface 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 IBbObject
Parameters:
cModifiedDate - a Calendar to use for the modified date

getId

public Id getId()
Returns the Id associated with this Identifiable object.

Specified by:
getId in interface Identifiable
Returns:
Id value for this Identifiable object

setId

public void setId(Id id)
Sets the Id value for this Identifiable object.

Specified by:
setId in interface Identifiable
Parameters:
id - an Id value to use for this Identifiable object

validate

public void validate()
              throws ValidationException
Validates the contents of this BbObject. Internal consistency checks are also performed.

Specified by:
validate in interface IBbObject
Throws:
ValidationException - if validation of this object fails


Copyright © 2012 Blackboard, Inc. All Rights Reserved.