Package org.kuali.coeus.propdev.api.s2s

Interface UserAttachedFormService

  • public interface UserAttachedFormService

    • Method Detail

      • findFormByProposalNumberAndNamespace

        S2sUserAttachedFormContract findFormByProposalNumberAndNamespace​(String proposalNumber,
                                                                 String namespace)
        This method find a S2S User Attached Form by a proposal number and namespace. There is supposed to be only one form with the same proposal number and namespace combination. If more that one is found the first one is returned. If no matching forms are found null is returned.
        Parameters:
        proposalNumber - the proposal number. Cannot be blank
        namespace - the namespace. Cannot be blank.
        Returns:
        a S2S User Attached Form or null.
        Throws:
        IllegalArgumentException - if either proposalNumber or namespace is blank.

      • findFormNameByProposalNumberAndNamespace

        String findFormNameByProposalNumberAndNamespace​(String proposalNumber,
                                                String namespace)
        This method find a S2S User Attached Form name by a proposal number and namespace. There is supposed to be only one form with the same proposal number and namespace combination. If more that one is found the first name is returned. If no matching forms are found null is returned.
        Parameters:
        proposalNumber - the proposal number. Cannot be blank
        namespace - the namespace. Cannot be blank.
        Returns:
        a S2S User Attached Form name or null.
        Throws:
        IllegalArgumentException - if either proposalNumber or namespace is blank.

      • findFormNamespaces

        List<String> findFormNamespaces​(String proposalNumber)
        This method find all the user attached form namespaces for a given proposal number. This list should not contain duplicates but in theory could. This method will return an empty collection if no namespaces are found.
        Parameters:
        proposalNumber - the proposal number. Cannot be blank
        Returns:
        a list of namespaces or an empty list.
        Throws:
        IllegalArgumentException - if either proposalNumber.

      • findUserAttachedFormAttFile

        S2sUserAttachedFormAttFileContract findUserAttachedFormAttFile​(S2sUserAttachedFormAttContract selectedFormAtt)
        This method finds a user attached attachment form file from a user attached form attachment. The selectedFormAtt cannot be null.
        Parameters:
        selectedFormAtt - the user attached form attachment or null
        Returns:
        the user attached form attachment file or null
        Throws:
        IllegalArgumentException - if the selectedFormAtt is null