AbstractMESObjectReferenceProperty

Sepasoft MES Module Suite

AbstractMESObjectProperty

This object can be used to obtain reference information about a Material Lot object regarding its location and material definition.

Object Creation

Returned with these functions:

Object Properties

Inherits the AbstractMESObject properties.

Object Functions


 getMESObjectType()

Description

Gets the MES object type that this property is set to.

Syntax

getMESObjectType()

  • Parameters

None

  • Returns

MESObjectTypes type - The MES object type that this property is set to.

  • Scope

All

 getParentMESObjectUUID()

Description

Gets the uuid of the parent object for this property.

Syntax

getParentMESObjectUUID()

  • Parameters

None

  • Returns

String parentMESObjectUUID - The uuid of the parent object.

  • Scope

All

 getReferenceMESObjectName()

Description

Gets the name of the reference object of this property.

Syntax

getReferenceMESObjectName()

  • Parameters

None

  • Returns

String name - Name of the reference object of this property.

  • Scope

All

 getReferenceObject(mesObjectTypeName, mesObjectUUID)

Description

Gets the reference object for this property.

Syntax

getReferenceObject(mesObjectTypeName, mesObjectUUID)

  • Parameters

String mesObjectTypeName - Name of the type of MES object to return reference object for.

String mesObjectUUID - The UUID of MES object to return the reference object for.

  • Returns

AbstractMESObject - The reference object for this property.

  • Scope

All

 

getReferenceOptions(referenceType, searchPattern)

Description

Gets the reference options for this property.

Syntax

getReferenceOptions(referenceType, searchPattern)

  • Parameters

MESObjectTypes referenceType - The reference of MES object type that this property is set to.

String searchPattern - The search pattern to filter the results by. It can contain the * and ? wild card characters. 

  • Returns

List<MESObjectLink> - The reference options for this property.

  • Scope

All

 getRefPropertyPath()

Description

Gets the reference property path for this property.

Syntax

getRefPropertyPath()

  • Parameters

None

  • Returns

String refPropertyPath - The reference property path for this property.

  • Scope

All

 

getVersionRefUUID()

Description

Gets the version reference UUID for this property.

Syntax

getVersionRefUUID()

  • Parameters

None

  • Returns

String versionRefUUID - The version reference uuid for this property.

  • Scope

All

 hasParentMESObjectUUID()

Description

Checks whether there is a parent object uuid associated with this property.

Syntax

hasParentMESObjectUUID()

  • Parameters

None

  • Returns

boolean - True if there exist a parent object uuid and False otherwise.

  • Scope

All

 hasRefPropertyPath()

Description

Checks whether there is a reference property path for this property.

Syntax

hasRefPropertyPath()

  • Parameters

None

  • Returns

boolean - True if there exist a reference property path and False otherwise.

  • Scope

All

 setParentMESObjectUUID(parentMESObjectUUID)

Description

Sets the UUID of the parent object for this property.

Syntax

setParentMESObjectUUID(parentMESObjectUUID)

  • Parameters

String parentMESObjectUUID - Unique identifier that represents the parent object.

  • Returns

Nothing

  • Scope

All

 setRefPropertyPath(refPropertyPath)

Description

Sets the reference property path for this property.

Syntax

setRefPropertyPath(refPropertyPath)

  • Parameters

String refPropertyPath - The reference property path for this property.

  • Returns

Nothing

  • Scope

All


Object Events

Inherits the AbstractMESObject events.

Event Name
Description

CreateLotNumber

This event is run every time a Material Lot object is requested to create a new lot number. This event provides a method to intercept the generation of lot numbers so that the format of the lot number or even the number itself can be modified. For systems that retrieve lot numbers from a ERP or other system, this event will allow obtaining a lot number from it. Script in this event can also read from a block of available lot numbers that are maintained in a database.

EvaluateLotStatus

The event is fired when a Material Lot is being finalized in a segment operation with a quantity and/or status change.

If no script is entered, then the default handler will be executed. To execute the default handler from within the script entered here, add a script line:

event.runDefaultHandler()     

New

The event is fired when a new instance of a Material Lot MES object is created.

If no script is entered, then the default handler will be executed. To execute the default handler from within the script entered here, add a script line:

event.runDefaultHandler()     

Sepasoft MES Module Suite