org.kuali.kra

Interface SequenceOwner<T extends SequenceOwner<?>>

Type Parameters:

T - the type of sequence owner which itself has an owner of unknown type

All Superinterfaces:

Sequenceable, SequenceAssociate<T>, Serializable

All Known Implementing Classes:

Award, CoiAnnualEventDisclosure, CoiDisclosure, CoiDisclosureReviews, CoiEventDisclosure, CoiNonProjectEventDisclosure, CoiSubmittedDisclosure, Committee, CommitteeBase, IacucCommittee, IacucProtocol, InstitutionalProposal, IntellectualPropertyReview, PersonFinIntDisclosure, Protocol, ProtocolBase, Question, Questionnaire, SubAward

public interface SequenceOwner<T extends SequenceOwner<?>>
extends SequenceAssociate<T>

This interface applies to classes that own a sequence number.

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getOwnerSequenceNumber() This method returns its owner's sequence number.
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.

Methods inherited from interface org.kuali.kra.SequenceAssociate

getSequenceOwner, setSequenceOwner

Methods inherited from interface org.kuali.kra.Sequenceable

getSequenceNumber, resetPersistenceState

Method Detail

incrementSequenceNumber

void incrementSequenceNumber()

This increments sequence number on an owner of a sequence.

getOwnerSequenceNumber

Integer getOwnerSequenceNumber()

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

Returns:

the owner's sequence number

getVersionNameField

String getVersionNameField()

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

Returns:

the field name that versions are "grouped" by