org.kuali.kra.common.committee.bo

Class CommitteeBase<CMT extends CommitteeBase<CMT,CD,CS>,CD extends CommitteeDocumentBase<CD,CMT,CS>,CS extends CommitteeScheduleBase<CS,CMT,?,?>>

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.common.committee.bo.CommitteeBase<CMT,CD,CS>

All Implemented Interfaces:

Serializable, Comparable<CMT>, org.apache.ojb.broker.PersistenceBrokerAware, Permissionable, Sequenceable, SequenceAssociate<CMT>, SequenceOwner<CMT>, 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:

Committee, IacucCommittee

public abstract class CommitteeBase<CMT extends CommitteeBase<CMT,CD,CS>,CD extends CommitteeDocumentBase<CD,CMT,CS>,CS extends CommitteeScheduleBase<CS,CMT,?,?>>
extends KraPersistableBusinessObjectBase
implements Comparable<CMT>, SequenceOwner<CMT>, Permissionable

Represents a single committee within an institution.

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

Fields inherited from interface org.kuali.kra.common.permissions.Permissionable

AWARD_BUDGET_KEY, AWARD_KEY, COI_DISCLOSURE_KEY, COMMITTEE_KEY, COMMITTEE_SCHEDULE_KEY, IACUC_PROTOCOL_KEY, IACUC_PROTOCOL_ONLINE_REVIEW_KEY, NEGOTIATION_KEY, PROPOSAL_BUDGET_KEY, PROPOSAL_KEY, PROTOCOL_KEY, PROTOCOL_ONLINE_REVIEW_KEY, SPONSOR_HIREARCHY_KEY, SUBAWARD_KEY, TIME_AND_MONEY_KEY

Constructor Summary

Constructors

Constructor and Description
CommitteeBase() Constructs a CommitteeBase.

Method Summary

Methods

Modifier and Type	Method and Description
List	buildListOfDeletionAwareLists()
int	compareTo(CMT committee) The default comparator goes by the order of committeeId, sequenceNumber.
protected abstract String	getAdminRoleHook()
Integer	getAdvancedSubmissionDaysRequired()
CoiReviewType	getCoiReviewType()
String	getCoiReviewTypeCode()
String	getCommitteeChair()
String	getCommitteeDescription()
CD	getCommitteeDocument()
String	getCommitteeId()
CommitteeMembershipBase	getCommitteeMembershipFor(String personId) This method will return the committee membership instance representing the person given by personID.
List<CommitteeMembershipBase>	getCommitteeMemberships()
String	getCommitteeName()
List<CommitteeResearchAreaBase>	getCommitteeResearchAreas()
List<CS>	getCommitteeSchedules()
CommitteeType	getCommitteeType()
String	getCommitteeTypeCode()
String	getDocumentKey() This method returns unique key for implementing document.
String	getDocumentNumberForPermission() This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.
String	getDocumentRoleTypeCode()
Unit	getHomeUnit()
String	getHomeUnitNumber()
Long	getId()
String	getLeadUnitNumber()
Integer	getMaxProtocols()
Integer	getMinimumMembersRequired()
protected abstract String	getModuleNamespaceCodeHook()
String	getNamespace()
Integer	getOwnerSequenceNumber() This method returns its owner's sequence number.
Boolean	getPrintRooster()
protected abstract String	getProtocolCommitteeTypeCodehook()
protected abstract String	getProtocolReviewerRoleHook()
ProtocolReviewTypeBase	getReviewType()
String	getReviewTypeCode()
List<String>	getRoleNames() This method gets all the role names for particular document.
String	getScheduleDescription()
Integer	getSequenceNumber() This gets the current version number.
CMT	getSequenceOwner() The SequenceOwner is returned; "this" should be returned if this associate is the sequence owner.
protected abstract CMT	getThisHook()
String	getUnitName()
String	getVersionNameField() For Award, this would be "awardNumber", for Committee "committeeName", for Protocol "protocolNumber", etc.
void	incrementSequenceNumber() This increments sequence number on an owner of a sequence.
void	populateAdditionalQualifiedRoleAttributes(Map<String,String> qualifiedRoleAttributes) Allows a permissionable to set additional qualified role attributes that may be needed by kim services to resolve the role members.
void	resetPersistenceState() This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
void	setAdvancedSubmissionDaysRequired(Integer advancedSubmissionDaysRequired)
void	setCoiReviewType(CoiReviewType coiReviewType)
void	setCoiReviewTypeCode(String coiReviewTypeCode)
void	setCommitteeChair(String committeeChair)
void	setCommitteeDescription(String committeeDescription)
void	setCommitteeDocument(CD committeeDocument)
void	setCommitteeId(String committeeId)
void	setCommitteeMemberships(List<CommitteeMembershipBase> committeeMemberships)
void	setCommitteeName(String committeeName)
void	setCommitteeResearchAreas(List<CommitteeResearchAreaBase> committeeResearchAreas)
void	setCommitteeSchedules(List<CS> committeeSchedules)
void	setCommitteeType(CommitteeType committeeType)
void	setCommitteeTypeCode(String committeeTypeCode)
void	setHomeUnit(Unit homeUnit)
void	setHomeUnitNumber(String homeUnitNumber)
void	setId(Long id)
void	setMaxProtocols(Integer maxProtocols)
void	setMinimumMembersRequired(Integer minimumMembersRequired)
void	setPrintRooster(Boolean printRooster)
void	setReviewType(ProtocolReviewTypeBase reviewType)
void	setReviewTypeCode(String reviewTypeCode)
void	setScheduleDescription(String scheduleDescription)
void	setSequenceNumber(Integer sequenceNumber)
void	setSequenceOwner(CMT newOwner) This sets the sequence owner on the associate.
void	setUnitName(String unitName)

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, 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

