org.kuali.rice.krms.impl.util

Interface KrmsRuleManagementCopyMethods

All Known Implementing Classes:

KrmsRuleManagementCopyMethodsImpl, KrmsRuleManagementCopyMethodsMockImpl

public interface KrmsRuleManagementCopyMethods

These are the copy methods to be used to copy rules from one object to another. For now this will just be a simple interface for a hunk of code that does the copying. Later we will evaluate if we can/should push this into the KRMS rules service proper. Note: This file refers to multiple methods but there is just one right now. We will see as we move through the use cases if this single method is fine grained enough to copy the rules we need to copy and just those rules.

Author:

nwright

Method Summary

Methods

Modifier and Type	Method and Description
List<org.kuali.rice.krms.api.repository.reference.ReferenceObjectBinding>	deepCopyReferenceObjectBindingsFromTo(String fromReferenceDiscriminatorType, String fromReferenceObjectId, String toReferenceDiscriminatorType, String toReferenceObjectId, List<String> optionKeys) Does a deep copy of all the bindings and rules associated with those bindings.
int	deleteReferenceObjectBindingsCascade(String referenceDiscriminatorType, String referenceObjectId) Delete the rules associated with the specified reference object.

Method Detail

deepCopyReferenceObjectBindingsFromTo

List<org.kuali.rice.krms.api.repository.reference.ReferenceObjectBinding> deepCopyReferenceObjectBindingsFromTo(String fromReferenceDiscriminatorType,
                                                                                                              String fromReferenceObjectId,
                                                                                                              String toReferenceDiscriminatorType,
                                                                                                              String toReferenceObjectId,
                                                                                                              List<String> optionKeys)
                                                                                                                throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                                                                                       org.kuali.rice.core.api.exception.RiceIllegalStateException,
                                                                                                                       PermissionDeniedException,
                                                                                                                       MissingParameterException,
                                                                                                                       InvalidParameterException,
                                                                                                                       OperationFailedException

Does a deep copy of all the bindings and rules associated with those bindings. This is expected to be used in the following use cases: (1) Copy rules from Canonical course to course offering (2) Rollover rules from previous course offering to newly rolled over course offering (3) Copy rules down from course offering to activity offering so they can be overridden at the activity offering level

Parameters:

fromReferenceDiscriminatorType - the ref object uri of the existing reference object

fromReferenceObjectId - the id of the reference object

toReferenceDiscriminatorType - the simple class name of the new reference object

toReferenceObjectId - the id of the reference object

optionKeys - configuration defined keys that control details of the copying

Returns:

the list of newly created reference object bindings

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if any of the parameters are null or invalid

org.kuali.rice.core.api.exception.RiceIllegalStateException - if they copy run into a data condition that it cannot handle

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

deleteReferenceObjectBindingsCascade

int deleteReferenceObjectBindingsCascade(String referenceDiscriminatorType,
                                       String referenceObjectId)
                                         throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException,
                                                org.kuali.rice.core.api.exception.RiceIllegalStateException

Delete the rules associated with the specified reference object. This deletes the binding and cascades to agendas, rules, propositions and terms as needed.

Parameters:

referenceDiscriminatorType - the ref object uri of the reference object who's rules are to be deleted

referenceObjectId - the id of the reference object

Returns:

the number of reference object bindings that were deleted

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if any of the parameters are null or invalid

org.kuali.rice.core.api.exception.RiceIllegalStateException - if the delete runs into a data condition that it cannot handle