Package org.kuali.rice.krms.impl.repository

Interface PropositionBoService

All Known Implementing Classes:
PropositionBoServiceImpl
public interface PropositionBoService
This is the interface for accessing KRMS repository Proposition related business objects.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    createParameter(org.kuali.rice.krms.api.repository.proposition.PropositionParameter parameter)
    This will create a PropositionParameter exactly like the parameter passed in.
    org.kuali.rice.krms.api.repository.proposition.PropositionDefinition
    createProposition(org.kuali.rice.krms.api.repository.proposition.PropositionDefinition prop)
    This will create a PropositionDefinition exactly like the parameter passed in.
    void
    deleteProposition(String propId)
    This will delete an existing PropositionDefinition.
    org.kuali.rice.krms.api.repository.proposition.PropositionParameter
    getParameterById(String id)
    Lookup the proposition parameter based on the id.
    org.kuali.rice.krms.api.repository.proposition.PropositionParameter
    getParameterByPropIdAndSequenceNumber(String propId, Integer sequenceNumber)
    Lookup the proposition parameter based on the proposition id and sequence number.
    List<org.kuali.rice.krms.api.repository.proposition.PropositionParameter>
    getParameters(String propId)
    Lookup the proposition parameters based on the given proposition id.
    org.kuali.rice.krms.api.repository.proposition.PropositionDefinition
    getPropositionById(String propId)
    Lookup the proposition based on the given proposition id.
    Set<org.kuali.rice.krms.api.repository.proposition.PropositionDefinition>
    getPropositionsByRule(String ruleId)
     
    Set<org.kuali.rice.krms.api.repository.proposition.PropositionDefinition>
    getPropositionsByType(String typeId)
     
    org.kuali.rice.krms.api.repository.proposition.PropositionParameter
    updateParameter(org.kuali.rice.krms.api.repository.proposition.PropositionParameter parameter)
    This will update a PropositionParameter.
    org.kuali.rice.krms.api.repository.proposition.PropositionDefinition
    updateProposition(org.kuali.rice.krms.api.repository.proposition.PropositionDefinition prop)
    This will update an existing PropositionDefinition.

  • Method Details

    • createProposition

      @CacheEvict(value={"http://rice.kuali.org/krms/v2_0/PropositionType","http://rice.kuali.org/krms/v2_0/RuleType"}, allEntries=true) org.kuali.rice.krms.api.repository.proposition.PropositionDefinition createProposition(org.kuali.rice.krms.api.repository.proposition.PropositionDefinition prop)
      This will create a PropositionDefinition exactly like the parameter passed in.
      Parameters:
      prop - the proposition to create
      Throws:
      IllegalArgumentException - if the proposition is null
      IllegalStateException - if the proposition already exists in the system

    • updateProposition

      @CacheEvict(value={"http://rice.kuali.org/krms/v2_0/PropositionType","http://rice.kuali.org/krms/v2_0/RuleType"}, allEntries=true) org.kuali.rice.krms.api.repository.proposition.PropositionDefinition updateProposition(org.kuali.rice.krms.api.repository.proposition.PropositionDefinition prop)
      This will update an existing PropositionDefinition.
      Parameters:
      prop - the proposition to update
      Throws:
      IllegalArgumentException - if the proposition is null
      IllegalStateException - if the proposition does not exist in the system

    • deleteProposition

      void deleteProposition(String propId)
      This will delete an existing PropositionDefinition.
      Parameters:
      propId - the proposition to delete
      Throws:
      IllegalArgumentException - if the proposition is null
      IllegalStateException - if the proposition does not exist in the system

    • getPropositionById

      @Cacheable(value="http://rice.kuali.org/krms/v2_0/PropositionType", key="\'propId=\' + #p0") org.kuali.rice.krms.api.repository.proposition.PropositionDefinition getPropositionById(String propId)
      Lookup the proposition based on the given proposition id.
      Parameters:
      propId - the given proposition id
      Returns:
      a proposition associated with the given proposition id. A null reference is returned if an invalid or non-existent id is supplied.

    • getPropositionsByType

      Set<org.kuali.rice.krms.api.repository.proposition.PropositionDefinition> getPropositionsByType(String typeId)

    • getPropositionsByRule

      Set<org.kuali.rice.krms.api.repository.proposition.PropositionDefinition> getPropositionsByRule(String ruleId)

    • createParameter

      @CacheEvict(value={"http://rice.kuali.org/krms/v2_0/PropositionType","http://rice.kuali.org/krms/v2_0/RuleType"}, allEntries=true) void createParameter(org.kuali.rice.krms.api.repository.proposition.PropositionParameter parameter)
      This will create a PropositionParameter exactly like the parameter passed in.
      Parameters:
      parameter - the proposition parameter to create
      Throws:
      IllegalArgumentException - if the proposition parameter is null
      IllegalStateException - if the proposition parameter is already existing in the system

    • updateParameter

      @CacheEvict(value={"http://rice.kuali.org/krms/v2_0/PropositionType","http://rice.kuali.org/krms/v2_0/RuleType"}, allEntries=true) org.kuali.rice.krms.api.repository.proposition.PropositionParameter updateParameter(org.kuali.rice.krms.api.repository.proposition.PropositionParameter parameter)
      This will update a PropositionParameter.
      Parameters:
      parameter - the proposition parameter to update
      Throws:
      IllegalArgumentException - if the proposition parameter is null
      IllegalStateException - if the proposition parameter does not exist in the system

    • getParameters

      List<org.kuali.rice.krms.api.repository.proposition.PropositionParameter> getParameters(String propId)
      Lookup the proposition parameters based on the given proposition id.
      Parameters:
      propId - the given proposition id
      Returns:
      a list of PropositionParameters associated with the given proposition id. A null reference is returned if an invalid or non-existant id is supplied.

    • getParameterById

      org.kuali.rice.krms.api.repository.proposition.PropositionParameter getParameterById(String id)
      Lookup the proposition parameter based on the id.
      Parameters:
      id - the given proposition id
      Returns:
      an immutable PropositionParameters associated with the given id. A null reference is returned if an invalid or non-existant id is supplied.

    • getParameterByPropIdAndSequenceNumber

      org.kuali.rice.krms.api.repository.proposition.PropositionParameter getParameterByPropIdAndSequenceNumber(String propId, Integer sequenceNumber)
      Lookup the proposition parameter based on the proposition id and sequence number.
      Parameters:
      propId - the given proposition id
      Returns:
      an immutable PropositionParameters associated with the given proposition id and sequence number. A null reference is returned if an invalid or non-existant.