org.kuali.kra.protocol.noteattachment

Class ProtocolAttachmentBaseRuleHelper

java.lang.Object

org.kuali.kra.protocol.noteattachment.ProtocolAttachmentBaseRuleHelper

Direct Known Subclasses:

IacucProtocolAttachmentBaseRuleHelper

public abstract class ProtocolAttachmentBaseRuleHelper
extends Object

This class contains methods to "help" in validating ProtocolAttachmentBase.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtocolAttachmentBaseRuleHelper(ProtocolAttachmentService attachmentService, org.kuali.rice.kns.service.DictionaryValidationService validationService) Creates helper deferring the setting of the prefix to later and setting used services.
protected	ProtocolAttachmentBaseRuleHelper(String aPropertyPrefix, ProtocolAttachmentService attachmentService, org.kuali.rice.kns.service.DictionaryValidationService validationService)

Method Summary

Methods

Modifier and Type	Method and Description
void	resetPropertyPrefix(String aPropertyPrefix) Resets the property prefix.
<T extends ProtocolAttachmentBase & TypedAttachment> boolean	validDescriptionWhenRequired(T attachment) Checks for a valid description when description is required.
boolean	validPrimitiveFields(ProtocolAttachmentBase attachmentBase) Validates the attachment's primitive fields (non reference fields).
<T extends ProtocolAttachmentBase & TypedAttachment> boolean	validTypeForGroup(T attachment) Checks for a valid type for a group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtocolAttachmentBaseRuleHelper

protected ProtocolAttachmentBaseRuleHelper(ProtocolAttachmentService attachmentService,
                                org.kuali.rice.kns.service.DictionaryValidationService validationService)

Creates helper deferring the setting of the prefix to later and setting used services.

Parameters:

attachmentService - the Attachment Service

Throws:

IllegalArgumentException - if the attachmentService is null

ProtocolAttachmentBaseRuleHelper

protected ProtocolAttachmentBaseRuleHelper(String aPropertyPrefix,
                                ProtocolAttachmentService attachmentService,
                                org.kuali.rice.kns.service.DictionaryValidationService validationService)

Method Detail

resetPropertyPrefix

public void resetPropertyPrefix(String aPropertyPrefix)

Resets the property prefix.

Parameters:

aPropertyPrefix - the prefix (ex: notesAttachmentsHelper.newAttachmentProtocol)

Throws:

IllegalArgumentException - if the propertyPrefix is null

validDescriptionWhenRequired

public <T extends ProtocolAttachmentBase & TypedAttachment> boolean validDescriptionWhenRequired(T attachment)

Checks for a valid description when description is required. Creates a hard error.

Type Parameters:

T - the attachment "type"

Parameters:

attachment - the attachment.

Returns:

true is valid.

validTypeForGroup

public <T extends ProtocolAttachmentBase & TypedAttachment> boolean validTypeForGroup(T attachment)

Checks for a valid type for a group. Creates a hard error.

This method does not validate the existence of a type code. This validation is done by validType(ProtocolAttachmentBase). If the type code is blank this method will return true.

Type Parameters:

T - the attachment "type"

Parameters:

attachment - the attachment.

Returns:

true is valid.

validPrimitiveFields

public boolean validPrimitiveFields(ProtocolAttachmentBase attachmentBase)

Validates the attachment's primitive fields (non reference fields). Creates a hard error.

Parameters:

attachmentBase - the attachment

Returns:

true if valid.