com.edustructures.sifworks.hrfin
Class Purchasing

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Purchasing
extends SIFDataObject

This object provides information down to the line-item level for requisitions and purchase orders. 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

Purchasing()
Constructor

Purchasing(java.lang.String refId, FormType formType, java.lang.String formNumber, PurchasingItems purchasingItems)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getEmployeePersonalRefId() Gets the value of the <EmployeePersonalRefId> element.
java.lang.String	getFiscalYearRefId() Gets the value of the <FiscalYearRefId> element.
java.lang.String	getFormNumber() Gets the value of the <FormNumber> element.
java.lang.String	getFormType() Gets the value of the <FormType> 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	getLocationInfoRefId() Gets the value of the <LocationInfoRefId> element.
PurchasingItems	getPurchasingItems() Gets the value of the <PurchasingItems> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getVendorInfoRefId() Gets the value of the <VendorInfoRefId> element.
void	removePurchasingItems() Removes the PurchasingItems child element previously created by calling setPurchasingItems
void	setEmployeePersonalRefId(java.lang.String value) Sets the value of the <EmployeePersonalRefId> element.
void	setFiscalYearRefId(java.lang.String value) Sets the value of the <FiscalYearRefId> element.
void	setFormNumber(java.lang.String value) Sets the value of the <FormNumber> element.
void	setFormType(FormType value) Sets the value of the <FormType> element.
void	setFormType(java.lang.String value) Sets the value of the <FormType> element as a String.
void	setLocationInfoRefId(java.lang.String value) Sets the value of the <LocationInfoRefId> element.
void	setPurchasingItems(PurchasingItems value) Sets the value of the <PurchasingItems> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setVendorInfoRefId(java.lang.String value) Sets the value of the <VendorInfoRefId> element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, 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

Purchasing

public Purchasing()

Constructor

Purchasing

public Purchasing(java.lang.String refId,
                  FormType formType,
                  java.lang.String formNumber,
                  PurchasingItems purchasingItems)

Constructor that accepts values for all mandatory fields

Parameters:

refId - Transaction GUID for this purchasing activity. The application that owns this object and is responsible for generating this unique ID.

formType - Type of purchasing document.

formNumber - Requisition or PO number.

purchasingItems - Contains information about the item being purchased

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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "Transaction GUID for this purchasing activity. The application that owns this object and is responsible for generating this unique ID."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.5r1

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "Transaction GUID for this purchasing activity. The application that owns this object and is responsible for generating this unique ID."

Parameters:

value - A String object

Since:

1.5r1

getFormType

public java.lang.String getFormType()

Gets the value of the <FormType> element.

The SIF specification defines the meaning of this element as: "Type of purchasing document."

Returns:

The FormType element of this object.

Since:

1.5r1

setFormType

public void setFormType(FormType value)

Sets the value of the <FormType> element.

The SIF specification defines the meaning of this element as: "Type of purchasing document."

Parameters:

value - A constant defined by the FormType class

Since:

1.5r1

setFormType

public void setFormType(java.lang.String value)

Sets the value of the <FormType> element as a String.

The SIF specification defines the meaning of this element as: "Type of purchasing document."

Parameters:

value - The value as a String

Since:

1.5r1

getFormNumber

public java.lang.String getFormNumber()

Gets the value of the <FormNumber> element.

The SIF specification defines the meaning of this element as: "Requisition or PO number."

Returns:

The FormNumber element of this object.

Since:

1.5r1

setFormNumber

public void setFormNumber(java.lang.String value)

Sets the value of the <FormNumber> element.

The SIF specification defines the meaning of this element as: "Requisition or PO number."

Parameters:

value - A String object

Since:

1.5r1

getFiscalYearRefId

public java.lang.String getFiscalYearRefId()

Gets the value of the <FiscalYearRefId> element.

The SIF specification defines the meaning of this element as: "Reference to fiscal year for the transaction."

Returns:

The FiscalYearRefId element of this object.

Since:

1.5r1

setFiscalYearRefId

public void setFiscalYearRefId(java.lang.String value)

Sets the value of the <FiscalYearRefId> element.

The SIF specification defines the meaning of this element as: "Reference to fiscal year for the transaction."

Parameters:

value - A String object

Since:

1.5r1

getVendorInfoRefId

public java.lang.String getVendorInfoRefId()

Gets the value of the <VendorInfoRefId> element.

The SIF specification defines the meaning of this element as: "This object references the VendorInfo object and should be considered manditory when FormType="PO""

This element 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 elements of this kind.

Version	Tag
1.5r1	"Vendor"
SIF2.0	"VendorInfoRefId"

Returns:

The VendorInfoRefId element of this object.

Since:

1.5r1

setVendorInfoRefId

public void setVendorInfoRefId(java.lang.String value)

Sets the value of the <VendorInfoRefId> element.

The SIF specification defines the meaning of this element as: "This object references the VendorInfo object and should be considered manditory when FormType="PO""

This element 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 elements of this kind.

Version	Tag
1.5r1	"Vendor"
SIF2.0	"VendorInfoRefId"

Parameters:

value - A String object

Since:

1.5r1

getLocationInfoRefId

public java.lang.String getLocationInfoRefId()

Gets the value of the <LocationInfoRefId> element.

The SIF specification defines the meaning of this element as: "The building ID for this purchasing activity."

Returns:

The LocationInfoRefId element of this object.

Since:

1.5r1

setLocationInfoRefId

public void setLocationInfoRefId(java.lang.String value)

Sets the value of the <LocationInfoRefId> element.

The SIF specification defines the meaning of this element as: "The building ID for this purchasing activity."

Parameters:

value - A String object

Since:

1.5r1

getEmployeePersonalRefId

public java.lang.String getEmployeePersonalRefId()

Gets the value of the <EmployeePersonalRefId> element.

The SIF specification defines the meaning of this element as: "The employee ID for the originator of this purchasing activity."

Returns:

The EmployeePersonalRefId element of this object.

Since:

1.5r1

setEmployeePersonalRefId

public void setEmployeePersonalRefId(java.lang.String value)

Sets the value of the <EmployeePersonalRefId> element.

The SIF specification defines the meaning of this element as: "The employee ID for the originator of this purchasing activity."

Parameters:

value - A String object

Since:

1.5r1

setPurchasingItems

public void setPurchasingItems(PurchasingItems value)

Sets the value of the <PurchasingItems> element.

The SIF specification defines the meaning of this element as: "Contains information about the item being purchased"

Parameters:

value - A PurchasingItems object

Since:

1.5r1

getPurchasingItems

public PurchasingItems getPurchasingItems()

Gets the value of the <PurchasingItems> element.

The SIF specification defines the meaning of this element as: "Contains information about the item being purchased"

Returns:

A PurchasingItems object

Since:

1.5r1

removePurchasingItems

public void removePurchasingItems()

Removes the PurchasingItems child element previously created by calling setPurchasingItems

Since:

1.5r1