blackboard.cms.metadata
Class MetadataTemplate

java.lang.Object
  blackboard.data.BbObject
      blackboard.cms.metadata.MetadataTemplate

All Implemented Interfaces:

java.lang.Cloneable, blackboard.data.IBbObject

public class MetadataTemplate

extends blackboard.data.BbObject

The MetadataTemplate class provides a representation of a metadata key/display name pair within the Blackboard application. Primarily, these objects are used for the Custom Metadata keys that are currently used in the Content System.

Example: Load a MetadataTemplate given Id (as string), update display name and key name:

Id mdtId = bbPm.generateId(blackboard.cms.metadata.MetadataTemplate.DATA_TYPE, strId);
mdt = MetadataTemplateManager.loadById(mdtId);
mdt.setLabel(strDisplayName);
mdt.setKey(strKeyName);
MetadataTemplateManager.save(mdt);


Since:

Bb CS 1.0

Version:

$Revision: $

Field Summary

static blackboard.persist.DataType

DATA_TYPE Object data type constant used in brokering loaders and persisters

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

MetadataTemplate()
Creates an instance of MetadataTemplate with default property values.

Method Summary

blackboard.persist.DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getKey() Returns the key for the MetadataTemplate.
java.lang.String	getLabel() Returns the label for the MetadataTemplate.
void	setKey(java.lang.String str) Sets the key for the MetadataTemplate.
void	setLabel(java.lang.String str) Sets the label for the MetadataTemplate.
void	validate() Validates the contents of this MetadataTemplate.

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 blackboard.persist.DataType DATA_TYPE

Object data type constant used in brokering loaders and persisters

Constructor Detail

MetadataTemplate

public MetadataTemplate()

Creates an instance of MetadataTemplate with default property values.

Method Detail

getLabel

public java.lang.String getLabel()

Returns the label for the MetadataTemplate. The label is the human-readable display name of this MetadataTemplate.

Returns:

a String representing the label for the MetadataTemplate.

setLabel

public void setLabel(java.lang.String str)

Sets the label for the MetadataTemplate. The label is the human-readable display name of this MetadataTemplate.

Parameters:

str - a String representing the label for the MetadataTemplate.

getKey

public java.lang.String getKey()

Returns the key for the MetadataTemplate. The key is the key name of this MetadataTemplate, which be used to distinguish, identify, and categorize these elements.

For example: ims.contributor, dublin_core.content.lifecycle

Returns:

a String representing the key for the MetadataTemplate.

setKey

public void setKey(java.lang.String str)

Sets the key for the MetadataTemplate. The key is the key name of this MetadataTemplate, which be used to distinguish, identify, and categorize these elements.

For example: ims.contributor, dublin_core.content.lifecycle

Parameters:

str - a String representing the key for the MetadataTemplate.

getDataType

public blackboard.persist.DataType getDataType()

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

Returns:

the DataType for this object

validate

public void validate()
              throws blackboard.data.ValidationException

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

Throws:

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