moving code from KC proper

coeus-api-all/pom.xml

@@ -23,6 +23,17 @@
         <artifactId>coeus-api</artifactId>
         <version>6.0-SNAPSHOT</version>
     </parent>
-    <groupId>org.kuali.coeus</groupId>
     <artifactId>coeus-api-all</artifactId>
+
+    <!--
+     IMPORTANT: The api module should not have any dependencies third-party or
+     otherwise (other than unit test dependencies).
+     Especially not on Kuali Rice or other modules of Kuali Coeus.
+     -->
+    <dependencies>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+        </dependency>
+    </dependencies>
 </project>

coeus-api-all/src/main/java/org/kuali/coeus/award/api/core/AwardTypeContract.java

@@ -0,0 +1,8 @@
+package org.kuali.coeus.award.api.core;
+
+import org.kuali.coeus.sys.api.model.Describable;
+
+public interface AwardTypeContract extends Describable {
+
+    Integer getCode();
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/compliance/core/SpecialReviewApprovalTypeContract.java

@@ -0,0 +1,7 @@
+package org.kuali.coeus.common.api.compliance.core;
+
+import org.kuali.coeus.sys.api.model.Coded;
+import org.kuali.coeus.sys.api.model.Describable;
+
+public interface SpecialReviewApprovalTypeContract extends Coded, Describable {
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/compliance/core/SpecialReviewContract.java

@@ -0,0 +1,25 @@
+package org.kuali.coeus.common.api.compliance.core;
+
+
+import java.sql.Date;
+
+public interface SpecialReviewContract {
+
+    Integer getSpecialReviewNumber();
+
+    String getProtocolNumber();
+
+    Date getApplicationDate();
+
+    Date getApprovalDate();
+
+    Date getExpirationDate();
+
+    String getComments();
+
+    String getProtocolStatus();
+
+    SpecialReviewTypeContract getSpecialReviewType();
+
+    SpecialReviewApprovalTypeContract getApprovalType();
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/compliance/core/SpecialReviewTypeContract.java

@@ -0,0 +1,8 @@
+package org.kuali.coeus.common.api.compliance.core;
+
+import org.kuali.coeus.sys.api.model.Coded;
+import org.kuali.coeus.sys.api.model.Describable;
+import org.kuali.coeus.sys.api.model.Sortable;
+
+public interface SpecialReviewTypeContract extends Coded, Describable, Sortable {
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/compliance/exemption/ExemptionTypeContract.java

@@ -0,0 +1,9 @@
+package org.kuali.coeus.common.api.compliance.exemption;
+
+import org.kuali.coeus.sys.api.model.Coded;
+import org.kuali.coeus.sys.api.model.Describable;
+
+public interface ExemptionTypeContract extends Coded, Describable {
+
+    String getDetailedDescription();
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/country/CountryContract.java

@@ -0,0 +1,9 @@
+package org.kuali.coeus.common.api.country;
+
+import org.kuali.coeus.sys.api.model.Coded;
+
+public interface CountryContract extends Coded {
+
+    String getAlternateCode();
+    String getName();
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/country/KcCountryService.java

@@ -0,0 +1,25 @@
+package org.kuali.coeus.common.api.country;
+
+
+public interface KcCountryService {
+
+    /**
+     * This method retrieves a country by country code.  If the country is not found null is returned.
+     * The country code cannot be blank.
+     *
+     * @param code the country code.  cannot be blank.
+     * @return the country or null if not found.
+     * @throws java.lang.IllegalArgumentException if the code is blank
+     */
+    CountryContract getCountry(String code);
+
+    /**
+     * This method retrieves a country by alternate country code.  The alternate country code is usually a three digit
+     * code. If the country is not found null is returned. The alternate country code cannot be blank.
+     *
+     * @param alternateCode the alternate country code.  cannot be blank.
+     * @return the country or null if not found.
+     * @throws java.lang.IllegalArgumentException if the alternateCode is blank
+     */
+    CountryContract getCountryByAlternateCode(String alternateCode);
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/custom/attr/CustomAttributeContract.java

@@ -0,0 +1,18 @@
+package org.kuali.coeus.common.api.custom.attr;
+
+
+import org.kuali.coeus.sys.api.model.IdentifiableNumeric;
+
+public interface CustomAttributeContract extends IdentifiableNumeric {
+
+    Integer getDataLength();
+    String getDataTypeCode();
+    String getDefaultValue();
+    String getGroupName();
+    String getLabel();
+    String getLookupClass();
+    String getLookupReturn();
+    String getName();
+    CustomAttributeDataTypeContract getCustomAttributeDataType();
+
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/custom/attr/CustomAttributeDataTypeContract.java

@@ -0,0 +1,7 @@
+package org.kuali.coeus.common.api.custom.attr;
+
+import org.kuali.coeus.sys.api.model.Coded;
+import org.kuali.coeus.sys.api.model.Describable;
+
+public interface CustomAttributeDataTypeContract extends Coded, Describable {
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/custom/attr/CustomAttributeDocValueContract.java

@@ -0,0 +1,10 @@
+package org.kuali.coeus.common.api.custom.attr;
+
+import org.kuali.coeus.sys.api.model.IdentifiableNumeric;
+
+public interface CustomAttributeDocValueContract extends IdentifiableNumeric {
+
+    String getDocumentNumber();
+    String getValue();
+    CustomAttributeContract getCustomAttribute();
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/custom/attr/CustomAttributeDocumentContract.java

@@ -0,0 +1,12 @@
+package org.kuali.coeus.common.api.custom.attr;
+
+import org.kuali.coeus.sys.api.model.DocumentTyped;
+import org.kuali.coeus.sys.api.model.IdentifiableNumeric;
+import org.kuali.coeus.sys.api.model.Inactivatable;
+
+public interface CustomAttributeDocumentContract extends IdentifiableNumeric, DocumentTyped, Inactivatable {
+
+    boolean isRequired();
+    String getTypeName();
+    CustomAttributeContract getCustomAttribute();
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/keyword/ScienceKeywordContract.java

@@ -0,0 +1,8 @@
+package org.kuali.coeus.common.api.keyword;
+
+import org.kuali.coeus.sys.api.model.Coded;
+import org.kuali.coeus.sys.api.model.Describable;
+
+public interface ScienceKeywordContract extends Coded, Describable {
+
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/noo/NoticeOfOpportunityContract.java

@@ -0,0 +1,7 @@
+package org.kuali.coeus.common.api.noo;
+
+import org.kuali.coeus.sys.api.model.Coded;
+import org.kuali.coeus.sys.api.model.Describable;
+
+public interface NoticeOfOpportunityContract extends Coded, Describable{
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/org/OrganizationContract.java

@@ -0,0 +1,78 @@
+package org.kuali.coeus.common.api.org;
+
+import org.kuali.coeus.common.api.org.audit.OrganizationAuditContract;
+import org.kuali.coeus.common.api.org.type.OrganizationTypeContract;
+
+import java.util.Date;
+import java.util.List;
+
+public interface OrganizationContract {
+
+    String getOrganizationId();
+
+    String getAddress();
+
+    String getAgencySymbol();
+
+    String getAnimalWelfareAssurance();
+
+    String getCableAddress();
+
+    String getCageNumber();
+
+    Integer getCognizantAuditor();
+
+    String getComGovEntityCode();
+
+    String getCongressionalDistrict();
+
+    Integer getContactAddressId();
+
+    String getCounty();
+
+    String getDodacNumber();
+
+    String getDunsNumber();
+
+    String getDunsPlusFourNumber();
+
+    String getFederalEmployerId();
+
+    String getHumanSubAssurance();
+
+    Date getIncorporatedDate();
+
+    String getIncorporatedIn();
+
+    String getIndirectCostRateAgreement();
+
+    String getIrsTaxExemption();
+
+    String getStateEmployeeClaim();
+
+    String getStateTaxExemptNum();
+
+    String getNsfInstitutionalCode();
+
+    Integer getNumberOfEmployees();
+
+    Integer getOnrResidentRep();
+
+    String getOrganizationName();
+
+    String getPhsAccount();
+
+    Date getScienceMisconductComplDate();
+
+    String getTelexNumber();
+
+    String getVendorCode();
+
+    List<? extends OrganizationYnqContract> getOrganizationYnqs();
+
+    List<? extends OrganizationTypeContract> getOrganizationTypes();
+
+    List<? extends OrganizationIndirectcostContract> getOrganizationIdcs();
+
+    List<? extends OrganizationAuditContract> getOrganizationAudits();
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/org/OrganizationIndirectcostContract.java

@@ -0,0 +1,24 @@
+package org.kuali.coeus.common.api.org;
+
+import org.kuali.coeus.sys.api.model.ScaleTwoDecimal;
+
+import java.util.Date;
+
+public interface OrganizationIndirectcostContract {
+
+    Integer getIdcNumber();
+
+    String getOrganizationId();
+
+    ScaleTwoDecimal getApplicableIndirectcostRate();
+
+    Date getEndDate();
+
+    String getIdcComment();
+
+    Integer getIdcRateTypeCode();
+
+    Date getRequestedDate();
+
+    Date getStartDate();
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/org/OrganizationRepositoryService.java

@@ -0,0 +1,22 @@
+package org.kuali.coeus.common.api.org;
+
+public interface OrganizationRepositoryService {
+
+    /**
+     * Gets Cognizant Federal Agency for an organization.  The pass in organization cannot be null.
+     * Will return an empty string the Cognizant Federal Agency cannot be determined.
+     *
+     * @param organization the organization.
+     * @return the Cognizant Federal Agency or a blank string
+     * @throws java.lang.IllegalArgumentException if the organization is null
+     */
+    String getCognizantFedAgency(OrganizationContract organization);
+
+    /**
+     * This method will retrieves a {@link org.kuali.coeus.common.api.org.OrganizationContract} by organizationId.  The organizationId cannot be blank.
+     * @param organizationId the organizationId.  Cannot be blank.
+     * @return the {@link org.kuali.coeus.common.api.org.OrganizationContract} or null if not found.
+     * @throws java.lang.IllegalArgumentException if the organizationId is null
+     */
+    OrganizationContract getOrganization(String organizationId);
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/org/OrganizationYnqContract.java

@@ -0,0 +1,16 @@
+package org.kuali.coeus.common.api.org;
+
+import java.util.Date;
+
+public interface OrganizationYnqContract {
+
+    String getOrganizationId();
+
+    String getAnswer();
+
+    String getExplanation();
+
+    Date getReviewDate();
+
+    String getQuestionId();
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/org/audit/OrganizationAuditContract.java

@@ -0,0 +1,12 @@
+package org.kuali.coeus.common.api.org.audit;
+
+public interface OrganizationAuditContract {
+
+    String getFiscalYear();
+
+    String getOrganizationId();
+
+    boolean getAuditAccepted();
+
+    String getAuditComment();
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/org/type/OrganizationTypeContract.java

@@ -0,0 +1,7 @@
+package org.kuali.coeus.common.api.org.type;
+
+public interface OrganizationTypeContract {
+
+    String getOrganizationId();
+    OrganizationTypeListContract getOrganizationTypeList();
+}

coeus-api-all/src/main/java/org/kuali/coeus/common/api/org/type/OrganizationTypeListContract.java

@@ -0,0 +1,7 @@
+package org.kuali.coeus.common.api.org.type;
+
+import org.kuali.coeus.sys.api.model.Describable;
+
+public interface OrganizationTypeListContract extends Describable {
+    Integer getCode();
+}