Entity Application Class Reference

baseProps: A list of properties that are controlled on the base entities, so the property name cannot be changed.

ChildEntityArray: An array of all the ChildEntities of the current entity.

data: This entities a backing record.

entityDelete: Marks this entity for deletion, and prevents save.

entityID: ID of the entity from the registry.

entityName: The name of the entity as defined in the registry.

keyCollection: A collection of key values to be used when population of this entity occurs.

parent: parent Entity, null if it is at the top level of tree.

parentCE: The child entity that encompasses all the entities of a particular type under the parent.

SCC_ENTITY_INST_ID: Entity Instance Id.

selfServiceMode: Self Service mode flag.

STAGE_MODE: Specifies if this entity is currently in Stage Mode (True) and working with the stage record, or in Production Mode (False) and working with the production record.

UPDATE_RULE: Specifies the update rule to use for the purposes of Data Update Rule.

USER_CONTEXT: The user that this is being run on behalf of, since adds and updates may be done from administrative mode on behalf of a given user.

XSDFieldList: A string list of all the fields for the current entity for the XSD. This is used in conjunction with buildXSD to determine if key fields are required, based on if their parent has the same key.

buildXSD(XmlNode xmlnode): Builds the xml schema section pertaining to this entity.

clearDataPreImage(): Clears the DataPreImage for this entity and all its children.

delete(boolean p_entityDelete): Sets entityDelete property for this entity and all its children.

demote(number p_tempID): Moves data from production records to staging record.

destroy(): Perform cleanup activity on this entity.

fill(Record p_inRec out, boolean p_clearState): Fill (Populate) this entity using the given record, and populates all children based on the key structure.

fillFromKeys(boolean p_clearState): Performs a select by key based on the fields on the underlying record. This should be run on the top level entity to start a fill.

fromXmlNode(XmlNode parentNode): Converts data from XML to the entity model.

generateRowset(): This method generates a rowset of data for the underlying record of this entity based on the keys of the parent. It is used as part of the fill process for building out the entity tree. The method is called as if it were a static method, so it is not associated with any particular entity data. The base implementation dynamically matches keys from the parent to the child and builds the query for the rowset based on that.

generateXSD(): Begins generation of an xml schema, based on the registry using this entity as the root.

getChildEntity(string p_entityID): Retrieves the ChildEntity Object based on the entity ID.

getLOVDescr(string propname): Returns the LOV Description based on the associated property name when parsed from XML.

getMaxSeqNbrSQL(): Retrieves the maximum sequence number from the database based on the key structure of the current entity.

getProperty(string propname)

hardDelete(MessageLogBase p_messageLog out): Performs the actual delete of all objects marked with the entityDelete flag.

hasEffdt(): Checks if this entity has an effective date.

hasEffseq(): Checks if this entity has an effective sequence.

hasKey(string p_keyname): Checks if the current entity has a particular field as a key.

isEqualKeys(IEntity p_entity): Determine Entity Key Equality.

isEqualKeysRecord(Record p_rec): Allows the given record to be compared with this entity for equality. Compares for equality based on the underlying entity record content. RECOMMENDATION: Override this method if you need to do custom equality checking.

prePublish(Rowset p_changesRS out): Uses the workflowPreimage and post images of the entity to build a PSCAMA Rowset in preparation for publish. The parameter Rowset may be Null. Data should be appended to this rowset if it is NON-Null.

preSave(): Perform pre-Save activities on this entity.

preSaveChildren()

PreSaveFirst(): Pre-Save code that only runs on the first entity of a child array.

promote(string emplID, MessageLogBase p_log out): Moves Data from Staging to Production Records (does not validate or save).

publish(Rowset p_changesRS, boolean p_onlineMode): Takes a PSCAMA based rowset of information to be published during workflow Uses that information to construct a Message and according to the onlineMode publishes the Message data in realtime or to the batch delay table.

save(MessageLogBase p_messageLog out): Save this entity and all its children.

setChildren(): Builds out the structure of the ChildEntityArray object based on the registry.

setDefault(): Sets default values for record fields.

setProperty(string propname, any value)

setStageMode(boolean p_stageInd): Changes the Stage_Mode property, as well as any related records. This should not be used once data has been set, to convert data use promote or demote.

setUserContext(string p_userContext): Sets the value of the UserContext property.

toXmlNode(XmlNode parentNode): Converts the data from the entity structure to XML.

updateFromRecord(Record rec): Updates by matching fields in the record to fields in the underlying record on the entity. Values are only set if the value has changed. Values are set using properties, so any additional get-set logic is handled.

updateKeyFields(): Updates the keyfields of all children based on the current entity. This allows key changes to roll down properly.

validate(MessageLogBase p_messageLog out): Validate this entities' contents (and all its children).

validateFirst(MessageLogBase p_messageLog out): Validation code that only runs on the first entity of a child array.

workflow(boolean p_onlineMode): Orchestrates the prepublish and publish methods for this entity and all children.

public Array of string

public Array of ChildEntity

public Record

public boolean

public string

public string

public Array of DataKey

public IEntity

public ChildEntity

public string

public boolean

public boolean

public string

public string

public Array of string

Parameters:

XmlNode xmlnode: The Tools XmlNode object of the parent that should be continued by this entity.

N/A

Parameters:

boolean p_entityDelete: The value to be set for the entityDelete property.

Parameters:

number p_tempID: The tempid to replace the emplid with.

N/A

Parameters:

Record p_inRec(out): This record populates the record underlying this entity.

boolean p_clearState: If the clearstate is true the datapreimage will be populated as well.

Parameters:

boolean p_clearState: Whether or not to RESET this entities pre-image.

Parameters:

XmlNode parentNode: The XML node to pull from.

Return:

Rowset - a rowset populated based on the parent keys, or null if no rows are found.

Return:

string - the XSD as a string.

Parameters:

string p_entityID: The entity ID, based on the registry, of the ChildEntity object to retrieve.

Return:

ChildEntity

Parameters:

string propname: The property name to get a LOV Description based on.

Return:

string

Return:

number - the maximum sequence number found.

Parameters:

string propname

Return:

any

Parameters:

MessageLogBase p_messageLog(out): The MessageLog object to log all errors/warnings to.

Return:

