org.kuali.student.r2.common.infc
Interface HasId

All Superinterfaces:

HasPrimaryKey

All Known Subinterfaces:

AcademicCalendar, AcalEvent, Activity, ActivityOffering, ActivityOfferingCluster, ActivityOfferingDisplay, ActivityOfferingSet, ActivityRegistration, AdminOrg, AffiliatedOrg, AppliedHold, Appointment, AppointmentSlot, AppointmentWindow, Atp, AtpAtpRelation, AtpMilestoneRelation, Attribute, BatchJobResult, BatchJobResultItem, Building, Check, Clu, CluAccounting, CluCluRelation, CluFee, CluFeeRecord, CluIdentifier, CluInstructor, CluLoRelation, CluPublication, CluResult, CluSet, CluSetTreeView, ColocatedOfferingSet, Comment, CommonWithCoreProgram, CommonWithCredentialProgram, CommonWithProgramVariation, CoreProgram, Course, CourseCrossListing, CourseFee, CourseOffering, CourseOfferingCrossListing, CourseOfferingCrossListing, CourseOfferingDisplay, CourseRegistration, CourseRevenue, CourseVariation, CourseWaitlistEntry, CredentialProgram, CreditsGrade, CurrencyAmount, Document, EnrollmentFee, Exemption, ExemptionRequest, Expenditure, ExternalCredentialRecord, Format, FormatOffering, GPA, GradeRoster, GradeRosterEntry, HoldIssue, Holiday, HolidayCalendar, Honors, HonorsProgram, IdEntity, IdNamelessEntity, Instruction, KeyDate, LearningResultRecord, Lo, Load, LoCategory, LoDisplay, LoLoRelation, Lpr, LprRoster, LprRosterEntry, LprTransaction, LprTransactionItem, LprTransactionItemRequestOption, LuCode, Lui, LuiCapacity, LuiIdentifier, LuiLuiRelation, LuiSet, MajorDiscipline, MeetingSchedule, MeetingTime, MembershipQuery, Milestone, MinorDiscipline, OfferingInstructor, Org, OrgHierarchy, OrgOrgRelation, OrgPersonRelation, OrgPositionRestriction, Population, PopulationCategory, PopulationRule, ProcessCategory, ProgramRequirement, ProgramVariation, Proposal, RefDocRelation, RefStatementRelation, RegistrationGroup, RegistrationRequest, RegistrationRequestItem, Relationship, ReqCompField, ReqComponent, ResultOption, ResultSource, Revenue, Room, RoomFixedResource, RoomResponsibleOrg, RoomUsage, Schedule, ScheduleBatch, ScheduleComponent, ScheduleComponentDisplay, ScheduleDisplay, ScheduleRequest, ScheduleRequestComponent, ScheduleRequestComponentDisplay, ScheduleRequestDisplay, ScheduleTransaction, SeatPoolDefinition, Soc, SocRolloverResult, SocRolloverResultItem, StateChange, StateConstraint, Statement, StatementTreeView, StatePropagation, StudentCourseRecord, StudentCredentialRecord, StudentProgramRecord, StudentRank, StudentTestScoreRecord, StudentTransferCreditRecord, Tag, Term, TimeSlot, TypeTypeRelation

All Known Implementing Classes:

