com.edustructures.sifworks.common
Class BinaryData

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class BinaryData
extends SIFKeyedElement

Contains the base64Binary encoding of binary or text data not encoded in UTF-8.

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

BinaryData()
Constructor

BinaryData(java.lang.String value)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the Description attribute.
java.lang.String	getFileName() Gets the value of the FileName 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	getValue() Gets the value of the <Value> element.
void	setDescription(java.lang.String value) Sets the value of the Description attribute.
void	setFileName(java.lang.String value) Sets the value of the FileName attribute.
void	setMIMEType(java.lang.String value) Sets the value of the MIMEType attribute.
void	setValue(java.lang.String value) Sets the value of the <Value> 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

BinaryData

public BinaryData()

Constructor

BinaryData

public BinaryData(java.lang.String value)

Constructor that accepts values for all mandatory fields

Parameters:

value - Gets or sets the content value of the <BinaryData> element

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

getValue

public java.lang.String getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <BinaryData> element"

Returns:

The Value element of this object.

Since:

2.0

setValue

public void setValue(java.lang.String value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <BinaryData> element"

Parameters:

value - A String object

Since:

2.0

getMIMEType

public java.lang.String getMIMEType()

Gets the value of the MIMEType attribute.

The SIF specification defines the meaning of this attribute as: "Optional MIME type to specifically indicate the text type. Otherwise text/plain can be assumed."

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: "Optional MIME type to specifically indicate the text type. Otherwise text/plain can be assumed."

Parameters:

value - A String object

Since:

2.0

getFileName

public java.lang.String getFileName()

Gets the value of the FileName attribute.

The SIF specification defines the meaning of this attribute as: "Optional file name to indicate the file from which the content originated, or to suggest a name to use when saving the content."

Returns:

The FileName attribute of this object.

Since:

2.0

setFileName

public void setFileName(java.lang.String value)

Sets the value of the FileName attribute.

The SIF specification defines the meaning of this attribute as: "Optional file name to indicate the file from which the content originated, or to suggest a name to use when saving the 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