Constructor Detail

CommitteeBase

public CommitteeBase()

Constructs a CommitteeBase.

Method Detail

getProtocolCommitteeTypeCodehook

protected abstract String getProtocolCommitteeTypeCodehook()

getId

public Long getId()

setId

public void setId(Long id)

getCommitteeId

public String getCommitteeId()

setCommitteeId

public void setCommitteeId(String committeeId)

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)

getCommitteeName

public String getCommitteeName()

setCommitteeName

public void setCommitteeName(String committeeName)

getHomeUnitNumber

public String getHomeUnitNumber()

setHomeUnitNumber

public void setHomeUnitNumber(String homeUnitNumber)

getCommitteeDescription

public String getCommitteeDescription()

setCommitteeDescription

public void setCommitteeDescription(String committeeDescription)

getScheduleDescription

public String getScheduleDescription()

setScheduleDescription

public void setScheduleDescription(String scheduleDescription)

getCommitteeTypeCode

public String getCommitteeTypeCode()

setCommitteeTypeCode

public void setCommitteeTypeCode(String committeeTypeCode)

getMinimumMembersRequired

public Integer getMinimumMembersRequired()

setMinimumMembersRequired

public void setMinimumMembersRequired(Integer minimumMembersRequired)

getMaxProtocols

public Integer getMaxProtocols()

setMaxProtocols

public void setMaxProtocols(Integer maxProtocols)

getAdvancedSubmissionDaysRequired

public Integer getAdvancedSubmissionDaysRequired()

setAdvancedSubmissionDaysRequired

public void setAdvancedSubmissionDaysRequired(Integer advancedSubmissionDaysRequired)

getReviewTypeCode

public String getReviewTypeCode()

setReviewTypeCode

public void setReviewTypeCode(String reviewTypeCode)

getCoiReviewTypeCode

public String getCoiReviewTypeCode()

setCoiReviewTypeCode

public void setCoiReviewTypeCode(String coiReviewTypeCode)

getHomeUnit

public Unit getHomeUnit()

setHomeUnit

public void setHomeUnit(Unit homeUnit)

getCommitteeType

public CommitteeType getCommitteeType()

setCommitteeType

public void setCommitteeType(CommitteeType committeeType)

getReviewType

public ProtocolReviewTypeBase getReviewType()

setReviewType

public void setReviewType(ProtocolReviewTypeBase reviewType)

getCoiReviewType

public CoiReviewType getCoiReviewType()

setCoiReviewType

public void setCoiReviewType(CoiReviewType coiReviewType)

getCommitteeDocument

public CD getCommitteeDocument()

setCommitteeDocument

public void setCommitteeDocument(CD committeeDocument)

getCommitteeMemberships

public List<CommitteeMembershipBase> getCommitteeMemberships()

setCommitteeMemberships

public void setCommitteeMemberships(List<CommitteeMembershipBase> committeeMemberships)

setCommitteeSchedules

public void setCommitteeSchedules(List<CS> committeeSchedules)

getCommitteeSchedules

public List<CS> getCommitteeSchedules()

getCommitteeResearchAreas

public List<CommitteeResearchAreaBase> getCommitteeResearchAreas()

setCommitteeResearchAreas

public void setCommitteeResearchAreas(List<CommitteeResearchAreaBase> committeeResearchAreas)

getPrintRooster

public Boolean getPrintRooster()

setPrintRooster

