Package org.kuali.coeus.common.api.person.attr

Interface CitizenshipTypeService

  • public interface CitizenshipTypeService

    • Method Detail

      • getPersonCitizenshipType

        CitizenshipType getPersonCitizenshipType​(ProposalPersonContract proposalPerson)
        Retrieves the proposal persons CitizenshipType. The default implementation of this method will determine the source of the data based on two parameters. When the parameter "PI_CITIZENSHIP_FROM_CUSTOM_DATA" is set to 0 it will retrieve the value from an external source, in which case a service override must have implemented the protected getCitizenshipDataFromExternalSource method in this service, otherwise an UnsupportedOperationException will be thrown. Within the system there are two possible sources for the data. When the parameter "ALLOW_PROPOSAL_PERSON_TO_OVERRIDE_KC_PERSON_EXTENDED_ATTRIBUTES" is set to true, this value will be retrieved from the proposal person record allowing each proposal to override the citizenship type for each person. When this parameter is turned off, the value is retrieved from the KC Extended Attributes record for the person.
        Parameters:
        proposalPerson - the person. cannot be null
        Returns:
        the CitizenshipType for each person. It will return CitizenshipType.NOT_AVAILABLE when unavailable or the citizenship code is not recognized as a valid value.
        Throws:
        IllegalArgumentException - if the proposalPerson is null
        UnsupportedOperationException - if the PI_CITIZENSHIP_FROM_CUSTOM_DATA is disabled and getCitizenshipDataFromExternalSource has not been overridden