boolean - true if it has an effective date false otherwise.

Return:

boolean - true if it has an effective sequence false otherwise.

Parameters:

string p_keyname: The name of the field to check.

Return:

boolean - true if the field is a key, false if the field is not a key or the entity does not include it.

Parameters:

IEntity p_entity: The entity to compare the current entity to.

Return:

boolean - true if the entity keys are equal false otherwise.

Parameters:

Record p_rec

Return:

boolean

Parameters:

Rowset p_changesRS(out)

N/A

N/A

N/A

Parameters:

string emplID: The emplid for production to replace the tempid from staging.

MessageLogBase p_log(out): The MessageLog object to log all errors/warnings to.

Parameters:

Rowset p_changesRS

boolean p_onlineMode

Parameters:

MessageLogBase p_messageLog(out): The messagelog object to log errors and warnings to.

N/A

N/A

Parameters:

string propname

any value

Parameters:

boolean p_stageInd: The value to set the stage mode to, if the value passed matches the current stage mode no changes are made.

Parameters:

string p_userContext: The value set for the property UserContext.

Parameters:

XmlNode parentNode: The XML parent node to push the xml to.

Parameters:

Record rec: The record object to copy data from.

N/A

Parameters:

MessageLogBase p_messageLog(out): The messagelog object to log errors and warnings to.

Parameters:

MessageLogBase p_messageLog(out): The MessageLog object to log all errors/warnings to.

Parameters:

boolean p_onlineMode

baseProps: A list of properties that are controlled on the base entities, so the property name cannot be changed.

ChildEntityArray: An array of all the ChildEntities of the current entity. The childEntities are determined by the entity registry, and populated when the entity is instansiated.

data: The backing record for this entity.

dataPreimage: The preimage of the backing record for this entity. The entity is compare against the preimage prior to save.

DO_SAVE: Specifies if the entity is allowed to save.

dynamicProperties

entityDelete: Marks this entity for deletion, and prevents save.

entityID: ID of the entity from the registry.

EntityMetaData

entityName: The name of the entity as defined in the registry.

hasAuditRowAddDttm

hasAuditRowAddOprid: A value, set by testForAudit, that speficies if this entity has audit fields. It is used during save time to determine if the audit fields need to be updated.

hasAuditRowUpdDttm

hasAuditRowUpdOprid

ignoreFields: DEPRECATED. ignoreFields is no longer used, if it is found it will be used by EntityPropBuilder during the upgrade to the new property system. The array of names of fields to ignore for the purposes of moving data to/from xml, pushing a new field onto this array will add it to the list.

keyCollection

parent: Parent Entity, null if it is at the top level of tree.

parentCE: The child entity that encompasses all the entities of a particular type under the parent.

prodRecordName: The name of the production record is populated here based on the registry.

PropertyMetaData

RECORD_NAME: The name of the current record underlying this entity.

SCC_ENTITY_INST_ID: A unique identifier for the specific row of data.

SCC_ROW_ADD_DTTM: The Datetime the row of data was added, this is part of the who columns. This property corresponds to this field, if it exists on the record, if not it does nothing.

RECOMMENDATION: Do not override get & set.

SCC_ROW_ADD_OPRID: The Person who added the row of data, this is part of the who columns. This property corresponds to this field, if it exists on the record, if not it does nothing.

RECOMMENDATION: Do not override get & set.

SCC_ROW_UPD_DTTM: The Datetime the row of data was update, this is part of the who columns. This property corresponds to this field, if it exists on the record, if not it does nothing.

RECOMMENDATION: Do not override get & set.

SCC_ROW_UPD_OPRID The Person who updated the row of data, this is part of the who columns. This property corresponds to this field, if it exists on the record, if not it does nothing.

RECOMMENDATION: Do not override get & set.

selfServiceMode: If the entity is in selfServiceMode.

STAGE_MODE: Specifies if this entity is currently in Stage Mode (True) and working with the stage record, or in Production Mode (False) and working with the production record.

UPDATE_RULE: Specifies the update rule to use for the purposes of Data Update Rule.

USER_CONTEXT: The user that this is being run on behalf of, since adds and updates may be done from administrative mode on behalf of a given user, or %UserId.

workflowPreimage: The pre-image object to use for workflow.

XSDCustomNS: The namespace to use for custom attributes in the schema, found and set during generateXSD.

XSDFieldList: A string list of all the fields for the current entity for the XSD. This is used in conjunction with buildXSD to determine if key fields are required, based on if their parent has the same key.

XSDNS: The namespace to use for the schema, found and set during generateXSD.

AbstractEntity(IEntity p_parent): The Constructor.

applyDataKey(string p_queryString)

buildCSVString(array of any p_arrValues, string p_metaTag)

buildPropertyMetaDataCache()

buildXSD(XmlNode xmlnode): 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 will not be marked required on the child.

RECOMMENDATION: Only override if the entity requires a custom schema.

buildXSDChildren(XmlNode xmlnode): Iterates through the ChildEntityArray and issues a buildXSD against each ChildEntity, which in turn creates a temporary entity and calls buildXSD. Base implementation uses the entity registry.

RECOMMENDATION: Do not override.

changeRecord(string p_recname): Changes the record to the record name specified.

RECOMMENDATION: Do not override.

clearDataPreImage(): Clears the Data preimage and workflow preImage.

RECOMMENDATION: Do not override.

clearDataPreImageChildren(): Iterates through the ChildEntityArray and issues a clearDataPreImage against each ChildEntity, which in turn calls clearDataPreImage on all of the entities it contains.

RECOMMENDATION: Do not override.

commonValidate(MessageLogBase p_messageLog out, number p_validateArgs):

Runs the record based validations and outputs results to the log. Also invokes validateChildren. validateChildren is called before record based validations. Validation Arguments<table> <tr><td>%Edit_DateRange</td><td>Reasonable Date Range (Is the date contained within the specified reasonable date range?)</td></tr> <tr><td>%Edit_OneZero</td><td>1/0 (Do all 1/0 fields contain only a 1 or 0?)</td></tr> <tr><td>%Edit_PromptTable</td><td>Prompt Table (Is field data contained in the specified prompt table?)</td></tr> <tr><td>%Edit_Required</td><td>Required Field (Do all required fields contain data? For numeric or signed fields, it checks that they do not contain NULL or 0 values.)</td></tr> <tr><td>%Edit_TranslateTable</td><td>Translate Table (Is field data contained in the specified translate table?)</td></tr> <tr><td>%Edit_YesNo</td><td>Yes/No (Do all yes/no fields only contain only yes or no data?)</td></tr> </table>