public void setPrintRooster(Boolean printRooster)

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.krad.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

getCommitteeChair

public String getCommitteeChair()

setCommitteeChair

public void setCommitteeChair(String committeeChair)

getUnitName

public String getUnitName()

setUnitName

public void setUnitName(String unitName)

getOwnerSequenceNumber

public Integer getOwnerSequenceNumber()

Description copied from interface: SequenceOwner

This method returns its owner's sequence number. If this is the top level owner; i.e. Protocol or Award, it should return null

Specified by:

getOwnerSequenceNumber in interface SequenceOwner<CMT extends CommitteeBase<CMT,CD,CS>>

Returns:

the owner's sequence number

incrementSequenceNumber

public void incrementSequenceNumber()

Description copied from interface: SequenceOwner

This increments sequence number on an owner of a sequence.

Specified by:

incrementSequenceNumber in interface SequenceOwner<CMT extends CommitteeBase<CMT,CD,CS>>

getSequenceOwner

public CMT getSequenceOwner()

Description copied from interface: SequenceAssociate

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

Specified by:

getSequenceOwner in interface SequenceAssociate<CMT extends CommitteeBase<CMT,CD,CS>>

Returns:

the SequenceOwner

getThisHook

protected abstract CMT getThisHook()

setSequenceOwner

public void setSequenceOwner(CMT newOwner)

Description copied from interface: SequenceAssociate

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

Specified by:

setSequenceOwner in interface SequenceAssociate<CMT extends CommitteeBase<CMT,CD,CS>>

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

compareTo

public int compareTo(CMT committee)

The default comparator goes by the order of committeeId, sequenceNumber.

Specified by:

compareTo in interface Comparable<CMT extends CommitteeBase<CMT,CD,CS>>

Parameters:

committee - the CommitteeBase to be compared.

Returns:

the value 0 if this CommitteeBase is equal to the argument CommitteeBase; a value less than 0 if this CommitteeBase has a committeeId & sequenceNumber pair that is less than the argument CommitteeBase; and a value greater than 0 if this CommitteeBase has a committeeId & sequenceNumber pair that is greater than the argument CommitteeBase.

getVersionNameField

public String getVersionNameField()

Description copied from interface: SequenceOwner

For Award, this would be "awardNumber", for Committee "committeeName", for Protocol "protocolNumber", etc.

Specified by:

getVersionNameField in interface SequenceOwner<CMT extends CommitteeBase<CMT,CD,CS>>

Returns:

the field name that versions are "grouped" by

See Also:

org.kuali.kra.SequenceOwner#getName()

getDocumentKey

public String getDocumentKey()

Description copied from interface: Permissionable

This method returns unique key for implementing document.

Specified by:

getDocumentKey in interface Permissionable

Returns:

See Also:

Permissionable.getDocumentKey()

populateAdditionalQualifiedRoleAttributes

public void populateAdditionalQualifiedRoleAttributes(Map<String,String> qualifiedRoleAttributes)

Description copied from interface: Permissionable

Allows a permissionable to set additional qualified role attributes that may be needed by kim services to resolve the role members.

Specified by:

populateAdditionalQualifiedRoleAttributes in interface Permissionable

See Also:

Permissionable.populateAdditionalQualifiedRoleAttributes(java.util.Map)

getDocumentNumberForPermission

public String getDocumentNumberForPermission()

Description copied from interface: Permissionable

This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.

Specified by:

getDocumentNumberForPermission in interface Permissionable

Returns:

See Also:

Permissionable.getDocumentNumberForPermission()

getRoleNames

public List<String> getRoleNames()

Description copied from interface: Permissionable

This method gets all the role names for particular document.

Specified by:

getRoleNames in interface Permissionable

Returns:

See Also:

Permissionable.getRoleNames()

getProtocolReviewerRoleHook

protected abstract String getProtocolReviewerRoleHook()

getAdminRoleHook

protected abstract String getAdminRoleHook()

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface Permissionable

getModuleNamespaceCodeHook

protected abstract String getModuleNamespaceCodeHook()

getLeadUnitNumber

public String getLeadUnitNumber()

Specified by:

getLeadUnitNumber in interface Permissionable

getDocumentRoleTypeCode

public String getDocumentRoleTypeCode()

Specified by:

getDocumentRoleTypeCode in interface Permissionable

getCommitteeMembershipFor

public CommitteeMembershipBase getCommitteeMembershipFor(String personId)

This method will return the committee membership instance representing the person given by personID. If no such membership is associated with the committee, then null is returned. Also returns null if the personId parameter is null.

Parameters:

personId -

Returns: