org.kuali.ole.fp.document.service.impl

Class DisbursementVoucherPayeeServiceImpl

java.lang.Object

org.kuali.ole.fp.document.service.impl.DisbursementVoucherPayeeServiceImpl

All Implemented Interfaces:

DisbursementVoucherPayeeService

public class DisbursementVoucherPayeeServiceImpl
extends Object
implements DisbursementVoucherPayeeService

implementing the service methods defined in DisbursementVoucherPayeeService

See Also:

DisbursementVoucherPayeeService

Field Summary

Fields

Modifier and Type	Field and Description
static String	addressPattern

Constructor Summary

Constructors

Constructor and Description
DisbursementVoucherPayeeServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	buildAddressValueDifferenceText(String valueName, String oldValue, String newValue) This method...
protected org.kuali.rice.krad.bo.AdHocRoutePerson	buildFyiRecipient(String userId) This method...
protected String	buildPayeeChangedNoteText(DisbursementVoucherPayeeDetail newPayeeDetail, DisbursementVoucherPayeeDetail oldPayeeDetail) Creates text for a note which records changes to the payee
void	checkPayeeAddressForChanges(DisbursementVoucherDocument dvDoc)
protected FinancialSystemTransactionalDocumentAuthorizerBase	getDocumentAuthorizer(DisbursementVoucherDocument dvDoc) Constructs a document authorizer for this class
Map<String,String>	getFieldConversionBetweenPayeeAndPerson() convert the field names between Payee and Person
Map<String,String>	getFieldConversionBetweenPayeeAndVendor() convert the field names between Payee and Vendor
DisbursementPayee	getPayeeFromPerson(org.kuali.rice.kim.api.identity.Person person) build a payee object from the given person object
DisbursementPayee	getPayeeFromVendor(VendorDetail vendorDetail) build a payee object from the given vendor object
String	getPayeeTypeDescription(String payeeTypeCode) find the payee type description corresponding to the given payee type code
String	getVendorOwnershipTypeCode(DisbursementPayee payee) get the ownership type code if the given payee is a vendor
protected String	getVendorTypeDescription(String vendorTypeCode)
boolean	isEmployee(DisbursementPayee payee) determine whether the given payee is an employee
boolean	isEmployee(DisbursementVoucherPayeeDetail dvPayeeDetail) determine whether the given payee is an employee
boolean	isPayeeIndividualVendor(DisbursementPayee payee) determine whether the given payee is an individual vendor
boolean	isPayeeIndividualVendor(DisbursementVoucherPayeeDetail dvPayeeDetail) determine whether the given payee is an individual vendor
protected boolean	isPayeeIndividualVendor(String payeeIdNumber)
boolean	isVendor(DisbursementPayee payee) determine whether the given payee is a vendor
boolean	isVendor(DisbursementVoucherPayeeDetail dvPayeeDetail) determine whether the given payee is a vendor
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService) Sets the dataDictionaryService attribute value.
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService) Sets the documentService attribute value.
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService) Sets the parameterService attribute value.
protected void	setupFYIs(DisbursementVoucherDocument dvDoc, Set<org.kuali.rice.kim.api.identity.Person> priorApprovers, String initiatorUserId) Creates FYI requests to previous approvers
void	setVendorService(VendorService vendorService) Sets the vendorService attribute value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

addressPattern

public static final String addressPattern

See Also:

Constant Field Values

Constructor Detail

DisbursementVoucherPayeeServiceImpl

public DisbursementVoucherPayeeServiceImpl()

Method Detail

getPayeeTypeDescription

public String getPayeeTypeDescription(String payeeTypeCode)

Description copied from interface: DisbursementVoucherPayeeService

find the payee type description corresponding to the given payee type code

Specified by:

getPayeeTypeDescription in interface DisbursementVoucherPayeeService

Parameters:

payeeTypeCode - the given payee type code

Returns:

the payee type description corresponding to the given payee type code

See Also:

DisbursementVoucherPayeeService.getPayeeTypeDescription(java.lang.String)

isEmployee

public boolean isEmployee(DisbursementVoucherPayeeDetail dvPayeeDetail)

