com.edustructures.sifworks.hrfin
Class VendorInfo

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class VendorInfo
extends SIFDataObject

This object contains basic vendor information. 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

VendorInfo()
Constructor

VendorInfo(java.lang.String refId, java.lang.String name)
Constructor that accepts values for all mandatory fields

Method Summary

void	addEmail(Email value) Adds a new <Email> child element.
void	addEmail(EmailType type, java.lang.String value) Adds a new <Email> repeatable element.
void	addPhoneNumber(PhoneNumber value) Adds a new <PhoneNumber> child element.
void	addPhoneNumber(PhoneNumberType type, java.lang.String number) Adds a new <PhoneNumber> repeatable element.
Address	getAddress() Gets the value of the <Address> element.
ContactInfo	getContactInfo() Gets the value of the <ContactInfo> element.
java.lang.String	getContactName() Gets the value of the <ContactName> element.
java.lang.String	getCustomerId() Gets the value of the <CustomerId> element.
Email	getEmail(EmailType type) Gets an Email object instance.
Email[]	getEmails() Gets all Email object instances.
java.lang.String	getEmployeePersonalRefId() Gets the value of the <EmployeePersonalRefId> element.
FederalTaxId	getFederalTaxId() Gets the value of the <FederalTaxId> 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	getName() Gets the value of the <Name> element.
PhoneNumber	getPhoneNumber(PhoneNumberType type) Gets a PhoneNumber object instance.
PhoneNumber[]	getPhoneNumbers() Gets all PhoneNumber object instances.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.Boolean	getSend1099() Gets the value of the <Send1099> element.
void	removeAddress() Removes the Address child element previously created by calling setAddress
void	removeContactInfo() Removes the ContactInfo child element previously created by calling setContactInfo
void	removeEmail(EmailType type) Removes an Email object instance.
void	removeFederalTaxId() Removes the FederalTaxId child element previously created by calling setFederalTaxId
void	removePhoneNumber(PhoneNumberType type) Removes a PhoneNumber object instance.
void	setAddress(Address value) Sets the value of the <Address> element.
void	setAddress(AddressType type, Street street, java.lang.String city, StatePrCode stateProvince, CountryCode country, java.lang.String postalCode) Sets the value of the <Address> child element.
void	setContactInfo(ContactInfo value) Sets the value of the <ContactInfo> element.
void	setContactInfo(Name name) Sets the value of the <ContactInfo> child element.
void	setContactName(java.lang.String value) Sets the value of the <ContactName> element.
void	setCustomerId(java.lang.String value) Sets the value of the <CustomerId> element.
void	setEmails(Email[] emails) Sets an array of Email objects.
void	setEmployeePersonalRefId(java.lang.String value) Sets the value of the <EmployeePersonalRefId> element.
void	setFederalTaxId(FederalTaxId value) Sets the value of the <FederalTaxId> element.
void	setFederalTaxId(FederalTaxIdCode code, java.lang.String value) Sets the value of the <FederalTaxId> child element.
void	setName(java.lang.String value) Sets the value of the <Name> element.
void	setPhoneNumbers(PhoneNumber[] phonenumbers) Sets an array of PhoneNumber objects.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSend1099(java.lang.Boolean value) Sets the value of the <Send1099> 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

VendorInfo

public VendorInfo()

Constructor

VendorInfo

public VendorInfo(java.lang.String refId,
                  java.lang.String name)

Constructor that accepts values for all mandatory fields

Parameters:

refId - Vendor ID.

name - Name of the vendor.

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: "Vendor 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: "Vendor ID."

Parameters:

value - A String object

Since:

1.5r1

getName

public java.lang.String getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of the vendor."

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	"VendorName"
SIF2.0	"Name"

Returns:

The Name element of this object.

Since:

1.5r1

setName

