com.edustructures.sifworks.hrfin
Class EmployeePicture

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.hrfin.EmployeePicture

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class EmployeePicture
extends SIFDataObject

This object contains information about an employee's picture. SIF_Events are reported.

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

EmployeePicture()
Constructor

EmployeePicture(java.lang.String employeePersonalRefId, PictureSource pictureSource)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getEmployeePersonalRefId() Gets the value of the EmployeePersonalRefId 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
PictureSource	getPictureSource() Gets the value of the <PictureSource> element.
void	removePictureSource() Removes the PictureSource child element previously created by calling setPictureSource
void	setEmployeePersonalRefId(java.lang.String value) Sets the value of the EmployeePersonalRefId attribute.
void	setPictureSource(PictureSource value) Sets the value of the <PictureSource> element.
void	setPictureSource(PictureType type, java.lang.String value) Sets the value of the <PictureSource> child element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getRefId, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

EmployeePicture

public EmployeePicture()

Constructor

EmployeePicture

public EmployeePicture(java.lang.String employeePersonalRefId,
                       PictureSource pictureSource)

Constructor that accepts values for all mandatory fields

Parameters:

employeePersonalRefId - This is the GUID of the Employee whose picture this is.

pictureSource - This element defines the picture. If the Type attribute is URL, this is the location of the picture in [JPEG] format; if Type is JPEG, this is the [JPEG] image data encoded using the Base64 Content-Transfer-Encoding defined in Section 6.8 of [RFC 2045].

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

getEmployeePersonalRefId

public java.lang.String getEmployeePersonalRefId()

Gets the value of the EmployeePersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "This is the GUID of the Employee whose picture this is."

Returns:

The EmployeePersonalRefId attribute of this object.

Since:

1.5r1

setEmployeePersonalRefId

public void setEmployeePersonalRefId(java.lang.String value)

Sets the value of the EmployeePersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "This is the GUID of the Employee whose picture this is."

Parameters:

value - A String object

Since:

1.5r1

setPictureSource

public void setPictureSource(PictureSource value)

Sets the value of the <PictureSource> element.

The SIF specification defines the meaning of this element as: "This element defines the picture. If the Type attribute is URL, this is the location of the picture in [JPEG] format; if Type is JPEG, this is the [JPEG] image data encoded using the Base64 Content-Transfer-Encoding defined in Section 6.8 of [RFC 2045]."

Parameters:

value - A PictureSource object

Since:

1.5r1

setPictureSource

public void setPictureSource(PictureType type,
                             java.lang.String value)

Sets the value of the <PictureSource> child element. This form of setPictureSource is provided as a convenience method that is functionally equivalent to the version of setPictureSource that accepts a single PictureSource object.

Parameters:

type - The way the picture is specified.

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

Since:

1.5r1

getPictureSource

public PictureSource getPictureSource()

Gets the value of the <PictureSource> element.

The SIF specification defines the meaning of this element as: "This element defines the picture. If the Type attribute is URL, this is the location of the picture in [JPEG] format; if Type is JPEG, this is the [JPEG] image data encoded using the Base64 Content-Transfer-Encoding defined in Section 6.8 of [RFC 2045]."

Returns:

A PictureSource object

Since:

1.5r1

removePictureSource

public void removePictureSource()

Removes the PictureSource child element previously created by calling setPictureSource

Since:

1.5r1