Description copied from interface: DisbursementVoucherPayeeService

determine whether the given payee is an employee

Specified by:

isEmployee in interface DisbursementVoucherPayeeService

Parameters:

dvPayeeDetail - the given payee

Returns:

true if the given payee is an employee; otherwise, false

See Also:

DisbursementVoucherPayeeService.isEmployee(org.kuali.ole.fp.businessobject.DisbursementVoucherPayeeDetail)

isEmployee

public boolean isEmployee(DisbursementPayee payee)

Description copied from interface: DisbursementVoucherPayeeService

determine whether the given payee is an employee

Specified by:

isEmployee in interface DisbursementVoucherPayeeService

Parameters:

payee - the given payee

Returns:

true if the given payee is an employee; otherwise, false

See Also:

DisbursementVoucherPayeeService.isEmployee(org.kuali.ole.fp.businessobject.DisbursementPayee)

isVendor

public boolean isVendor(DisbursementVoucherPayeeDetail dvPayeeDetail)

Description copied from interface: DisbursementVoucherPayeeService

determine whether the given payee is a vendor

Specified by:

isVendor in interface DisbursementVoucherPayeeService

Parameters:

dvPayeeDetail - the given payee

Returns:

true if the given payee is a vendor; otherwise, false

See Also:

DisbursementVoucherPayeeService.isVendor(org.kuali.ole.fp.businessobject.DisbursementVoucherPayeeDetail)

isVendor

public boolean isVendor(DisbursementPayee payee)

Description copied from interface: DisbursementVoucherPayeeService

determine whether the given payee is a vendor

Specified by:

isVendor in interface DisbursementVoucherPayeeService

Parameters:

payee - the given payee

Returns:

true if the given payee is a vendor; otherwise, false

See Also:

DisbursementVoucherPayeeService.isVendor(org.kuali.ole.fp.businessobject.DisbursementPayee)

isPayeeIndividualVendor

public boolean isPayeeIndividualVendor(DisbursementVoucherPayeeDetail dvPayeeDetail)

Description copied from interface: DisbursementVoucherPayeeService

determine whether the given payee is an individual vendor

Specified by:

isPayeeIndividualVendor in interface DisbursementVoucherPayeeService

Parameters:

dvPayeeDetail - the given payee

Returns:

true if the given payee is an individual vendor; otherwise, false

See Also:

DisbursementVoucherPayeeService.isPayeeIndividualVendor(org.kuali.ole.fp.businessobject.DisbursementVoucherPayeeDetail)

isPayeeIndividualVendor

public boolean isPayeeIndividualVendor(DisbursementPayee payee)

Description copied from interface: DisbursementVoucherPayeeService

determine whether the given payee is an individual vendor

Specified by:

isPayeeIndividualVendor in interface DisbursementVoucherPayeeService

Parameters:

payee - the given payee

Returns:

true if the given payee is an individual vendor; otherwise, false

See Also:

DisbursementVoucherPayeeService.isPayeeIndividualVendor(org.kuali.ole.fp.businessobject.DisbursementPayee)

getVendorOwnershipTypeCode

public String getVendorOwnershipTypeCode(DisbursementPayee payee)

Description copied from interface: DisbursementVoucherPayeeService

get the ownership type code if the given payee is a vendor

Specified by:

getVendorOwnershipTypeCode in interface DisbursementVoucherPayeeService

Parameters:

payee - the given payee

Returns:

the ownership type code if the given payee is a vendor; otherwise, return null

See Also:

DisbursementVoucherPayeeService.getVendorOwnershipTypeCode(org.kuali.ole.fp.businessobject.DisbursementPayee)

checkPayeeAddressForChanges

public void checkPayeeAddressForChanges(DisbursementVoucherDocument dvDoc)

Specified by:

checkPayeeAddressForChanges in interface DisbursementVoucherPayeeService

See Also:

DisbursementVoucherPayeeService.checkPayeeAddressForChanges(org.kuali.ole.fp.document.DisbursementVoucherDocument)

getFieldConversionBetweenPayeeAndVendor

public Map<String,String> getFieldConversionBetweenPayeeAndVendor()

Description copied from interface: DisbursementVoucherPayeeService

