org.kuali.kra.protocol.actions.amendrenew

Class ProtocolAmendRenewalBase

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.protocol.actions.amendrenew.ProtocolAmendRenewalBase

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:

IacucProtocolAmendRenewal, ProtocolAmendRenewal

public abstract class ProtocolAmendRenewalBase
extends KraPersistableBusinessObjectBase
implements SequenceAssociate<ProtocolBase>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ProtocolAmendRenewModuleBase>	modules

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
ProtocolAmendRenewalBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	addModule(ProtocolAmendRenewModuleBase module)
Date	getDateCreated()
Long	getId()
List<ProtocolAmendRenewModuleBase>	getModules()
String	getProtoAmendRenNumber()
ProtocolBase	getProtocol()
Long	getProtocolId()
String	getProtocolNumber()
Integer	getSequenceNumber() This gets the current version number.
ProtocolBase	getSequenceOwner() The SequenceOwner is returned; "this" should be returned if this associate is the sequence owner.
String	getSummary()
boolean	hasModule(String protocolModuleTypeCode) This method checks to see if the protocol amendment or renewal amends a specific module.
void	removeModule(String protocolModuleTypeCode)
void	resetPersistenceState() This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
void	setDateCreated(Date dateCreated)
void	setId(Long id)
void	setModules(List<ProtocolAmendRenewModuleBase> modules)
void	setProtoAmendRenNumber(String protoAmendRenNumber)
void	setProtocol(ProtocolBase protocol)
void	setProtocolId(Long long1)
void	setProtocolNumber(String protocolNumber)
void	setSequenceNumber(Integer sequenceNumber)
void	setSequenceOwner(ProtocolBase newlyVersionedOwner) This sets the sequence owner on the associate.
void	setSummary(String summary)

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

toString

Field Detail

modules

protected List<ProtocolAmendRenewModuleBase> modules

Constructor Detail

ProtocolAmendRenewalBase

public ProtocolAmendRenewalBase()

Method Detail

getId

public Long getId()

setId

public void setId(Long id)

getProtoAmendRenNumber

public String getProtoAmendRenNumber()

setProtoAmendRenNumber

public void setProtoAmendRenNumber(String protoAmendRenNumber)

getDateCreated

public Date getDateCreated()

setDateCreated

public void setDateCreated(Date dateCreated)

getSummary

public String getSummary()

setSummary

public void setSummary(String summary)

getProtocolId

public Long getProtocolId()

setProtocolId

public void setProtocolId(Long long1)

getProtocolNumber

public String getProtocolNumber()

setProtocolNumber

public void setProtocolNumber(String protocolNumber)

getSequenceNumber

public Integer getSequenceNumber()

Description copied from interface: Sequenceable

This gets the current version number.

Specified by:

getSequenceNumber in interface Sequenceable

Returns:

the sequence number

setSequenceNumber

public void setSequenceNumber(Integer sequenceNumber)

getModules

public List<ProtocolAmendRenewModuleBase> getModules()

setModules

public void setModules(List<ProtocolAmendRenewModuleBase> modules)

addModule

public void addModule(ProtocolAmendRenewModuleBase module)

removeModule

public void removeModule(String protocolModuleTypeCode)

hasModule

public boolean hasModule(String protocolModuleTypeCode)

This method checks to see if the protocol amendment or renewal amends a specific module.

Parameters:

protocolModuleTypeCode -

Returns:

true if the module is being amended, false otherwise.

getProtocol

public ProtocolBase getProtocol()

setProtocol

public void setProtocol(ProtocolBase protocol)

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>

resetPersistenceState

public void resetPersistenceState()

Description copied from interface: Sequenceable

This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity. During sequencing, the VersioningService needs to be able to signal that a Sequenceable has changed state from an persisted entity to a new, unpersisted one. Otherwise, versioning operations would result earlier SequenceOwners losing the association with older versions of associates. This behavior comes into play whenever an associated object is versioned. Typically, implementers will set primary key fields to null to trigger an INSERT during save.

Specified by:

resetPersistenceState in interface Sequenceable