com.edustructures.sifworks.food
Class Customer

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.food.Customer

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Customer
extends SIFElement

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

Customer()
Constructor

Customer(java.lang.String sifRefId, CustomerObjectName sifRefObject)
Constructor that accepts values for all mandatory fields

Method Summary

EarnedStatus	getEarnedStatus() Gets the value of the <EarnedStatus> 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
MealStatus	getMealStatus() Gets the value of the <MealStatus> element.
java.lang.String	getSIF_RefId() Gets the value of the SIF_RefId attribute.
java.lang.String	getSIF_RefObject() Gets the value of the SIF_RefObject attribute.
void	removeEarnedStatus() Removes the EarnedStatus child element previously created by calling setEarnedStatus
void	removeMealStatus() Removes the MealStatus child element previously created by calling setMealStatus
void	setEarnedStatus(EarnedStatus value) Sets the value of the <EarnedStatus> element.
void	setEarnedStatus(YesNoNA type) Sets the value of the <EarnedStatus> child element.
void	setMealStatus(FreeReducedStatus type) Sets the value of the <MealStatus> child element.
void	setMealStatus(MealStatus value) Sets the value of the <MealStatus> element.
void	setSIF_RefId(java.lang.String value) Sets the value of the SIF_RefId attribute.
void	setSIF_RefObject(CustomerObjectName value) Sets the value of the SIF_RefObject attribute.
void	setSIF_RefObject(java.lang.String value) Sets the value of the SIF_RefObject attribute as a String.

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

Customer

public Customer()

Constructor

Customer

public Customer(java.lang.String sifRefId,
                CustomerObjectName sifRefObject)

Constructor that accepts values for all mandatory fields

Parameters:

sifRefId - GUID of the SIF customer type.

sifRefObject - SIF customer type. If the type is StaffPersonalRefId then EarnedStatus is included. If the type is StudentPersonalRefId, then MealStatus in included.

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

getSIF_RefId

public java.lang.String getSIF_RefId()

Gets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID of the SIF customer type."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"Value"
SIF2.0	"SIF_RefId"

Returns:

The SIF_RefId attribute of this object.

Since:

1.5r1

setSIF_RefId

public void setSIF_RefId(java.lang.String value)

Sets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID of the SIF customer type."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"Value"
SIF2.0	"SIF_RefId"

Parameters:

value - A String object

Since:

1.5r1

getSIF_RefObject

public java.lang.String getSIF_RefObject()

Gets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "SIF customer type. If the type is StaffPersonalRefId then EarnedStatus is included. If the type is StudentPersonalRefId, then MealStatus in included."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"Type"
SIF2.0	"SIF_RefObject"

Returns:

The SIF_RefObject attribute of this object.

Since:

1.5r1

setSIF_RefObject

public void setSIF_RefObject(CustomerObjectName value)

Sets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "SIF customer type. If the type is StaffPersonalRefId then EarnedStatus is included. If the type is StudentPersonalRefId, then MealStatus in included."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"Type"
SIF2.0	"SIF_RefObject"

Parameters:

value - A constant defined by the CustomerObjectName class

Since:

1.5r1

setSIF_RefObject

public void setSIF_RefObject(java.lang.String value)

Sets the value of the SIF_RefObject attribute as a String.

The SIF specification defines the meaning of this attribute as: "SIF customer type. If the type is StaffPersonalRefId then EarnedStatus is included. If the type is StudentPersonalRefId, then MealStatus in included."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.5r1	"Type"
SIF2.0	"SIF_RefObject"

Parameters:

value - The value as a String

Since:

1.5r1

setMealStatus

public void setMealStatus(MealStatus value)

Sets the value of the <MealStatus> element.

Parameters:

value - A MealStatus object

Since:

1.5r1

setMealStatus

public void setMealStatus(FreeReducedStatus type)

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

Parameters:

type - Meal status type.

Since:

1.5r1

getMealStatus

public MealStatus getMealStatus()

Gets the value of the <MealStatus> element.

Returns:

A MealStatus object

Since:

1.5r1

removeMealStatus

public void removeMealStatus()

Removes the MealStatus child element previously created by calling setMealStatus

Since:

1.5r1

setEarnedStatus

public void setEarnedStatus(EarnedStatus value)

Sets the value of the <EarnedStatus> element.

Parameters:

value - A EarnedStatus object

Since:

1.5r1

setEarnedStatus

public void setEarnedStatus(YesNoNA type)

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

Parameters:

type - Earned status type.

Since:

1.5r1

getEarnedStatus

public EarnedStatus getEarnedStatus()

Gets the value of the <EarnedStatus> element.

Returns:

An EarnedStatus object

Since:

1.5r1

removeEarnedStatus

public void removeEarnedStatus()

Removes the EarnedStatus child element previously created by calling setEarnedStatus

Since:

1.5r1