class SCC_COMMON:ENTITY:ChildEntity

Summary and Details:

Summary

Property Summary:

public Array of IEntity	childEntities: An array of all child entities of a specific type.
public string	className: The name of the appclass the entities under this childEntity implement.
public string	elementName: The element name to use for each entity.
public boolean	Embed: Specifies if the Entities this child contains have been marked for embedding in the parent entity.
public string	Encapsulate: The name of the tag to use to encapsulate all entities in this childEntity object.
public string	EntityID: The Entity ID for the entities under this childEntity.
public string	EntityName: The Entity Name for the entities under this childEntity.
public string	MaxCount: The maximum number of entities of this type allowed based on the registry.
public number	MaxSeqNbr: The current maximum sequence number, if this entity has a key that is a sequence number.
public string	MinCount: The minimum number of entities of this type allowed based on the registry.
public IEntity	parent: The parent of this ChildEntity.
public string	PROD_RECORD: The name of the production record the entities under this childEntity implement.
public boolean	STAGE_MODE: The current stage state of the entities, true=staged, false=production.
public string	STAGE_RECORD: The name of the stage record the entities under this childEntity implement.

Constructor Summary:

public void	ChildEntity()

Method Summary:

public void	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.
public void	checkForDupes(MessageLogBase p_messageLog out): Checks for entities with duplicate keys in the childEntities array.
public void	clearDataPreImage(): Invokes clearDataPreImage on all entities in childEntities.
public void	clearEntities(): Resets the childEntities array to empty.
public void	copyFromRowset(Rowset rs): Copies the record data from a rowset into childEntities. If the keys match it, an existing entity is updated. Otherwise, an entity is added. Data is copied field by field into the equivalent properties. This means any logic in get-set is executed. In the case of update-only fields where values have changed, they are updated. Properties are copied based on matching the underlying field names.
public Rowset	copyToRowset(): Copies all the records in childEntities to a rowset.
public IEntity	createEntity(): Create an instance of the entity based on the className.
public void	default(): Invokes setDefault on all entities in childEntities.
public void	delete(boolean p_entityDelete): Invokes delete on all entities in childEntities.
public void	demote(number p_tempID): Invokes demote on all entities in childEntities.
public void	destroy(): Perform cleanup activity on this entity.
public void	fill(boolean p_clearstate): Invokes fill on all entities in childEntities.
public IEntity	findKeyMatchingEntity(Record rec): Finds the entity with keys that match the given record.
public void	fromXMLNode(XmlNode parentnode): Invokes fromXMLNode on all entities in childEntities.
public array of IEntity	getEntitiesByProperties(array of PStruct pstructs): Returns all entities in the childEntities array where the properties provided match.
public array of IEntity	getEntitiesByProperty(PStruct pstruct): Returns all entities in the childEntities array where the property provided matches.
public IEntity	getEntityByProperties(array of PStruct pstructs): Returns a specific entity in the childEntities array where all properties provided match.
public IEntity	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.
public IEntity	getEntityByProperty(PStruct pstruct): Returns a specific entity in the childEntities array where a property matches that requested.
public number	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.
public Rowset	getRowset(): Builds an empty rowset of stage or production based on the STAGE_MODE.
public void	hardDelete(MessageLogBase p_messageLog out): Invokes hardDelete on all entities in childEntities.
public void	preSave(): Invokes presaveFirst on the first entity in childEntities and presave on all entities in childEntities.
public void	promote(string p_emplID, MessageLogBase p_messageLog out): Invokes promote on all entities in childEntities.
public void	save(MessageLogBase p_messageLog out): Invokes save on all entities in childEntities.
public void	toXMLNode(XmlNode parentnode): Invokes toXMLNode on all entities in childEntities.
public void	validate(MessageLogBase p_messageLog out): Invokes validate on all entities in childEntities.
public void	workflow(boolean p_onlineMode): Invokes all the workflow methods in childEntities.

Details

Property Details:

childEntities	public Array of IEntity
className	public string
elementName	public string
Embed	public boolean
Encapsulate	public string
EntityID	public string
EntityName	public string
MaxCount	public string
MaxSeqNbr	public number
MinCount	public string
parent	public IEntity
PROD_RECORD	public string
STAGE_MODE	public boolean
STAGE_RECORD	public string

Constructor Details:

ChildEntity	N/A

Method Details:

buildXSD	Parameters: XmlNode xmlnode: The XmlNode object from the parent to add the schema elements to.
checkForDupes	Parameters: MessageLogBase p_messageLog(out)
clearDataPreImage	N/A
clearEntities	N/A
copyFromRowset	Parameters: Rowset rs: The rowset to copy data from.
copyToRowset	Return: Rowset
createEntity	Return: IEntity
default	N/A
delete	Parameters: boolean p_entityDelete: The delete state passed from the parent to the child.
demote	Parameters: number p_tempID: The tempID to set on the records when the data is demoted.
destroy	N/A
fill	Parameters: boolean p_clearstate: Specifies if the preImage should be set.
findKeyMatchingEntity	Parameters: Record rec: The record to use when searching for a match. Return: IEntity
fromXMLNode	Parameters: XmlNode parentnode: The xml node that entities in this childEntity should be parsed from.
getEntitiesByProperties	Parameters: array of PStruct pstructs Return: array of IEntity
getEntitiesByProperty	Parameters: PStruct pstruct: An object that provides the property name and value to search for. Return: array of IEntity
getEntityByProperties	Parameters: array of PStruct pstructs Return: IEntity
getEntityByPropertiesEffdt	Parameters: array of PStruct pstructs date asOfDate: The date to check against the effective date. Return: IEntity
getEntityByProperty	Parameters: PStruct pstruct: An object that provides the property name and value to search for. Return: IEntity
getNextSeqNbr	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.
getRowset	Return: Rowset - the rowset generated.
hardDelete	Parameters: MessageLogBase p_messageLog(out): The messageLog object passed from the parent to the child to log any errors or warnings.
preSave	N/A
promote	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.
save	Parameters: MessageLogBase p_messageLog(out): The messageLog object passed from the parent to the child to log any errors or warnings.
toXMLNode	Parameters: XmlNode parentnode: The xml node that entities in this childEntity should be added to.
validate	Parameters: MessageLogBase p_messageLog(out): The messageLog object passed from the parent to the child to log any errors or warnings.
workflow	Parameters: boolean p_onlineMode: The online mode.