com.edustructures.sifworks.instr
Class ResourceLocation

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.instr.ResourceLocation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ResourceLocation
extends SIFKeyedElement

Description of location of resource, i.e. location in library or URL, community resource, outside resource supplier.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

ResourceLocation()
Constructor

ResourceLocation(ReferenceType referenceType, java.lang.String value)
Constructor that accepts values for all mandatory fields

Method Summary

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	getReferenceType() Gets the value of the ReferenceType attribute.
java.lang.String	getValue() Gets the value of the <Value> element.
void	setReferenceType(ReferenceType value) Sets the value of the ReferenceType attribute.
void	setReferenceType(java.lang.String value) Sets the value of the ReferenceType attribute as a String.
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

ResourceLocation

public ResourceLocation()

Constructor

ResourceLocation

public ResourceLocation(ReferenceType referenceType,
                        java.lang.String value)

Constructor that accepts values for all mandatory fields

Parameters:

referenceType - A qualifying attribute for the ResourceLocation payload. If ReferenceType is "URI", the payload contains a web address where the resource can be found.

value - Gets or sets the content value of the <ResourceLocation> 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 <ResourceLocation> element"

Returns:

The Value element of this object.

Since:

1.5r1

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 <ResourceLocation> element"

Parameters:

value - A String object

Since:

1.5r1

getReferenceType

public java.lang.String getReferenceType()

Gets the value of the ReferenceType attribute.

The SIF specification defines the meaning of this attribute as: "A qualifying attribute for the ResourceLocation payload. If ReferenceType is "URI", the payload contains a web address where the resource can be found."

Returns:

The ReferenceType attribute of this object.

Since:

1.5r1

setReferenceType

public void setReferenceType(ReferenceType value)

Sets the value of the ReferenceType attribute.

The SIF specification defines the meaning of this attribute as: "A qualifying attribute for the ResourceLocation payload. If ReferenceType is "URI", the payload contains a web address where the resource can be found."

Parameters:

value - A constant defined by the ReferenceType class

Since:

1.5r1

setReferenceType

public void setReferenceType(java.lang.String value)

Sets the value of the ReferenceType attribute as a String.

The SIF specification defines the meaning of this attribute as: "A qualifying attribute for the ResourceLocation payload. If ReferenceType is "URI", the payload contains a web address where the resource can be found."

Parameters:

value - The value as a String

Since:

1.5r1