defaultChildren(): Iterates through the ChildEntityArray and issues a setDefault against each ChildEntity, which in turn calls setDefault on all of the entities it contains. Base implementation uses the entity registry.

RECOMMENDATION: Do not override.

delete(boolean p_entityDelete): Marks this entity and all its children for deletion at save time - soft delete.

RECOMMENDATION: Do not override this method.

deleteChildren(boolean p_entityDelete): Iterates through the ChildEntityArray and issues a delete against each ChildEntity, which in turn calls delete on all of the entities it contains. Base implementation uses the entity registry.

RECOMMENDATION: Do not override.

demote(number p_tempID): Moves data from production records to staging record.

RECOMMENDATION: This must be implemented, but is only used if the entity is staged. In the implementation make sure to call demoteChildren to cause demote to work with the registry.

demoteChildren(number p_tempID): Iterates through the ChildEntityArray and issues a demote against each ChildEntity, which in turn calls demote on all of the entities it contains. Base implementation uses the entity registry.

RECOMMENDATION: Do not override.

destroy(): Perform cleanup activity on this entity.

entityFieldUpdateNeeded(Rowset p_DataUpdateRule, string p_fieldName, any oldValue)

RECOMMENDATION: Do not override

entityTypeUpdateNeeded(Rowset p_DataUpdateRule, any p_entityType, boolean p_newFlag)

RECOMMENDATION: Do not override.

entityTypeUpdateRequested(Rowset p_DataUpdateRule, any p_entityType)

RECOMMENDATION: Do not override

entityUpdateRequested(Rowset p_DataUpdateRule)

RECOMMENDATION: Do not override.

fill(Record p_inRec out, boolean p_clearState): Populates (fills) this entity from the given record.

RECOMMENDATION: Do not override.

fillChildren(boolean p_clearState): Iterates through the ChildEntityArray and issues a fill against each ChildEntity, which in turn calls fill on all of the entities it contains. Base implementation uses the entity registry.

RECOMMENDATION : Do not override.

fillFromKeys(boolean p_clearState): Performs a select by key based on the fields on the underlying record. This should be run on the top level entity to start a fill.

fillLOVDescrs(): Re-initializes and Populates the LOV Description Hash Map shmLOVDescr based on the current property values.

fromXmlNode(XmlNode parentNode): Retrieves data to properties based on the fields in the record. Fields marked ignore are not Processed. Entity Element Names, wrapping of the ChildEntities or embedding is based on the entity registry.

RECOMMENDATION: Only override if the xml for this entity has to be custom.

fromXmlNodeChildren(XmlNode parentNode): Iterates through the ChildEntityArray and issues a fromXMLNode against each ChildEntity, which in turn calls fromXMLNode on all of the entities it contains. Base implementation uses the entity registry.

RECOMMENDATION: Do not override.

generateRowset(): This method generates a rowset of data for the underlying record of this entity based on the keys of the parent. It is used as part of the fill process for building out the entity tree. The method is called as if it were a static method, so it is not associated with any particular entity data. The base implementation dynamically matches keys from the parent to the child and builds the query for the rowset based on that.

RECOMMENDATION: If the key structure between the parent and child does not match up, or the rowset needs to be built using another method (i.e. a service) override this method.

generateXSD(): Generates the xml schema with this node as the root.

RECOMMENDATION: Do not override.

getChildEntity(string p_entityID): Retrives the ChildEntity Object based on the entity ID.

RECOMMENDATION: Do not override.

getCSUserDefaults(): Retrieves the CSUserDefaults.

RECOMMENDATION: Do not override.

getDataKey(): Retrieves the dataKey for this entity.

RECOMMENDATION: Do not override.

getEntPropsByPropertyName(string propname): Returns the EntityProperty Record (SCC_ENT_PROPS) based on the property name.

getFullEntityPathName()

getIgnoreFields(): A method to get the current ignorefields, used for upgrade.

getInstallationHCM(): Retrieves the HCM Installation Defaults.

RECOMMENDATION: Do not override.

getLOVDescr(string propname): Returns the LOV Description based on the associated property name when parsed from XML.

getLOVValue(Record p_recProp, string p_code)

getMaxSeqNbrSQL(): Retrieves the maximum sequence number from the database based on the keystructure of the current entity. This method is irrelevant if there are no sequence numbers for the entity.

RECOMMENDATION: Override if there is a sequence number and it is not related to all the keys.

getParent(): Retrieves the parent Entity.

RECOMMENDATION: Do not override.

getProperty(string propname)

getPropertyByMetaRec(Record propMetaRec)

getRecordName(): Retrieves the name of the current record on this entity.

RECOMMENDATION: Do not override.

getTagByFieldName(string fieldname): Returns the xml tag based on the field name. If metadata exists that is used, otherwise it returns the field name. This method should no longer be overriden! The xml tag is now based on the property meta data.

hardDelete(MessageLogBase p_messageLog out): Deletes the entity object and all its child entities from the database, based on the entityDelete flag.

RECOMMENDATION: Do not override this method.

hardDeleteChildren(MessageLogBase p_messageLog out): Iterates through the ChildEntityArray and issues a hardDelete against each ChildEntity, which in turn calls hardDelete on all of the entities it contains. Base implementation uses the entity registry.

RECOMMENDATION: Do not override.

hasEffdt()

hasEffseq()

hasKey(string p_keyname): Check if the entity has a particular field as a key.

RECOMMENDATION: Do not override.

isEqualKeys(IEntity p_entity): Allows the given entity to be compared with this entity for equality. The Base implementation compares for equality based on the underlying entity record contents.

RECOMMENDATION: Override this method if you need to do custom equality checking.

isEqualKeysRecord(Record p_rec): Allows the given record to be compared with this entity for equality. Compares for equality based on the underlying entity record content.

RECOMMENDATION: Override this method if you need to do custom equality checking.