convert the field names between Payee and Vendor

Specified by:

getFieldConversionBetweenPayeeAndVendor in interface DisbursementVoucherPayeeService

Returns:

a field name map of Payee and Vendor. The map key is a field name of Payee, and its value is a field name of Vendor

See Also:

DisbursementVoucherPayeeService.getFieldConversionBetweenPayeeAndVendor()

getFieldConversionBetweenPayeeAndPerson

public Map<String,String> getFieldConversionBetweenPayeeAndPerson()

Description copied from interface: DisbursementVoucherPayeeService

convert the field names between Payee and Person

Specified by:

getFieldConversionBetweenPayeeAndPerson in interface DisbursementVoucherPayeeService

Returns:

a field name map of Payee and Person. The map key is a field name of Payee, and its value is a field name of Person

See Also:

DisbursementVoucherPayeeService.getFieldConversionBetweenPayeeAndPerson()

getPayeeFromVendor

public DisbursementPayee getPayeeFromVendor(VendorDetail vendorDetail)

Description copied from interface: DisbursementVoucherPayeeService

build a payee object from the given vendor object

Specified by:

getPayeeFromVendor in interface DisbursementVoucherPayeeService

Parameters:

vendorDetail - the given vendor object

Returns:

a payee object built from the given vendor object

See Also:

DisbursementVoucherPayeeService.getPayeeFromVendor(org.kuali.ole.vnd.businessobject.VendorDetail)

getPayeeFromPerson

public DisbursementPayee getPayeeFromPerson(org.kuali.rice.kim.api.identity.Person person)

Description copied from interface: DisbursementVoucherPayeeService

build a payee object from the given person object

Specified by:

getPayeeFromPerson in interface DisbursementVoucherPayeeService

Parameters:

person - the given person object

Returns:

a payee object built from the given person object

See Also:

DisbursementVoucherPayeeService.getPayeeFromPerson(org.kuali.rice.kim.api.identity.Person)

buildPayeeChangedNoteText

protected String buildPayeeChangedNoteText(DisbursementVoucherPayeeDetail newPayeeDetail,
                               DisbursementVoucherPayeeDetail oldPayeeDetail)

Creates text for a note which records changes to the payee

Parameters:

newPayeeDetail - the changed payee detail

oldPayeeDetail - the original payee detail

Returns:

the string for a note

buildAddressValueDifferenceText

protected String buildAddressValueDifferenceText(String valueName,
                                     String oldValue,
                                     String newValue)

This method...

Parameters:

valueName -

oldValue -

newValue -

Returns:

setupFYIs

protected void setupFYIs(DisbursementVoucherDocument dvDoc,
             Set<org.kuali.rice.kim.api.identity.Person> priorApprovers,
             String initiatorUserId)

Creates FYI requests to previous approvers

Parameters:

dvDoc - the document where the payee address has changed

priorApprovers - the previous approvers

initiatorUserId - the id of the initiator

getDocumentAuthorizer

protected FinancialSystemTransactionalDocumentAuthorizerBase getDocumentAuthorizer(DisbursementVoucherDocument dvDoc)

Constructs a document authorizer for this class

Returns:

the document authorizer for this class

buildFyiRecipient

protected org.kuali.rice.krad.bo.AdHocRoutePerson buildFyiRecipient(String userId)

This method...

Parameters:

userId -

Returns:

getVendorTypeDescription

protected String getVendorTypeDescription(String vendorTypeCode)

isPayeeIndividualVendor

protected boolean isPayeeIndividualVendor(String payeeIdNumber)

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

Sets the businessObjectService attribute value.

Parameters:

businessObjectService - The businessObjectService to set.

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

Sets the documentService attribute value.

Parameters:

documentService - The documentService to set.

setDataDictionaryService

public void setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService)

Sets the dataDictionaryService attribute value.

Parameters:

dataDictionaryService - The dataDictionaryService to set.

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

Sets the parameterService attribute value.

Parameters:

parameterService - The parameterService to set.

setVendorService

public void setVendorService(VendorService vendorService)

Sets the vendorService attribute value.

Parameters:

vendorService - The vendorService to set.