org.kuali.kra.protocol.noteattachment

Class ProtocolAttachmentPersonnelBase

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.ProtocolAttachmentBase

org.kuali.kra.protocol.noteattachment.ProtocolAttachmentPersonnelBase

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, TypedAttachment, 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:

IacucProtocolAttachmentPersonnel, ProtocolAttachmentPersonnel

public abstract class ProtocolAttachmentPersonnelBase
extends ProtocolAttachmentBase

This class represents the ProtocolBase Attachment Personnel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtocolAttachmentPersonnelBase.PropertyName Contains all the property names in this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected ProtocolPersonBase	person
protected Integer	personId
protected ProtocolAttachmentTypeBase	type
protected String	typeCode

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
ProtocolAttachmentPersonnelBase() empty ctor to satisfy JavaBean convention.
ProtocolAttachmentPersonnelBase(ProtocolBase protocol) Convenience ctor to add the protocol as an owner.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
abstract String	getAttachmentDescription() A human readable description of the attachment type.
String	getDescription() Gets the Description.
abstract String	getGroupCode() The group code that the ProtocolBase Attachment belongs to.
ProtocolPersonBase	getPerson() Gets the ProtocolBase Attachment Personnel Person.
Integer	getPersonId() Gets the person Id.
ProtocolAttachmentTypeBase	getType() Gets the ProtocolBase Attachment Base Type.
String	getTypeCode() Gets the type Code .
int	hashCode()
void	init(ProtocolPersonBase protocolPerson)
void	resetPersistenceState() This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
void	setDescription(String description) Sets the Description.
void	setPerson(ProtocolPersonBase person) Sets the ProtocolBase Attachment Personnel Person.
void	setPersonId(Integer personId) Sets the person Id.
void	setType(ProtocolAttachmentTypeBase type) Sets the ProtocolBase Attachment Base Type.
void	setTypeCode(String typeCode) Sets the type Code.
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.
boolean	supportsVersioning() Method to check whether an attachment supports versioning.

Methods inherited from class org.kuali.kra.protocol.noteattachment.ProtocolAttachmentBase

addAttachmentToCollection, filterExistingAttachments, filterNewAttachments, getDocumentId, getFile, getFileId, getId, getNewFile, getUpdateUserFullName, isNew, removeAttachmentFromCollection, setDocumentId, setFile, setFileId, setId, setNewFile, setUpdateUserFullName

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

personId

protected Integer personId

person

protected ProtocolPersonBase person

typeCode

protected String typeCode

type

protected ProtocolAttachmentTypeBase type

description

protected String description

Constructor Detail

ProtocolAttachmentPersonnelBase

public ProtocolAttachmentPersonnelBase()

empty ctor to satisfy JavaBean convention.

ProtocolAttachmentPersonnelBase

public ProtocolAttachmentPersonnelBase(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

getPerson

public ProtocolPersonBase getPerson()

Gets the ProtocolBase Attachment Personnel Person.

Returns:

the ProtocolBase Attachment Personnel Person

setPerson

public void setPerson(ProtocolPersonBase person)

Sets the ProtocolBase Attachment Personnel Person.

Parameters:

person - the ProtocolBase Attachment Personnel Person

getPersonId

public Integer getPersonId()

Gets the person Id.

Returns:

the person Id.

setPersonId

public void setPersonId(Integer personId)

Sets the person Id.

Parameters:

personId - the person Id.

getType

public ProtocolAttachmentTypeBase getType()

Gets the ProtocolBase Attachment Base Type.

Returns:

the ProtocolBase Attachment Base Type

setType

public void setType(ProtocolAttachmentTypeBase type)

Sets the ProtocolBase Attachment Base Type.

Parameters:

type - the ProtocolBase Attachment Base Type

getTypeCode

public String getTypeCode()

Gets the type Code .

Returns:

the type Code.

setTypeCode

public void setTypeCode(String typeCode)

Sets the type Code.

Parameters:

typeCode - the type Code.

getGroupCode

public abstract String getGroupCode()

The group code that the ProtocolBase Attachment belongs to. The group code relates to ProtocolAttachmentGroup.

Returns:

the group code.

getDescription

public String getDescription()

Gets the Description.

Returns:

the Description

setDescription

public void setDescription(String description)

Sets the Description.

Parameters:

description - the Description

getAttachmentDescription

public abstract String getAttachmentDescription()

A human readable description of the attachment type.

Specified by:

getAttachmentDescription in class ProtocolAttachmentBase

Returns:

a description

supportsVersioning

public boolean supportsVersioning()

Method to check whether an attachment supports versioning. Currently, all attachments have structural capabilities to version; however, currently we are not versioning all attachment types to be consistent with other parts of KC.

Specified by:

supportsVersioning in class ProtocolAttachmentBase

Returns:

true is attachment supports versioning.

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. also nulling the person id because when saving after versioning, the person id is reverting to the wrong BO.

Specified by:

resetPersistenceState in interface Sequenceable

Overrides:

resetPersistenceState in class ProtocolAttachmentBase

hashCode

public int hashCode()

Overrides:

hashCode in class ProtocolAttachmentBase

equals

public boolean equals(Object obj)

Overrides:

equals in class ProtocolAttachmentBase

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

init

public void init(ProtocolPersonBase protocolPerson)