populateAudit(): Populates the who column data, this method is invoked prior to save. This allows handling of the who columns to be more or less dynamic. If there are no who columns this method does nothing .

RECOMMENDATION: Do not override.

prePublish(Rowset p_changesRS out): Uses the workflowPreimage and post images of the entity to build a PSCAMA Rowset in preparation for publish. The parameter Rowset may be Null. Data should be appended to this rowset if it is NON-Null.

RECOMMENDATION: Override if pre-publish logic is required.

preSave(): Allows the opportunity for an entity to perform any pre Save activities. The Base implementation does nothing. Presave is automatically called from save, from the top level entity, and runs the presave logic before invoking preSave children.

RECOMMENDATION: Override this method if the entity needs to do last minute preSave processing.

preSaveChildren(): Iterates through the ChildEntityArray and issues a preSave against each ChildEntity, which in turn calls preSave on all of the entities it contains. Base implementation uses the entity registry. Presave is automatically called from save, from the top level entity, and runs the presave logic before invoking preSave children.

RECOMMENDATION: Do not override.

preSaveFirst(): Similar to presave, however, this method is called once per childEntity, prior to any other presave activity to allow for presave activity that may act across all entities in the childEntity. The Base implementation does nothing.

RECOMMENDATION: Override this method if the entity needs to do last minute preSave processing crossing entity boundaries.

promote(string p_emplID, MessageLogBase p_log out): Moves Data from Staging to Production Records (does not validate or save).

RECOMMENDATION: This must be implemented, but is only used if the entity is staged. In the implementation make sure to call promoteChildren to cause promote to work with the registry.

promoteChildren(string p_emplID, MessageLogBase p_log out): Iterates through the ChildEntityArray and issues a promote against each ChildEntity, which in turn calls promote on all of the entities it contains. Base implementation uses the entity registry.

RECOMMENDATION: Do not override.

publish(Rowset p_changesRS, boolean p_onlineMode): Takes a PSCAMA based rowset of information to be published during workflow Uses that information to construct a Message and according to the onlineMode publishes the Message data in realtime or to the batch delay table.

RECOMMENDATION: Override if publish logic is required.

retrieveDataRule(): Uses the entityID and Update Rule Name to read Data Update Rule information.

RECOMMENDATION: Do not override.

save(MessageLogBase p_messageLog out): Base implementation, calls presave and issues save for all children then a save for this entity.

RECOMMENDATION: Do not override.

saveChildren(MessageLogBase p_messageLog out): Iterates through the ChildEntityArray and issues a Save against each ChildEntity, which in turn calls Save on all of the entities it contains. Base implementation uses the entity registry.

RECOMMENDATION: Do not override.

setChildren(): Builds out the ChildEntityArray based on the entity registry.

RECOMMENDATION: Do not override.

setData(Record p_dataRec): Sets the Data record.

RECOMMENDATION: Do not override.

setDataPreImage(Record p_dataPreImageRec): Sets the Data preimage.

RECOMMENDATION: Do not override.

setDefault(): Base implementation sets the default value for each field using the Field setDefault method if the field has not already been marked changed.

RECOMMENDATION: Override if required

setEntityID(string p_entityID): Sets the entity ID, and retrieves the related information from the registry.

RECOMMENDATION: Do not override.

setKeyList(): Sets the list of key fields to private instance variable keyList.

RECOMMENDATION: Do not override.

setProperty(string propname, any value)

setPropertyByMetaRec(Record propMetaRec, any value)

setStageMode(boolean p_stageInd): Sets the stage mode and changes the underlying record to stage/production for this entity and all children. This implementation does nothing since stage mode is not required.

RECOMMENDATION: Override if the entity is Staged.

setUpdateRule(string p_UpdateRule): Sets a specific update rule.

RECOMMENDATION: Do not override.

setUpdateRuleByTransName(string p_transName): Sets the update rule based on the transaction name in the setup table.

RECOMMENDATION: Do not override.

setUserContext(string p_userContext): Sets the user context for this entity.

RECOMMENDATION: Do not override.

testForAudit(): Checks if the underlying record has the audit fields and sets the property hasAudit.

RECOMMENDATION: Do not override.

toXmlNode(XmlNode parentNode): Pushes data to the XML structure from the entity. Fields marked ignore are not Processed. Entity Element Names, wrapping of the ChildEntities or embedding is based on the entity registry. The value of properties corresponding to the fields are pushed.

RECOMMENDATION: Only override if the xml for this entity has to be custom.

toXmlNodeChildren(XmlNode parentNode): Iterates through the ChildEntityArray and issues a toXMLNode against each ChildEntity, which in turn calls toXMLNode on all of the entities it contains. Base implementation uses the entity registry.

RECOMMENDATION: Do not override.

updateChildFields(string propname, array of ChildEntity cea): Sets the value of a specific property on all ChildEntites to match the current entity.

RECOMMENDATION: Do not override.

updateFromRecord(Record rec): Updates by matching fields in the record to fields in the underlying record on the entity. Values are only set if the value has changed. Values are set using properties, so any additional get-set logic is handled.

updateKeyFields(): Updates all the key fields of the child entities that match the key fields on this entity.

RECOMMENDATION: Do not override.

validate(MessageLogBase p_messageLog out): Validates the entity object if entity is not marked for deletion. NOTE: commonValidate invokes validateChildren. validateChildren is called before record based validations.

RECOMMENDATION: Override this method if the entity requires custom validation. Use commonValidate to call the system edits for control over exactly which edits run, or %Super. Validate if you want them all.-- This method does the following standard system edits:- Required fields are present- Validates all 1/0 fields contain only a 1 or a 0- Validates all translate fields have a valid value- Validates all YesNo fields contain a Y or an N- Validates all prompt edit fields have a valid value.

validateChildren(MessageLogBase p_messageLog out): Iterates through the ChildEntityArray and issues a validate against each ChildEntity, which in turn calls validate on all of the entities it contains. Base implementation uses the entity registry.

RECOMMENDATION: Do not override.

validateFirst(MessageLogBase p_messageLog out): Allows validations to be performed on all entities under a childEntity; this is valuable in doing validation against other entities under the same childEntity.

RECOMMENDATION: Override this method if the entity requires custom validation crossing entity boundaries.

