org.kuali.student.r2.common.dto
Class IdEntityInfo

java.lang.Object
  org.kuali.student.r2.common.dto.HasAttributesInfo
      org.kuali.student.r2.common.dto.HasAttributesAndMetaInfo
          org.kuali.student.r2.common.dto.TypeStateEntityInfo
              org.kuali.student.r2.common.dto.EntityInfo
                  org.kuali.student.r2.common.dto.IdEntityInfo

All Implemented Interfaces:

Serializable, Entity, HasAttributes, HasAttributesAndMeta, HasId, HasMeta, HasPrimaryKey, HasState, HasType, IdEntity, TypeStateEntity

Direct Known Subclasses:

AcademicCalendarInfo, AcalEventInfo, ActivityInfo, ActivityOfferingClusterInfo, ActivityOfferingDisplayInfo, ActivityOfferingInfo, AdminOrgInfo, AppliedHoldInfo, AppointmentWindowInfo, AtpInfo, BatchJobResultInfo, BuildingInfo, CheckInfo, CluSetInfo, CluSetTreeViewInfo, ColocatedOfferingSetInfo, CourseFeeInfo, CourseInfo, CreditOptionInfo, DocumentInfo, ExemptionInfo, ExemptionRequestInfo, ExternalCredentialRecordInfo, FormatOfferingInfo, GradeRosterInfo, HoldIssueInfo, HolidayCalendarInfo, HolidayInfo, HonorsInfo, KeyDateInfo, LearningResultRecordInfo, LoCategoryInfo, LoDisplayInfo, LoInfo, LprRosterInfo, LprTransactionInfo, LprTransactionItemInfo, LuiCapacityInfo, LuiInfo, LuiLuiRelationInfo, LuiSetInfo, MilestoneInfo, OrgHierarchyInfo, PopulationCategoryInfo, PopulationInfo, PopulationRuleInfo, ProcessCategoryInfo, ProposalInfo, RegistrationGroupInfo, RegistrationRequestInfo, RegistrationRequestItemInfo, ResultSourceInfo, RoomInfo, ScheduleBatchInfo, ScheduleDisplayInfo, ScheduleInfo, ScheduleRequestDisplayInfo, ScheduleRequestInfo, ScheduleTransactionInfo, SeatPoolDefinitionInfo, SocInfo, StatementInfo, StatementTreeViewInfo, StudentCredentialRecordInfo, StudentProgramRecordInfo, StudentTestScoreRecordInfo, TermInfo, TimeSlotInfo

public abstract class IdEntityInfo
extends EntityInfo
implements IdEntity, Serializable

Information for entities identified by an Id.

Author:

Kuali Student Team (sambit)

See Also:

Serialized Form

Constructor Summary

protected	IdEntityInfo() Constructs a new IdEntityInfo.
	IdEntityInfo(IdEntity idEntity) Constructs a new IdEntityInfo from another IdEntity.

Method Summary

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

Methods inherited from class org.kuali.student.r2.common.dto.EntityInfo

getDescr, getName, setDescr, setName

Methods inherited from class org.kuali.student.r2.common.dto.TypeStateEntityInfo

getState, getStateKey, getType, getTypeKey, setState, setStateKey, setType, setTypeKey

Methods inherited from class org.kuali.student.r2.common.dto.HasAttributesAndMetaInfo

getMeta, setMeta

Methods inherited from class org.kuali.student.r2.common.dto.HasAttributesInfo

getAttributes, getAttributeValue, getAttributeValueList, setAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.student.r2.common.infc.Entity

getDescr, getName

Methods inherited from interface org.kuali.student.r2.common.infc.HasType

getType, getTypeKey

Methods inherited from interface org.kuali.student.r2.common.infc.HasState

getState, getStateKey

Methods inherited from interface org.kuali.student.r2.common.infc.HasAttributes

getAttributes

Methods inherited from interface org.kuali.student.r2.common.infc.HasMeta

getMeta

Constructor Detail

IdEntityInfo

protected IdEntityInfo()

Constructs a new IdEntityInfo.

IdEntityInfo

public IdEntityInfo(IdEntity idEntity)

Constructs a new IdEntityInfo from another IdEntity.

Parameters:

idEntity - the IdEntity to copy

Method Detail

getId

public String getId()

Description copied from interface: HasId

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

Specified by:

getId in interface HasId

setId

public void setId(String id)