com.edustructures.sifworks.hrfin
Class Billing

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Billing
extends SIFDataObject

This object contains an amount to be billed to an outside entity.

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

Billing()
Constructor

Billing(java.lang.String refId, BilledEntity billedEntity, java.lang.String entityId, java.util.Calendar billingDate, java.lang.String transactionDescription, java.lang.String billedAmount)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getBilledAmount() Gets the value of the <BilledAmount> element.
BilledEntity	getBilledEntity() Gets the value of the <BilledEntity> element.
java.util.Calendar	getBillingDate() Gets the value of the <BillingDate> element.
java.lang.String	getEntityId() Gets the value of the <EntityId> 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	getRefId() Gets the value of the RefId attribute.
java.lang.String	getTransactionDescription() Gets the value of the <TransactionDescription> element.
void	removeBilledEntity() Removes the BilledEntity child element previously created by calling setBilledEntity
void	setBilledAmount(java.lang.String value) Sets the value of the <BilledAmount> element.
void	setBilledEntity(BilledEntity value) Sets the value of the <BilledEntity> element.
void	setBilledEntity(BilledEntityObject sifRefObject, java.lang.String value) Sets the value of the <BilledEntity> child element.
void	setBillingDate(java.util.Calendar value) Sets the value of the <BillingDate> element.
void	setEntityId(java.lang.String value) Sets the value of the <EntityId> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setTransactionDescription(java.lang.String value) Sets the value of the <TransactionDescription> 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

Billing

public Billing()

Constructor

Billing

public Billing(java.lang.String refId,
               BilledEntity billedEntity,
               java.lang.String entityId,
               java.util.Calendar billingDate,
               java.lang.String transactionDescription,
               java.lang.String billedAmount)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID for this transaction. The application that owns this object is responsible for generating this unique ID.

billedEntity -

entityId - ID of the entity being billed for this billing activity (e.g. student ID, employee ID, organization, etc.)

billingDate - Date of the transaction.

transactionDescription - Description of the transaction.

billedAmount - Amount to be billed.

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: "GUID for this transaction. The application that owns this object is responsible for generating this unique ID."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.1

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: "GUID for this transaction. The application that owns this object is responsible for generating this unique ID."

Parameters:

value - A String object

Since:

1.1

setBilledEntity

public void setBilledEntity(BilledEntity value)

Sets the value of the <BilledEntity> element.

Parameters:

value - A BilledEntity object

Since:

2.0

setBilledEntity

public void setBilledEntity(BilledEntityObject sifRefObject,
                            java.lang.String value)

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

Parameters:

sifRefObject - SIF object referenced by SIF_RefId.

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

Since:

2.0

getBilledEntity

public BilledEntity getBilledEntity()

Gets the value of the <BilledEntity> element.

Returns:

A BilledEntity object

Since:

2.0

removeBilledEntity

public void removeBilledEntity()

Removes the BilledEntity child element previously created by calling setBilledEntity

Since:

2.0

getEntityId

public java.lang.String getEntityId()

Gets the value of the <EntityId> element.

The SIF specification defines the meaning of this element as: "ID of the entity being billed for this billing activity (e.g. student ID, employee ID, organization, etc.)"

Returns:

The EntityId element of this object.

Since:

1.1

setEntityId

public void setEntityId(java.lang.String value)

Sets the value of the <EntityId> element.

The SIF specification defines the meaning of this element as: "ID of the entity being billed for this billing activity (e.g. student ID, employee ID, organization, etc.)"

Parameters:

value - A String object

Since:

1.1

getBillingDate

public java.util.Calendar getBillingDate()

Gets the value of the <BillingDate> element.

The SIF specification defines the meaning of this element as: "Date of the transaction."

Returns:

The BillingDate element of this object.

Since:

1.1

setBillingDate

public void setBillingDate(java.util.Calendar value)

Sets the value of the <BillingDate> element.

The SIF specification defines the meaning of this element as: "Date of the transaction."

Parameters:

value - A Calendar object

Since:

1.1

getTransactionDescription

public java.lang.String getTransactionDescription()

Gets the value of the <TransactionDescription> element.

The SIF specification defines the meaning of this element as: "Description of the transaction."

Returns:

The TransactionDescription element of this object.

Since:

1.1

setTransactionDescription

public void setTransactionDescription(java.lang.String value)

Sets the value of the <TransactionDescription> element.

The SIF specification defines the meaning of this element as: "Description of the transaction."

Parameters:

value - A String object

Since:

1.1

getBilledAmount

public java.lang.String getBilledAmount()

Gets the value of the <BilledAmount> element.

The SIF specification defines the meaning of this element as: "Amount to be billed."

Returns:

The BilledAmount element of this object.

Since:

1.1

setBilledAmount

public void setBilledAmount(java.lang.String value)

Sets the value of the <BilledAmount> element.

The SIF specification defines the meaning of this element as: "Amount to be billed."

Parameters:

value - A String object

Since:

1.1