workflow(boolean p_onlineMode): Orchestrates the prepublish and publish methods for this entity and all children.

RECOMMENDATION: Do not override.

public Array of string

public Array of ChildEntity

public Record

public Record

public boolean

protected AnyHashMap

public boolean

public string

protected Record

public string

protected boolean

protected boolean

protected boolean

protected boolean

protected Array of string

public Array of DataKey

public IEntity

public ChildEntity

public string

protected Rowset

protected string

public string

public datetime

public string

public datetime

public string

public boolean

public boolean

public string

public string

public Record

protected string

public Array of string

protected string

Parameters:

IEntity p_parent: The parent of this entity, or null if this is the top of the entity tree.

Parameters:

string p_queryString

Return:

string

Parameters:

array of any p_arrValues

string p_metaTag

Return:

string

N/A

Parameters:

XmlNode xmlnode: The Tools XmlNode object of the parent that should be continued by this entity.

Parameters:

XmlNode xmlnode: The node of the current entity that all children will see as the parent.

Parameters:

string p_recname: The name of the record to have this entity use.

N/A

N/A

Parameters:

MessageLogBase p_messageLog(out): The message log to log any errors to.

number p_validateArgs: Specify the validations to be run in a format like (%Edit_DateRange + %Edit_OneZero +Edit_Required).

N/A

Parameters:

boolean p_entityDelete: True to delete this entity and False to "undelete".

Parameters:

boolean p_entityDelete: True to delete this entity and False to "undelete".

Parameters:

number p_tempID: The tempid to replace the emplid with.

Parameters:

number p_tempID: The Tempid to associated with all demoted data.

N/A

Parameters:

Rowset p_DataUpdateRule

string p_fieldName

any oldValue

Return:

boolean

Parameters:

Rowset p_DataUpdateRule

any p_entityType

boolean p_newFlag

Return:

boolean – True if the Data Update Rule specifies the entity type should be updated.

Parameters:

Rowset p_DataUpdateRule: The data update rule.

any p_entityType: The entity type value (for example, For the Address entity, type values include: DORM, HOME, MAIL, and so on.)

Return:

boolean - True if any row of the Data Update Rule Detail (for this entity AND type) has an action not equal to "Do Not Update" (N).

Parameters:

Rowset p_DataUpdateRule: The data update rule.

Return:

boolean - True if any row of the Data Update Rule Detail (for this entity) has an action not equal to "Do Not Update" (N).

Parameters:

Record p_inRec(out): The record structure that will be used to populate this entity.

boolean p_clearState: Whether or not to RESET this entities pre-image.

Parameters:

boolean p_clearState

Parameters:

boolean p_clearState: Whether or not to RESET this entities pre-image.

N/A

Parameters:

XmlNode parentNode: The parent node to add this node to.

Parameters:

XmlNode parentNode: The node of the current entity that all children will see as the parent.

Return:

Rowset - a rowset populated based on the parent keys, or null if no rows are found.

Return:

string - the XML Schema as a string.

Parameters:

string p_entityID: The entity ID, based on the registry, of the ChildEntity object to retrieve.

Return:

ChildEntity

Return:

CSUserDefaults

Return:

DataKey

Parameters:

string propname: The property name.

Return:

Record

Return:

string

Return:

array of string

Return:

InstallationHCM

Parameters:

string propname: The property name to get a LOV Description based on.

Return:

string

Parameters:

Record p_recProp

string p_code

Return:

string

Return:

number - the maximum sequence number found.

Return:

IEntity

Parameters:

string propname

Return:

any

Parameters:

Record propMetaRec

Return:

any

Return:

string - The record name

Parameters:

string fieldname: The fieldname to search on.

Return:

string

Parameters:

MessageLogBase p_messageLog(out): the message log

Parameters:

MessageLogBase p_messageLog(out): the message log

Return:

boolean

Return:

boolean

Parameters:

string p_keyname: The name of the field to check.

Return:

boolean - true, the field exists and is a key, false, the field is not a key, or does not exist.

Parameters:

IEntity p_entity

Return:

boolean

Parameters:

Record p_rec

Return:

boolean

Parameters:

Rowset p_changesRS(out)

N/A

N/A

N/A

Parameters:

string p_emplID

MessageLogBase p_log(out): The MessageLog object to log all errors/warnings to.

Parameters:

string p_emplID: The EMPLID key to associate with the promoted data.

MessageLogBase p_log(out)

Parameters:

Rowset p_changesRS

boolean p_onlineMode

Return:

Rowset - the Data Update Rule information for the current entity in a rowset (Level 0 - SCC_DUR_HDR, Level 1 - SCC_DUR_DTL).

Parameters:

MessageLogBase p_messageLog(out): the message log

MessageLogBase p_messageLog(out): the message log

N/A

Parameters:

Record p_dataRec: The record to set data to.

Parameters:

Record p_dataPreImageRec: The preimage record to set.

N/A

Parameters:

string p_entityID: The ID of the Entity.

N/A

Parameters:

string propname

any value

Parameters:

Record propMetaRec

any value

Parameters:

boolean p_stageInd: Set to stage (true) or production (false).

Parameters:

string p_UpdateRule: The specific update rule.

Parameters:

string p_transName: The transaction name.

Parameters:

string p_userContext: The user context to set. An empty string sets the context to %UserId.

N/A

Parameters:

XmlNode parentNode: The parent node of this node.

Parameters:

XmlNode parentNode: The node of the current entity that all children will see as the parent.

Parameters:

string propname: The name of the property to update.

array of ChildEntity cea: The array of child entities (and their children down the tree) to set the property on.

Parameters:

Record rec: The record object to copy data from.

N/A

Parameters:

MessageLogBase p_messageLog(out): The container for all the messages that will be generated by this method.

Parameters:

MessageLogBase p_messageLog(out): The message log.

Parameters:

MessageLogBase p_messageLog(out): The container for all the messages that will be generated by this method.

Parameters:

boolean p_onlineMode

STAGE_MODE

baseProps, ChildEntityArray, data, dataPreimage, DO_SAVE, dynamicProperties, entityDelete, entityID, EntityMetaData, entityName, 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, UPDATE_RULE, USER_CONTEXT, workflowPreimage, XSDCustomNS, XSDFieldList, XSDNS