AcademicCalendarInfo, AcalEventInfo, ActivityInfo, ActivityOfferingClusterInfo, ActivityOfferingDisplayInfo, ActivityOfferingInfo, ActivityOfferingSetInfo, ActivityRegistrationInfo, AdminOrgInfo, AffiliatedOrgInfo, AppliedHoldInfo, AppointmentInfo, AppointmentSlotInfo, AppointmentWindowInfo, AtpAtpRelationInfo, AtpInfo, AttributeInfo, BatchJobResultInfo, BatchJobResultItemInfo, BuildingInfo, CheckInfo, CluAccountingInfo, CluCluRelationInfo, CluFeeInfo, CluFeeRecordInfo, CluIdentifierInfo, CluInfo, CluInstructorInfo, CluLoRelationInfo, CluPublicationInfo, CluResultInfo, CluSetInfo, CluSetTreeViewInfo, ColocatedOfferingSetInfo, CommentInfo, CommonWithCoreProgramInfo, CommonWithCredentialProgramInfo, CommonWithProgramVariationInfo, CoreProgramInfo, CourseCrossListingInfo, CourseFeeInfo, CourseInfo, CourseOfferingCrossListingInfo, CourseOfferingCrossListingInfo, CourseOfferingDisplayInfo, CourseOfferingInfo, CourseRegistrationInfo, CourseRevenueInfo, CourseVariationInfo, CourseWaitlistEntryInfo, CredentialProgramInfo, CreditOptionInfo, CreditsGradeInfo, CurrencyAmountInfo, DocumentInfo, EnrollmentFeeInfo, ExemptionInfo, ExemptionRequestInfo, ExpenditureInfo, ExternalCredentialRecordInfo, FormatInfo, FormatOfferingInfo, GPAInfo, GradeRosterEntryInfo, GradeRosterInfo, HoldIssueInfo, HolidayCalendarInfo, HolidayInfo, HonorsInfo, HonorsProgramInfo, IdEntityInfo, IdNamelessEntityInfo, InstructionInfo, KeyDateInfo, LearningResultRecordInfo, LoadInfo, LoCategoryInfo, LoDisplayInfo, LoInfo, LoLoRelationInfo, LprInfo, LprRosterEntryInfo, LprRosterInfo, LprTransactionInfo, LprTransactionItemInfo, LprTransactionItemRequestOptionInfo, LuCodeInfo, LuiCapacityInfo, LuiIdentifierInfo, LuiInfo, LuiLuiRelationInfo, LuiSetInfo, MajorDisciplineInfo, MeetingScheduleInfo, MeetingTimeInfo, MembershipQueryInfo, MilestoneInfo, MinorDisciplineInfo, OfferingInstructorInfo, OrgHierarchyInfo, OrgInfo, OrgOrgRelationInfo, OrgPersonRelationInfo, OrgPositionRestrictionInfo, PopulationCategoryInfo, PopulationInfo, PopulationRuleInfo, ProcessCategoryInfo, ProgramRequirementInfo, ProgramVariationInfo, ProposalInfo, RefDocRelationInfo, RefStatementRelationInfo, RegistrationGroupInfo, RegistrationRequestInfo, RegistrationRequestItemInfo, RelationshipInfo, ReqCompFieldInfo, ReqComponentInfo, ResultOptionInfo, ResultSourceInfo, RevenueInfo, RoomFixedResourceInfo, RoomInfo, RoomResponsibleOrgInfo, RoomUsageInfo, ScheduleBatchInfo, ScheduleComponentDisplayInfo, ScheduleComponentInfo, ScheduleDisplayInfo, ScheduleInfo, ScheduleRequestComponentDisplayInfo, ScheduleRequestComponentInfo, ScheduleRequestDisplayInfo, ScheduleRequestInfo, ScheduleTransactionInfo, SeatPoolDefinitionInfo, SocInfo, SocRolloverResultInfo, SocRolloverResultItemInfo, StateChangeInfo, StateConstraintInfo, StatementInfo, StatementTreeViewInfo, StatePropagationInfo, StudentCourseRecordInfo, StudentCredentialRecordInfo, StudentProgramRecordInfo, StudentRankInfo, StudentTestScoreRecordInfo, StudentTransferCreditRecordInfo, TagInfo, TermInfo, TimeSlotInfo, TypeTypeRelationInfo

public interface HasId
extends HasPrimaryKey

Common service pattern for entities. This interface is applied to entites that are identified by an Id.

Author:

nwright

Method Summary

String

getId() The system assigned unique id to identify this Object.

Method Detail

getId

String getId()

The system assigned unique id to identify this Object. Could be implemented as as sequence number or as a UUID. Attempts to set this value on creates should result in a ReadOnlyException being thrown An Id:

• An id is used when the actual value is unimportant and can therefore be a large hex value for example
• An id value might be 23b9ca9bd203df902
• An Id is never intended to be used directly by an end user.
• Ids are assumed to be of different values in different KS implementations
• Id values are generated by the service implementations
• Id values are never expected to be used in Configuration or Application code