org.kuali.kra.protocol.noteattachment

Class ProtocolNotepadBase

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

org.kuali.kra.protocol.noteattachment.ProtocolNotepadBase

All Implemented Interfaces:

Serializable, Comparable<ProtocolNotepadBase>, 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:

IacucProtocolNotepad, ProtocolNotepad

public abstract class ProtocolNotepadBase
extends ProtocolAssociateBase
implements Comparable<ProtocolNotepadBase>

The ProtocolBase Notepad class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtocolNotepadBase.NotepadByEntryNumber compares Notepads by entry number.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	comments
protected String	createUserFullName
protected boolean	editable
protected Integer	entryNumber
protected Long	id
protected String	noteTopic
protected boolean	restrictedView
protected String	updateUserFullName

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

Modifier	Constructor and Description
protected	ProtocolNotepadBase() empty ctor to satisfy JavaBean convention.
	ProtocolNotepadBase(ProtocolBase protocol) Convenience ctor to add the protocol as an owner.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ProtocolNotepadBase protocolNotepad) Sort by updateTimestamp
boolean	equals(Object obj)
String	getComments() Gets the comments attribute.
Timestamp	getCreateTimestamp()
String	getCreateUser()
String	getCreateUserFullName()
Integer	getEntryNumber() Gets the entryNumber attribute.
Long	getId() Gets the id attribute.
String	getNoteTopic() Gets the noteTopic attribute.
boolean	getRestrictedView() Gets the restrictedView attribute.
String	getUpdateUserFullName() Gets the updateUserFullName attribute.
int	hashCode()
boolean	isEditable()
void	resetPersistenceState() This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
void	setComments(String comments) Sets the comments attribute value.
void	setCreateTimestamp(Timestamp createTimestamp)
void	setCreateUser(String createUser)
void	setCreateUserFullName(String createUserFullName)
void	setEditable(boolean editable)
void	setEntryNumber(Integer entryNumber) Sets the entryNumber attribute value.
void	setId(Long id) Sets the id attribute value.
void	setNoteTopic(String noteTopic) Sets the noteTopic attribute value.
void	setRestrictedView(boolean restrictedView) Sets the restrictedView attribute value.
void	setUpdateTimestamp(Timestamp updateTimestamp)
void	setUpdateUser(String updateUser) Sets the update user, making sure it is not the system user and truncating the name so it will fit.
void	setUpdateUserFullName(String updateUserFullName) Sets the updateUserFullName attribute value.

Methods inherited from class org.kuali.kra.protocol.ProtocolAssociateBase

getProtocol, getProtocolId, getProtocolNumber, getSequenceNumber, getSequenceOwner, init, postInitHook, setProtocol, setProtocolId, setProtocolNumber, setSequenceNumber, setSequenceOwner

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

getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, prePersist, preUpdate, 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.rice.core.api.mo.ModelObjectBasic

toString

Field Detail

id

protected Long id

entryNumber

protected Integer entryNumber

comments

protected String comments

restrictedView

protected boolean restrictedView

noteTopic

protected String noteTopic

editable

protected boolean editable

updateUserFullName

protected transient String updateUserFullName

createUserFullName

protected transient String createUserFullName

Constructor Detail

ProtocolNotepadBase

protected ProtocolNotepadBase()

empty ctor to satisfy JavaBean convention.

ProtocolNotepadBase

public ProtocolNotepadBase(ProtocolBase protocol)

Convenience ctor to add the protocol as an owner.

This ctor does not validate any of the properties.

Parameters:

protocol - the protocol.

Method Detail

getId

public Long getId()

Gets the id attribute.

Returns:

Returns the id.

setId

public void setId(Long id)

Sets the id attribute value.

Parameters:

id - The id to set.

getEntryNumber

public Integer getEntryNumber()

Gets the entryNumber attribute.

Returns:

Returns the entryNumber.

setEntryNumber

public void setEntryNumber(Integer entryNumber)

Sets the entryNumber attribute value.

Parameters:

entryNumber - The entryNumber to set.

getComments

public String getComments()

Gets the comments attribute.

Returns:

Returns the comments.

setComments

public void setComments(String comments)

Sets the comments attribute value.

Parameters:

comments - The comments to set.

getRestrictedView

public boolean getRestrictedView()

Gets the restrictedView attribute.

Returns:

Returns the restrictedView.

setRestrictedView

public void setRestrictedView(boolean restrictedView)

Sets the restrictedView attribute value.

Parameters:

restrictedView - The restrictedView to set.

getNoteTopic

public String getNoteTopic()

Gets the noteTopic attribute.

Returns:

Returns the noteTopic.

setNoteTopic

public void setNoteTopic(String noteTopic)

Sets the noteTopic attribute value.

Parameters:

noteTopic - The noteTopic to set.

getUpdateUserFullName

public String getUpdateUserFullName()

Gets the updateUserFullName attribute.

Returns:

Returns the updateUserFullName.

setUpdateUserFullName

public void setUpdateUserFullName(String updateUserFullName)

Sets the updateUserFullName attribute value.

Parameters:

updateUserFullName - The updateUserFullName to set.

getCreateUserFullName

public String getCreateUserFullName()

setCreateUserFullName

public void setCreateUserFullName(String createUserFullName)

resetPersistenceState

public void resetPersistenceState()

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

hashCode

public int hashCode()

Overrides:

hashCode in class ProtocolAssociateBase

equals

public boolean equals(Object obj)

Overrides:

equals in class ProtocolAssociateBase

setUpdateTimestamp

public void setUpdateTimestamp(Timestamp updateTimestamp)

Overrides:

setUpdateTimestamp in class KraPersistableBusinessObjectBase

setUpdateUser

public void setUpdateUser(String updateUser)

Description copied from class: KraPersistableBusinessObjectBase

Sets the update user, making sure it is not the system user and truncating the name so it will fit.

Overrides:

setUpdateUser in class KraPersistableBusinessObjectBase

Parameters:

updateUser - the user who updated this object

isEditable

public boolean isEditable()

setEditable

public void setEditable(boolean editable)

compareTo

public int compareTo(ProtocolNotepadBase protocolNotepad)

Sort by updateTimestamp

Specified by:

compareTo in interface Comparable<ProtocolNotepadBase>

See Also:

Comparable.compareTo(java.lang.Object)

getCreateUser

public String getCreateUser()

setCreateUser

public void setCreateUser(String createUser)

getCreateTimestamp

public Timestamp getCreateTimestamp()

setCreateTimestamp

public void setCreateTimestamp(Timestamp createTimestamp)