BasicEntity(IEntity p_parent): Base Constructor

demote(number p_tempID): This method does nothing since this entity is not staged, but it has to be implemented.

promote(string p_emplID, MessageLogBase p_log out): This method does nothing since this entity is not staged, but it has to be implemented.

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, save, saveChildren, setChildren, setData, setDataPreImage, setDefault, setEntityID, setKeyList, setProperty, setPropertyByMetaRec, setStageMode, setUpdateRule, setUpdateRuleByTransName, setUserContext, testForAudit, toXmlNode, toXmlNodeChildren, updateChildFields, updateFromRecord, updateKeyFields, validate, validateChildren, validateFirst, workflow

public boolean

Parameters:

IEntity p_parent: the parent of this entity, or null if this is the top of the entity tree.

Parameters:

number p_tempID

Parameters:

string p_emplID

MessageLogBase p_log(out)

DO_SAVE_CHILDREN: Specifies if the children should be saved.

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 will not be 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.

entityID: The entity ID based on the entity registry.

entityName: The entity Name as specified in the registry.

PROD_RECORD_NAME: The Production Record name from the registry.

SCC_TEMP_ID: The property for the tempid field on stage records.

STAGE_RECORD_NAME: The Stage Record name from the registry.

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

StagedEntity(IEntity p_parent): The Constructor

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.

demote(number p_tempID): Moves data from production records to staging record.

RECOMMENDATION: Do not override.

getID(): Retrieves the temp ID.

getProdRecordName(): Retrieves the production record name.

getStageRecordName(): Retrieves the stage record name.

promote(string p_emplID, MessageLogBase p_log out): Moves Data from Staging to Production Records (does not validate or save).

RECOMMENDATION: Do not override.

save(MessageLogBase p_messageLog out): Calls presave and issues save for all children then a save for this entity.

RECOMMENDATION: Do not override.

setEntityID(string p_entityID): Sets the entity ID, and retrieves the related information from the registry.

RECOMMENDATION: Do not override.

setID(string p_ID): Sets the temp id for this entity.

RECOMMENDATION: Do not override.

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.

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

public boolean

public string

public string

public string

public string

public number

public string

Parameters:

IEntity p_parent: the parent of this entity, or null if this is the top of the entity tree.

Parameters:

number p_tempID: The tempid to replace the emplid with.

Return:

string - the tempID

Return:

string

Return:

string

Parameters:

string p_emplID

MessageLogBase p_log(out): The MessageLog object to log all errors/warnings to.

Parameters:

MessageLogBase p_messageLog(out): The message log.

Parameters:

string p_entityID: The ID of the Entity.

Parameters:

string p_ID: The temporary ID value to set.

Parameters:

boolean p_stageInd: Set to stage (true) or production (false).

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 will not be 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.

entityID: The entity ID based on the entity registry.

entityName: The entity Name as specified in the registry.

PROD_RECORD_NAME: The Production Record name from the registry.

SCC_TEMP_ID: The property for the tempid field on stage records.

STAGE_RECORD_NAME: The Stage Record name from the registry.

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

StagedHREntity(IEntity p_parent): The Constructor

demote(number p_tempID): Moves data from production records to staging record.

RECOMMENDATION: Do not override.

getHRType(string p_EMPLID): Builds the HCR_PERSON_TYPES object based on the data in the current entity using the emplid provided.

getID(): Retrieves the temp ID.

getServiceManager(): Returns the HCM ServiceManager object.

hardDelete(MessageLogBase p_messageLog out): Deletes the entity object and all its child entities from the database, based on the entityDelete flag.

RECOMMENDATION: Do not override this method

promote(string p_emplID, MessageLogBase p_log out): Moves Data from Staging to Production Records (does not validate or save).

RECOMMENDATION: Do not override.

save(MessageLogBase p_messageLog out): Calls presave and issues save for all children then a save for this entity. On save for production it invokes updateDeleteHcm to call the HCM Web Service.

RECOMMENDATION: Do not override.

setEntityID(string p_entityID): Sets the entity ID, and retrieves the related information from the registry.

RECOMMENDATION: Do not override.

setID(string p_ID): Sets the temp id for this entity.

RECOMMENDATION: Do not override.

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.

updateDeleteHCM(boolean p_deleteFlag): This method is called from save, it should perform the update for production data by calling the HCM service.

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

public string

public string

public string

public string

public number

public string

Parameters:

IEntity p_parent: The parent of this entity, or null if this is the top of the entity tree.

Parameters:

number p_tempID: The tempid to replace the emplid with.

Parameters:

string p_EMPLID: The emplid to use for the PERSON_TYPE.

Return:

baseType

Return:

string - the tempID

Return:

ServiceManager

Parameters:

MessageLogBase p_messageLog(out)the message log

Parameters:

string p_emplID

MessageLogBase p_log(out): The MessageLog object to log all errors/warnings to.

Parameters:

MessageLogBase p_messageLog(out): The message log.

Parameters:

string p_entityID: The ID of the Entity.

Parameters:

string p_ID: The temporary ID value to set.

Parameters:

boolean p_stageInd: Set to stage (true) or production (false).

Parameters:

boolean p_deleteFlag: Specifies if the entity should be deleted.

STAGE_MODE

baseProps, ChildEntityArray, data, dataPreimage, DO_SAVE, dynamicProperties, entityDelete, entityID, EntityMetaData, entityName, 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, UPDATE_RULE, USER_CONTEXT, workflowPreimage, XSDCustomNS, XSDFieldList, XSDNS

WorkEntity(IEntity p_parent): Base Constructor

demote(number p_tempID): This method does nothing since this entity is not staged, but it has to be implemented.

generateRowset()

hardDelete(MessageLogBase p_messageLog out)

promote(string p_emplID, MessageLogBase p_log out): This method does nothing since this entity is not staged, but it has to be implemented.

save(MessageLogBase p_messageLog out)

