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

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

Method Detail

createProposition

@CacheEvict(value={"http://rice.kuali.org/krms/v2_0/PropositionType","http://rice.kuali.org/krms/v2_0/RuleType"},
            allEntries=true)
PropositionDefinition createProposition(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)
void updateProposition(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")
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<PropositionDefinition> getPropositionsByType(String typeId)

getPropositionsByRule

Set<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(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)
void updateParameter(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<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

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

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.