public void setName(java.lang.String value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of the vendor."

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	"VendorName"
SIF2.0	"Name"

Parameters:

value - A String object

Since:

1.5r1

setContactInfo

public void setContactInfo(ContactInfo value)

Sets the value of the <ContactInfo> element.

The SIF specification defines the meaning of this element as: "Contact information."

Parameters:

value - A ContactInfo object

Since:

2.0

setContactInfo

public void setContactInfo(Name name)

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

Parameters:

name - The name of the contact person.

Since:

2.0

getContactInfo

public ContactInfo getContactInfo()

Gets the value of the <ContactInfo> element.

The SIF specification defines the meaning of this element as: "Contact information."

Returns:

A ContactInfo object

Since:

2.0

removeContactInfo

public void removeContactInfo()

Removes the ContactInfo child element previously created by calling setContactInfo

Since:

2.0

setAddress

public void setAddress(Address value)

Sets the value of the <Address> element.

The SIF specification defines the meaning of this element as: "This element has the staff member's address information (in SIF 2.x use the ContactInfo element)"

Parameters:

value - A Address object

Since:

1.5r1

setAddress

public void setAddress(AddressType type,
                       Street street,
                       java.lang.String city,
                       StatePrCode stateProvince,
                       CountryCode country,
                       java.lang.String postalCode)

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

Parameters:

type - Code that defines the location of the address. Note: A subset of specific valid values for each instance in a data object may be listed in that object.

street - The street part of the address

city - The city part of the address.

stateProvince - The state or province code.

country - The country code.

postalCode - The ZIP/postal code.

Since:

1.5r1

getAddress

public Address getAddress()

Gets the value of the <Address> element.

The SIF specification defines the meaning of this element as: "This element has the staff member's address information (in SIF 2.x use the ContactInfo element)"

Returns:

An Address object

Since:

1.5r1

removeAddress

public void removeAddress()

Removes the Address child element previously created by calling setAddress

Since:

1.5r1

addPhoneNumber

public void addPhoneNumber(PhoneNumber value)

Adds a new <PhoneNumber> child element.

The SIF specification defines the meaning of this element as: "This is the vendor's phone number (In SIF 2.x use the ContactInfo element)"

Parameters:

value - A PhoneNumber object

Since:

1.5r1

addPhoneNumber

public void addPhoneNumber(PhoneNumberType type,
                           java.lang.String number)

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

Parameters:

type - Code that specifies what type of phone number this is. Note: A subset of valid values may be specified in data objects.

number - Phone number. Acceptable formats:

Since:

1.5r1

removePhoneNumber

public void removePhoneNumber(PhoneNumberType type)

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

Parameters:

type - Identifies the PhoneNumber object to remove by its Type value

Since:

1.5r1

getPhoneNumber

public PhoneNumber getPhoneNumber(PhoneNumberType type)

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

Parameters:

type - Identifies the PhoneNumber object to return by its "Type" attribute value

Returns:

A PhoneNumber object

Since:

1.5r1

getPhoneNumbers

public PhoneNumber[] getPhoneNumbers()

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

Returns:

An array of PhoneNumber objects

Since:

1.5r1

setPhoneNumbers

public void setPhoneNumbers(PhoneNumber[] phonenumbers)

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

Since:

1.5r1

addEmail

public void addEmail(Email value)

Adds a new <Email> child element.

The SIF specification defines the meaning of this element as: "This is the vendor's email address number (In SIF 2.x use the ContactInfo element)"

Parameters:

value - A Email object

Since:

1.5r1

addEmail

public void addEmail(EmailType type,
                     java.lang.String value)

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

Parameters:

type - This attribute specifies the type of e-mail address.

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

Since:

1.5r1

removeEmail

public void removeEmail(EmailType type)

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

Parameters:

type - Identifies the Email object to remove by its Type value

Since:

1.5r1

getEmail

public Email getEmail(EmailType type)

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

Parameters:

type - Identifies the Email object to return by its "Type" attribute value

Returns:

An Email object

Since:

1.5r1

getEmails

public Email[] getEmails()

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

Returns:

An array of Email objects

Since:

1.5r1

setEmails

public void setEmails(Email[] emails)

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

Since:

1.5r1

getContactName

public java.lang.String getContactName()

Gets the value of the <ContactName> element.

The SIF specification defines the meaning of this element as: "Contact of salesperson name (In SIF 2.x use the ContactInfo element)"

Returns:

The ContactName element of this object.

Since:

1.5r1

setContactName

public void setContactName(java.lang.String value)

Sets the value of the <ContactName> element.

The SIF specification defines the meaning of this element as: "Contact of salesperson name (In SIF 2.x use the ContactInfo element)"

Parameters:

value - A String object

Since:

1.5r1

getCustomerId

public java.lang.String getCustomerId()

Gets the value of the <CustomerId> element.

The SIF specification defines the meaning of this element as: "Account number or other ID."

Returns:

The CustomerId element of this object.

Since:

1.5r1

setCustomerId

public void setCustomerId(java.lang.String value)

Sets the value of the <CustomerId> element.

The SIF specification defines the meaning of this element as: "Account number or other ID."

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: " When the vendor and employee are the same, it may be appropriate to link the EmployeePersonal records to the VendorInfo when tracking expense and tuition reimbursement. This is the GUID of the associated EmployeePersonal object. "

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	"EmployeeId"
SIF2.0	"EmployeePersonalRefId"

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: " When the vendor and employee are the same, it may be appropriate to link the EmployeePersonal records to the VendorInfo when tracking expense and tuition reimbursement. This is the GUID of the associated EmployeePersonal object. "

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	"EmployeeId"
SIF2.0	"EmployeePersonalRefId"

Parameters:

value - A String object

Since:

1.5r1

getSend1099

public java.lang.Boolean getSend1099()

Gets the value of the <Send1099> element.

The SIF specification defines the meaning of this element as: "Send 1099 to this vendor."

Returns:

The Send1099 element of this object.

Since:

1.5r1

setSend1099

public void setSend1099(java.lang.Boolean value)

Sets the value of the <Send1099> element.

The SIF specification defines the meaning of this element as: "Send 1099 to this vendor."

Parameters:

value - A Boolean object

Since:

1.5r1

setFederalTaxId

public void setFederalTaxId(FederalTaxId value)

Sets the value of the <FederalTaxId> element.

The SIF specification defines the meaning of this element as: "Taxpayer identification number/Federal tax ID for this vendor."

Parameters:

value - A FederalTaxId object

Since:

1.5r1

setFederalTaxId

public void setFederalTaxId(FederalTaxIdCode code,
                            java.lang.String value)

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

Parameters:

code - The type tax ID that this is. TIN based on IRS Publication 1915 [IRSTIN].

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

Since:

1.5r1

getFederalTaxId

public FederalTaxId getFederalTaxId()

Gets the value of the <FederalTaxId> element.

The SIF specification defines the meaning of this element as: "Taxpayer identification number/Federal tax ID for this vendor."

Returns:

A FederalTaxId object

Since:

1.5r1

removeFederalTaxId

public void removeFederalTaxId()

Removes the FederalTaxId child element previously created by calling setFederalTaxId

Since:

1.5r1