class SCC_COMMON:ENTITY:StagedEntity
SCC_COMMON:ENTITY:AbstractEntity – – SCC_COMMON:ENTITY:StagedEntity
Direct Known Subclasses: SCC_COMMON:ENTITY:GENERICS:GenericStagedEntity
Summary
Property Summary:
|
public boolean |
DO_SAVE_CHILDREN: Specifies if the children should be saved. |
|
public string |
EMPLID: Builds the xml schema section pertaining to this entity. The implementation builds and populates the schema based on the underlying record, ignoring any fields in the ignore array. Keys that roll down from the parent are not marked required on the child. RECOMMENDATION: Only override if the entity requires a custom schema. @param xmlnode: The Tools XmlNode object of the parent that should be continued by this entity. |
|
public string |
entityID: The entity ID based on the entity registry. |
|
public string |
entityName: The entity Name as specified in the registry. |
|
public string |
PROD_RECORD_NAME: The Production Record name from the registry. |
|
public number |
SCC_TEMP_ID: The property for the tempid field on stage records. |
|
public string |
STAGE_RECORD_NAME: The Stage Record name from the registry. |
|
Properties Inherited from SCC_COMMON:ENTITY:AbstractEntity |
baseProps, ChildEntityArray, data, dataPreimage, DO_SAVE, dynamicProperties, entityDelete, EntityMetaData, hasAuditRowAddDttm, hasAuditRowAddOprid, hasAuditRowUpdDttm, hasAuditRowUpdOprid, ignoreFields, keyCollection, parent, parentCE, prodRecordName, PropertyMetaData, RECORD_NAME, SCC_ENTITY_INST_ID, SCC_ROW_ADD_DTTM, SCC_ROW_ADD_OPRID, SCC_ROW_UPD_DTTM, SCC_ROW_UPD_OPRID, selfServiceMode, STAGE_MODE, UPDATE_RULE, USER_CONTEXT, workflowPreimage, XSDCustomNS, XSDFieldList, XSDNS |
Constructor Summary:
|
public void |
StagedEntity(IEntity p_parent): The Constructor |
Method Summary:
|
public void |
comparePreviousEffdt(): Compares the current record underlying this entity with previous effective dated rows. If no data has changed between this entity and the current effective dated row it prevents a save from occurring. This only matters when we are dealing with effective dated entities. RECOMMENDATION: Do not override. |
|
public void |
demote(number p_tempID): Moves data from production records to staging record. RECOMMENDATION: Do not override. |
|
public string |
getID(): Retrieves the temp ID. |
|
protected string |
getProdRecordName(): Retrieves the production record name. |
|
protected string |
getStageRecordName(): Retrieves the stage record name. |
|
public void |
promote(string p_emplID, MessageLogBase p_log out): Moves Data from Staging to Production Records (does not validate or save). RECOMMENDATION: Do not override. |
|
public void |
save(MessageLogBase p_messageLog out): Calls presave and issues save for all children then a save for this entity. RECOMMENDATION: Do not override. |
|
protected void |
setEntityID(string p_entityID): Sets the entity ID, and retrieves the related information from the registry. RECOMMENDATION: Do not override. |
|
public void |
setID(string p_ID): Sets the temp id for this entity. RECOMMENDATION: Do not override. |
|
public void |
setStageMode(boolean p_stageInd): Sets the stage mode and changes the underlying record to stage/production for this entity and all children. RECOMMENDATION: Do not override. |
|
Methods Inherited from SCC_COMMON:ENTITY:AbstractEntity |
applyDataKey, buildCSVString, buildPropertyMetaDataCache, buildXSD, buildXSDChildren, changeRecord, clearDataPreImage, clearDataPreImageChildren, commonValidate, defaultChildren, delete, deleteChildren, demoteChildren, destroy, entityFieldUpdateNeeded, entityTypeUpdateNeeded, entityTypeUpdateRequested, entityUpdateRequested, fill, fillChildren, fillFromKeys, fillLOVDescrs, fromXmlNode, fromXmlNodeChildren, generateRowset, generateXSD, getChildEntity, getCSUserDefaults, getDataKey, getEntPropsByPropertyName, getFullEntityPathName, getIgnoreFields, getInstallationHCM, getLOVDescr, getLOVValue, getMaxSeqNbrSQL, getParent, getProperty, getPropertyByMetaRec, getRecordName, getTagByFieldName, hardDelete, hardDeleteChildren, hasEffdt, hasEffseq, hasKey, isEqualKeys, isEqualKeysRecord, populateAudit, prePublish, preSave, preSaveChildren, preSaveFirst, promoteChildren, publish, retrieveDataRule, saveChildren, setChildren, setData, setDataPreImage, setDefault, setKeyList, setProperty, setPropertyByMetaRec, setUpdateRule, setUpdateRuleByTransName, setUserContext, testForAudit, toXmlNode, toXmlNodeChildren, updateChildFields, updateFromRecord, updateKeyFields, validate, validateChildren, validateFirst, workflow |
Details
Property Details:
|
DO_SAVE_CHILDREN |
public boolean |
|
EMPLID |
public string |
|
entityID |
public string |
|
entityName |
public string |
|
PROD_RECORD_NAME |
public string |
|
SCC_TEMP_ID |
public number |
|
STAGE_RECORD_NAME |
public string |
Constructor Details:
|
StagedEntity |
Parameters: IEntity p_parent: the parent of this entity, or null if this is the top of the entity tree. |
Method Details:
|
comparePreviousEffdt |
|
|
demote |
Parameters: number p_tempID: The tempid to replace the emplid with. |
|
getID |
Return: string - the tempID |
|
getProdRecordName |
Return: string |
|
getStageRecordName |
Return: string |
|
promote |
Parameters: string p_emplID MessageLogBase p_log(out): The MessageLog object to log all errors/warnings to. |
|
save |
Parameters: MessageLogBase p_messageLog(out): The message log. |
|
setEntityID |
Parameters: string p_entityID: The ID of the Entity. |
|
setID |
Parameters: string p_ID: The temporary ID value to set. |
|
setStageMode |
Parameters: boolean p_stageInd: Set to stage (true) or production (false). |