applyDataKey, buildCSVString, buildPropertyMetaDataCache, buildXSD, buildXSDChildren, changeRecord, clearDataPreImage, clearDataPreImageChildren, commonValidate, defaultChildren, delete, deleteChildren, demoteChildren, destroy, entityFieldUpdateNeeded, entityTypeUpdateNeeded, entityTypeUpdateRequested, entityUpdateRequested, fill, fillChildren, fillFromKeys, fillLOVDescrs, fromXmlNode, fromXmlNodeChildren, generateXSD, getChildEntity, getCSUserDefaults, getDataKey, getEntPropsByPropertyName, getFullEntityPathName, getIgnoreFields, getInstallationHCM, getLOVDescr, getLOVValue, getMaxSeqNbrSQL, getParent, getProperty, getPropertyByMetaRec, getRecordName, getTagByFieldName, hardDeleteChildren, hasEffdt, hasEffseq, hasKey, isEqualKeys, isEqualKeysRecord, populateAudit, prePublish, preSave, preSaveChildren, preSaveFirst, promoteChildren, publish, retrieveDataRule, saveChildren, setChildren, setData, setDataPreImage, setDefault, setEntityID, setKeyList, setProperty, setPropertyByMetaRec, setStageMode, setUpdateRule, setUpdateRuleByTransName, setUserContext, testForAudit, toXmlNode, toXmlNodeChildren, updateChildFields, updateFromRecord, updateKeyFields, validate, validateChildren, validateFirst, workflow

public boolean

Parameters:

IEntity p_parent: The parent of this entity, or null if this is the top of the entity tree.

Parameters:

number p_tempID

Return:

Rowset

Parameters:

MessageLogBase p_messageLog(out)

Parameters:

string p_emplID

MessageLogBase p_log(out)

Parameters:

MessageLogBase p_messageLog(out)

childEntities: An array of all child entities of a specific type.

className: The name of the appclass the entities under this childEntity implement.

elementName: The element name to use for each entity.

Embed: Specifies if the Entities this child contains have been marked for embedding in the parent entity.

Encapsulate: The name of the tag to use to encapsulate all entities in this childEntity object.

EntityID: The Entity ID for the entities under this childEntity.

EntityName: The Entity Name for the entities under this childEntity.

MaxCount: The maximum number of entities of this type allowed based on the registry.

MaxSeqNbr: The current maximum sequence number, if this entity has a key that is a sequence number.

MinCount: The minimum number of entities of this type allowed based on the registry.

parent: The parent of this ChildEntity.

PROD_RECORD: The name of the production record the entities under this childEntity implement.

STAGE_MODE: The current stage state of the entities, true=staged, false=production.

STAGE_RECORD: The name of the stage record the entities under this childEntity implement.

ChildEntity()

buildXSD(XmlNode xmlnode): The method to build the schema for this entity, works in conjunction with the method of the same name on the entity.

checkForDupes(MessageLogBase p_messageLog out): Checks for entities with duplicate keys in the childEntities array.

clearDataPreImage(): Invokes clearDataPreImage on all entities in childEntities.

clearEntities(): Resets the childEntities array to empty.

copyFromRowset(Rowset rs): Copies the record data from a rowset into childEntities. If the keys match it will update an existing entity, otherwise it will add an entity. Data will be copied field by field into the equivalent properties, this means any logic in get-set will be executed. In the case of update only fields where values have changed will be updated. Properties will be copied based on matching the underlying field names.

copyToRowset(): Copies all the records in childEntities to a rowset.

createEntity(): Create an instance of the entity based on the className.

default(): Invokes setDefault on all entities in childEntities.

delete(boolean p_entityDelete): Invokes delete on all entities in childEntities.

demote(number p_tempID): Invokes demote on all entities in childEntities.

destroy(): Perform cleanup activity on this entity.

fill(boolean p_clearstate): Invokes fill on all entities in childEntities.

findKeyMatchingEntity(Record rec): Finds the entity with keys that match the given record.

fromXMLNode(XmlNode parentnode): Invokes fromXMLNode on all entities in childEntities.

getEntitiesByProperties(array of PStruct pstructs): Returns all entities in the childEntities array where the properties provided match.

getEntitiesByProperty(PStruct pstruct): Returns all entities in the childEntities array where the property provided matches.

getEntityByProperties(array of PStruct pstructs): Returns a specific entity in the childEntities array where all properties provided match.

getEntityByPropertiesEffdt(array of PStruct pstructs, date asOfDate): Returns a specific entity in the childEntities array where all properties provided match and the entity is the current entity as of a specific effective date.

getEntityByProperty(PStruct pstruct): Returns a specific entity in the childEntities array where a property matches that requested.

getNextSeqNbr(string fieldname, array of IEntity entities): Provides the next sequence number for a specified fieldname out of a specific array of entities. Setting the array allows the entities to be a subset of childEntities.

getRowset(): Builds an empty rowset of stage or production based on the STAGE_MODE.

hardDelete(MessageLogBase p_messageLog out): Invokes hardDelete on all entities in childEntities.

preSave(): Invokes presaveFirst on the first entity in childEntities and presave on all entities in childEntities.

promote(string p_emplID, MessageLogBase p_messageLog out): Invokes promote on all entities in childEntities.

save(MessageLogBase p_messageLog out): Invokes save on all entities in childEntities.

toXMLNode(XmlNode parentnode): Invokes toXMLNode on all entities in childEntities.

validate(MessageLogBase p_messageLog out): Invokes validate on all entities in childEntities.

workflow(boolean p_onlineMode): Invokes all the workflow methods in childEntities.

public Array of IEntity

public string

public string

public boolean

public string

public string

public string

public string

public number

public string

public IEntity

public string

public boolean

public string

N/A

Parameters:

XmlNode xmlnode: The XmlNode object from the parent to add the schema elements to.

Parameters:

MessageLogBase p_messageLog(out)

N/A

N/A

Parameters:

Rowset rs: The rowset to copy data from.

Return:

Rowset

Return:

IEntity

N/A

Parameters:

boolean p_entityDelete: The delete state passed from the parent to the child.

Parameters:

number p_tempID: The tempID to set on the records when the data is demoted.

N/A

Parameters:

boolean p_clearstate: Specifies if the preImage should be set.

Parameters:

Record rec: The record to use when searching for a match.

Return:

IEntity

Parameters:

XmlNode parentnode: The xml node that entities in this childEntity should be parsed from.

Parameters:

array of PStruct pstructs

Return:

array of IEntity

Parameters:

