org.kuali.kra.protocol

Class ProtocolAssociateBase

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.protocol.ProtocolAssociateBase

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, Sequenceable, SequenceAssociate<ProtocolBase>, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

Direct Known Subclasses:

IacucAlternateSearch, IacucPrinciples, IacucProcedurePersonResponsible, IacucProtocolException, IacucProtocolSpecies, IacucProtocolStudyCustomData, IacucProtocolStudyGroupBean, IacucProtocolStudyGroupLocation, ProtocolActionBase, ProtocolAttachmentBase, ProtocolFundingSourceBase, ProtocolLocationBase, ProtocolNotepadBase, ProtocolParticipant, ProtocolParticipant, ProtocolPersonBase, ProtocolReferenceBase, ProtocolResearchAreaBase, ProtocolRiskLevel, ProtocolSubmissionBase, ProtocolUnitBase

public abstract class ProtocolAssociateBase
extends KraPersistableBusinessObjectBase
implements SequenceAssociate<ProtocolBase>

This class is to maintain repetitive coeus legacy code, protocolNumber & sequenceNumber, for protocol Bos. Much of this class is duplicated with ProtocolAssociateBase but there is no way around that due to the limitations in rice, ojb, etc.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

UPDATE_USER_LENGTH

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
ProtocolAssociateBase() Constructs a ProtocolAssociateBase.
ProtocolAssociateBase(ProtocolBase protocol) Constructs a ProtocolAssociateBase setting protocol related fields.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
ProtocolBase	getProtocol() Gets the protocol attribute.
Long	getProtocolId() Gets the protocolId attribute.
String	getProtocolNumber() Gets the protocol number.
Integer	getSequenceNumber() Gets the sequence number.
ProtocolBase	getSequenceOwner() The SequenceOwner is returned; "this" should be returned if this associate is the sequence owner.
int	hashCode()
void	init(ProtocolBase aProtocol) This inits the object to an unpersisted state by calling Sequenceable.resetPersistenceState() Also, sets the protocol, protocol id, sequence number, and protocol number.
void	postInitHook(ProtocolBase aProtocol) This method is designed to allow subclasses to perform additional initialization not performed by the final init method.
void	setProtocol(ProtocolBase protocol) Sets the protocol attribute value.
void	setProtocolId(Long protocolId) Sets the protocolId attribute value.
void	setProtocolNumber(String protocolNumber) Sets the protocol number.
void	setSequenceNumber(Integer sequenceNumber) Sets the sequence number.
void	setSequenceOwner(ProtocolBase newlyVersionedOwner) This sets the sequence owner on the associate.

Methods inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, prePersist, preUpdate, setUpdateTimestamp, setUpdateUser, setUpdateUserSet

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postRemove, postUpdate, preRemove, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.kra.Sequenceable

resetPersistenceState

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Constructor Detail

ProtocolAssociateBase

public ProtocolAssociateBase(ProtocolBase protocol)

Constructs a ProtocolAssociateBase setting protocol related fields.

Parameters:

protocol - the ProtocolBase

ProtocolAssociateBase

public ProtocolAssociateBase()

Constructs a ProtocolAssociateBase. Assures that the sequence number is always set. Note that when protocol implements versioning, the KC versioning API will need to manage sequenceNumber.

Method Detail

getProtocolId

public Long getProtocolId()

Gets the protocolId attribute.

Returns:

Returns the protocolId.

setProtocolId

public void setProtocolId(Long protocolId)

Sets the protocolId attribute value.

Parameters:

protocolId - The protocolId to set.

getProtocol

public ProtocolBase getProtocol()

Gets the protocol attribute.

Returns:

Returns the protocol.

setProtocol

public void setProtocol(ProtocolBase protocol)

Sets the protocol attribute value.

Parameters:

protocol - The protocol to set.

getSequenceNumber

public Integer getSequenceNumber()

Gets the sequence number.

Specified by:

getSequenceNumber in interface Sequenceable

Returns:

sequence number.

setSequenceNumber

public void setSequenceNumber(Integer sequenceNumber)

Sets the sequence number.

Parameters:

sequenceNumber - sequence number.

getProtocolNumber

public String getProtocolNumber()

Gets the protocol number.

Returns:

protocol number.

setProtocolNumber

public void setProtocolNumber(String protocolNumber)

Sets the protocol number.

Parameters:

protocolNumber - protocol number.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getSequenceOwner

public ProtocolBase getSequenceOwner()

The SequenceOwner is returned; "this" should be returned if this associate is the sequence owner.

Specified by:

getSequenceOwner in interface SequenceAssociate<ProtocolBase>

Returns:

the SequenceOwner

setSequenceOwner

public void setSequenceOwner(ProtocolBase newlyVersionedOwner)

This sets the sequence owner on the associate. Should no-op if this associate has no sequence owner

Specified by:

setSequenceOwner in interface SequenceAssociate<ProtocolBase>

init

public final void init(ProtocolBase aProtocol)

This inits the object to an unpersisted state by calling Sequenceable.resetPersistenceState() Also, sets the protocol, protocol id, sequence number, and protocol number.

Parameters:

aProtocol - the protocol to init the object with.

postInitHook

public void postInitHook(ProtocolBase aProtocol)

This method is designed to allow subclasses to perform additional initialization not performed by the final init method. This method is called by init(ProtocolBase) after all other initialization is performed.

Parameters:

aProtocol - the protocol initialization is requested with.