com.edustructures.sifworks.infra
Class SIF_Protocol

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.infra.SIF_Protocol

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Protocol
extends SIFKeyedElement

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_Protocol()
Constructor

SIF_Protocol(java.lang.String type, YesNo secure)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Property(SIF_Property value) Adds a new <SIF_Property> child element.
void	addSIF_Property(java.lang.String sifName, java.lang.String sifValue) Adds a new <SIF_Property> repeatable element.
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	getSecure() Gets the value of the Secure attribute.
SIF_Property	getSIF_Property(java.lang.String sifName, java.lang.String sifValue) Gets a SIF_Property object instance.
SIF_Property[]	getSIF_Propertys() Gets all SIF_Property object instances.
java.lang.String	getSIF_URL() Gets the value of the <SIF_URL> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	removeSIF_Property(java.lang.String sifName, java.lang.String sifValue) Removes a SIF_Property object instance.
void	setSecure(java.lang.String value) Sets the value of the Secure attribute as a String.
void	setSecure(YesNo value) Sets the value of the Secure attribute.
void	setSIF_Propertys(SIF_Property[] sif_propertys) Sets an array of SIF_Property objects.
void	setSIF_URL(java.lang.String value) Sets the value of the <SIF_URL> element.
void	setType(java.lang.String value) Sets the value of the Type attribute.

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

SIF_Protocol

public SIF_Protocol()

Constructor

SIF_Protocol

public SIF_Protocol(java.lang.String type,
                    YesNo secure)

Constructor that accepts values for all mandatory fields

Parameters:

type - Identifies the type being used (e.g. "HTTP", "HTTPS", "MSMQ", etc.)

secure - Indicates if the protocol provides a secure channel

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

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Identifies the type being used (e.g. "HTTP", "HTTPS", "MSMQ", etc.)"

Returns:

The Type attribute of this object.

Since:

1.1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Identifies the type being used (e.g. "HTTP", "HTTPS", "MSMQ", etc.)"

Parameters:

value - A String object

Since:

1.1

getSecure

public java.lang.String getSecure()

Gets the value of the Secure attribute.

The SIF specification defines the meaning of this attribute as: "Indicates if the protocol provides a secure channel"

Returns:

The Secure attribute of this object.

Since:

1.1

setSecure

public void setSecure(YesNo value)

Sets the value of the Secure attribute.

The SIF specification defines the meaning of this attribute as: "Indicates if the protocol provides a secure channel"

Parameters:

value - A constant defined by the YesNo class

Since:

1.1

setSecure

public void setSecure(java.lang.String value)

Sets the value of the Secure attribute as a String.

The SIF specification defines the meaning of this attribute as: "Indicates if the protocol provides a secure channel"

Parameters:

value - The value as a String

Since:

1.1

getSIF_URL

public java.lang.String getSIF_URL()

Gets the value of the <SIF_URL> element.

The SIF specification defines the meaning of this element as: "A URL that identifies the SIF_SIFNode"

Returns:

The SIF_URL element of this object.

Since:

1.1

setSIF_URL

public void setSIF_URL(java.lang.String value)

Sets the value of the <SIF_URL> element.

The SIF specification defines the meaning of this element as: "A URL that identifies the SIF_SIFNode"

Parameters:

value - A String object

Since:

1.1

addSIF_Property

public void addSIF_Property(SIF_Property value)

Adds a new <SIF_Property> child element.

The SIF specification defines the meaning of this element as: "A set of properties defined for this protocol"

Parameters:

value - A SIF_Property object

Since:

1.1

addSIF_Property

public void addSIF_Property(java.lang.String sifName,
                            java.lang.String sifValue)

Adds a new <SIF_Property> repeatable element. This form of setSIF_Property is provided as a convenience method that is functionally equivalent to the version of setSIF_Property that accepts a single SIF_Property object.

Parameters:

sifName -

sifValue -

Since:

1.1

removeSIF_Property

public void removeSIF_Property(java.lang.String sifName,
                               java.lang.String sifValue)

Removes a SIF_Property object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

sifName - Identifies the SIF_Property object to remove by its SIF_Name value

sifValue - Identifies the SIF_Property object to remove by its SIF_Value value

Since:

1.1

getSIF_Property

public SIF_Property getSIF_Property(java.lang.String sifName,
                                    java.lang.String sifValue)

Gets a SIF_Property object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

sifName - Identifies the SIF_Property object to return by its "SIF_Name" attribute value

sifValue - Identifies the SIF_Property object to return by its "SIF_Value" attribute value

Returns:

A SIF_Property object

Since:

1.1

getSIF_Propertys

public SIF_Property[] getSIF_Propertys()

Gets all SIF_Property object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of SIF_Property objects

Since:

1.1

setSIF_Propertys

public void setSIF_Propertys(SIF_Property[] sif_propertys)

Sets an array of SIF_Property objects. All existing SIF_Property instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all SIF_Propertys.

Since:

1.1