PStruct pstruct: An object that provides the property name and value to search for.

Return:

array of IEntity

Parameters:

array of PStruct pstructs

Return:

IEntity

Parameters:

array of PStruct pstructs

date asOfDate: The date to check against the effective date.

Return:

IEntity

Parameters:

PStruct pstruct: An object that provides the property name and value to search for.

Return:

IEntity

Parameters:

string fieldname: The field name of the sequence number.

array of IEntity entities: The array of entities to search through to figure out the max sequence number.

Return:

number - the next available sequence number.

Return:

Rowset - the rowset generated.

Parameters:

MessageLogBase p_messageLog(out): The messageLog object passed from the parent to the child to log any errors or warnings.

N/A

Parameters:

string p_emplID: The employee ID to set on the records when the data is promoted.

MessageLogBase p_messageLog(out): The messageLog object passed from the parent to the child to log any errors or warnings.

Parameters:

MessageLogBase p_messageLog(out): The messageLog object passed from the parent to the child to log any errors or warnings.

Parameters:

XmlNode parentnode: The xml node that entities in this childEntity should be added to.

Parameters:

MessageLogBase p_messageLog(out): The messageLog object passed from the parent to the child to log any errors or warnings.

Parameters:

boolean p_onlineMode: The online mode.

createEntity(string entityID, IEntity parent)

Parameters:

string entityID

IEntity parent

Return

IEntity

BaseAppClass: The base appclass, this is populated based on the entity type when the code generate button is pressed.

ClassName: The class name, this will be populated by the entity registry when the code generate button is pressed.

EntityID: The entity id, this will be populated by the entity registry when the code generate button is pressed.

hasProduction: Specifies if this entity has a production record.

hasStage: Specifies if this entity has a stage record.

ignoreFields: Specifies the names of properties implemented on the parent entities that should not be generate on the current entity.

rsProperties: Passes in the rowset of SCC_ENT_PROPS related to the entity.

BuildUI(Rowset rs): Builds the UI of check boxes in the given rowset, SCC_ER_CGEN_VW, this rowset has 2 fields, SCC_ER_CGEN_ARG, the check box to be populated by the user and SCC_ER_CGEN_LBL the label displayed relative to the check box. Using that this code can generate as many yes/no questions as needed for code generation.

GenerateCode(): The process called to generate the code based on the provided properties and UI input.

ParseUI(Rowset rs): Retrieves the data from the UI built in BuildUI, SCC_ER_CGEN_VW, this rowset has 2 fields, SCC_ER_CGEN_ARG, the check box to be populated by the user and SCC_ER_CGEN_LBL the label displayed relative to the check box. This code should retrieve the arguments.

public string

public string

public string

public boolean

public boolean

public Array of string

public Rowset

Parameters:

Rowset rs: The rowset for SCC_ER_CGEN_VW to be populated.

Return:

string - returns the generated code as a string for display.

Parameters:

Rowset rs: The rowset for SCC_ER_CGEN_VW to be parsed.

appclass: The application class for the specified entity, populated pre-sync.

entityID: The entity ID for the specified entity, populated pre-sync.

EntityType: The entity type ID for the specified entity, populated pre-sync.

Log: All property changes should be written to the log, this will be displayed to the user when the sync is done using All Property Sync.

ProdRecord: The production record as specified on the entity, populated pre-sync.

rs: The rowset of current entity properties based on record SCC_ENT_PROPS, populated pre-sync.

StageRecord: The staging record as specified on the entity, populated pre-sync.

LogAsString(): Returns the Log as a string.

save(): The method called to save the updated properties, this is called from the all property sync process, for the entity registry component this is not used.

updateProperties(): The method called to update the properties in the rowset, based on the records.

public string

public string

public string

public MessageLogBase

public string

public Rowset

public string

Return:

string

N/A

N/A

isError

isInformation

isReconcileError

isWarning

messageContext

MessageEntries

MessageLogBase()

append(MessageLogBase p_messageLog)

buildMsgSegment(XmlNode msgsnode)

clear()

generateFaultMsg(string p_operationName)

generateValidationMsg(XmlNode p_node)

getMessageEntry(number p_index): Returns the MessageEntry Object at the given index.

length(): length Current length of the message log.

read(number p_index):

read - Read an entry from the Message Log.

@Return String - The message entry at the given index or blank if index does not exist.

save()

writeEntry(MessageEntry p_entry)

public boolean

public boolean

public boolean

public boolean

public string

protected Array of MessageEntry

N/A

Parameters:

MessageLogBase p_messageLog

Parameters:

XmlNode msgsnode

N/A

Parameters:

string p_operationName

Return:

Message

Parameters:

XmlNode p_node

Parameters:

number p_index

Return:

MessageEntry

Return:

number

Parameters:

number p_index

Return:

string - The message entry at the given index or blank if index does not exist.

N/A

Parameters:

MessageEntry p_entry

Context

MsgID

MsgSet

ParmArray

Properties

Severity

Severity_Error

Severity_Info

Severity_ReconcileError

Severity_Warning

MessageEntry()

AddProperty(string p_UID, string p_Prop)

DataPopulateV1(number p_MsgSet, number p_MsgID, number p_Severity, array of string p_ParmArray, string p_Context, string p_UID, string p_Prop)

Quick population of a messageEntry.

public string

public number

public number

public Array of string

public Array of MEProp

public number

public number

public number

public number

public number

N/A

Parameters:

string p_UID

string p_Prop

Parameters:

number p_MsgSet: The message set of the error.

number p_MsgID: The Message Id, based on the message set for the error.

number p_Severity: The severity of the error should be set using Severity_ReconcileError, Severity_Error, Severity_Warning, Severity_Info.

array of string p_ParmArray: The array of parameters for the message specified, if no parameters are needed null can be passed.

string p_Context: Specify the context of the MessageEntry, if no context is set the MessageLog will default it on writeEntry.

string p_UID: The EntityInstanceId that this messageEntry should be attached to, if multiple EntityInstances are involved use AddProperty to add the additional properties.

string p_Prop: A specific property (use the xml tag) under an instanceid that the messageEntry is related to, if multiple properties are involved use AddProperty after DataEntry to add additional properties.

EntityInstanceId

Property

public string

public string