com.edustructures.sifworks.common
Class Reference

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.common.Reference

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Reference
extends SIFKeyedElement

References external content via a URL.

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Reference()
Constructor

Reference(java.lang.String url)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the Description attribute.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.String	getMIMEType() Gets the value of the MIMEType attribute.
java.lang.String	getURL() Gets the value of the <URL> element.
void	setDescription(java.lang.String value) Sets the value of the Description attribute.
void	setMIMEType(java.lang.String value) Sets the value of the MIMEType attribute.
void	setURL(java.lang.String value) Sets the value of the <URL> element.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Reference

public Reference()

Constructor

Reference

public Reference(java.lang.String url)

Constructor that accepts values for all mandatory fields

Parameters:

url - Location of external content.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getMIMEType

public java.lang.String getMIMEType()

Gets the value of the MIMEType attribute.

The SIF specification defines the meaning of this attribute as: "MIME type to indicate the content type to be expected when retrieving the external content."

Returns:

The MIMEType attribute of this object.

Since:

2.0

setMIMEType

public void setMIMEType(java.lang.String value)

Sets the value of the MIMEType attribute.

The SIF specification defines the meaning of this attribute as: "MIME type to indicate the content type to be expected when retrieving the external content."

Parameters:

value - A String object

Since:

2.0

getDescription

public java.lang.String getDescription()

Gets the value of the Description attribute.

The SIF specification defines the meaning of this attribute as: "Contains an optional description of the content or a processing hint with regard to its structure (e.g. named standard, file layout or XSD). Contents may be mandated in instances of this type, or types that follow the AbstractContentPackageType pattern."

Returns:

The Description attribute of this object.

Since:

2.0

setDescription

public void setDescription(java.lang.String value)

Sets the value of the Description attribute.

The SIF specification defines the meaning of this attribute as: "Contains an optional description of the content or a processing hint with regard to its structure (e.g. named standard, file layout or XSD). Contents may be mandated in instances of this type, or types that follow the AbstractContentPackageType pattern."

Parameters:

value - A String object

Since:

2.0

getURL

public java.lang.String getURL()

Gets the value of the <URL> element.

The SIF specification defines the meaning of this element as: "Location of external content."

Returns:

The URL element of this object.

Since:

2.0

setURL

public void setURL(java.lang.String value)

Sets the value of the <URL> element.

The SIF specification defines the meaning of this element as: "Location of external content."

Parameters:

value - A String object

Since:

2.0