Message Class


( Information about messages that are displayed in the message window. )

<ASOMessage> Interface

 

Property Overview

TabProperty NameData TypeDescription

General

Severity
(Message_Severity)

<RO>
<Basic><Standard>
MsgSeverity
<TMsgSeverity> Data Type

Enum

Severity level of the message.


ValueNameDescription
kMsgUnidentifiedReservedUsed internally
kMsgInformationInfoOrdinary message
kMsgWarningWarningA message informing of a problem that is not critical to rescheduling, but should be checked in order to create a correct schedule.
kMsgErrorErrorA message informing of a problem which should be checked.

 

Category
(Message_Area)

<RO>
<Standard>
MsgArea
<TMsgArea> Data Type

String

Category of the message.

 

Message ID
(MsgID)

<RO>
<Standard>
MsgID
<LONG> Data Type

Integer

ID number of the message.

 

Message
(MsgString)

<RO>
<Basic><Standard>
MsgString
<BSTR> Data Type

String

Description of the message.

 

Related objects 1
(MsgRelatedObject)

<RO> <Multi>
<Basic><Standard>
MsgRelatedObject
<ASOObject> Data Type

Object

Objects that relate to the message 1.

 

Related objects 2
(MsgRelatedObject2)

<RO> <Multi>
<Basic><Standard>
MsgRelatedObject2
<ASOObject> Data Type

Object

Objects that relate to the message 2.

 

Time
(MsgTime)

<RO>
<Basic><Standard>
MsgTime
<DATE> Data Type

Time

Time at which the message occurred.

Common

Code
(Code)

<Basic><Standard>

String

Name of the object used internally. The code does not need to be unique including objects such as order. In that case, however, other property should be added to the DBIO primary key for a merge process during import and synchronization. Also, in cases where orders are specified by code such as for next orders, behavior is undefined.

 

Display name
(DisplayString)

<Standard>

String

Display name held internally in Asprova. If a value is set here, the display name will be displayed in place of the code. Starting with Ver4, single quotations (') are not allowed.

 

Alias
(DisplayAlias)

<Standard>

String

Specify here an alias of the object. If a value is set here, the alias will be displayed in place of its code or display name.
To display an alias, you need to select User defined aliases from [Workspace] - [General] - [String display method] (The default is set to this value). Starting with Ver4, single quotations (') are not allowed.

 

Comments (common)
(Comment)

<Multi>
<Standard>

String

Enter comments here. This property is common to each class and you can use it for Properties to be copied to operation from order of the Project class and so on.

 

Object ID
(ObjectID)

<RO>
<Standard>

Unsigned integer

ID number defined by each object.

 

Parent
(Parent)

<RO>
<Standard>

Object

The object at one level higher than this object.

 

Children
(Child)

<RO> <Multi>
<Standard>

Object

Objects at one level lower than this object.

 

Class definition
(Object_ClassDef)

<RO>
<Standard>

Object

Object that defines the class information of this object.

 

Internal status flag
(Object_StatusFlag)

<RO>
<Standard>

Enum

Represents the status such as whether the object was added or changed within Asprova.


ValueNameDescription
 NoneThis record has not been changed.
ANewly addedThis record has been newly added.
MModifiedThis record has been modified.
DDeletedThis record has been deleted.

 

Status flag
(Object_StatusFlagExt)

<RO>
<Standard>

Enum

Represents the status such as whether the object was added or changed outside Asprova.


ValueNameDescription
 NoneThis record has not been changed externally.
ANewly addedThis record has been newly added externally.
MModifiedThis record has been modified externally.
DDeletedThis record has been deleted externally.

 

Invalid flag
(Object_InvalidFlag)

<RO>
<Standard>

Bool

Indicates whether the object is invalid or not.

 

Reason to be invalidated
(ReasonToBeInvalidated)

<RO> <Multi>
<Standard>

Enum

Reason why the invalid flag is on.


ValueNameDescription
NNo valid master for order explosionNo valid master exists when orders are exploded.
LBMaster loop (master object)Master object in which a loop was detected.
LNMaster loop (master input instruction)Master input instruction in which a loop was detected.
LIMaster loop (item)Item in which a loop was detected.
FOrder explosion failureOrder explosion failed at last execution.
LIntegrated master loopItem that is detected to have a loop in the integrated master, and it's auto replenishment flag is not No.
GFailed to build groupsGroup hierachy exceeded the maximum limit of 20 levels deep.
GLFound a loop inside groupA loop has been detected inside a group.
D  
RUnneeded result operationRegarded as unneeded during the last order explosion but was not deleted because results data was specified for the operation.

 

Update time
(FlagDate)

<RO>
<Standard>

Time

Updated when import/export/synchronization is executed. Note that this is not the time at which data is changed through the GUI, rescheduling, and so on.

Internal

Serial number
(MsgTimeOrder)

<RO>
<Standard>
MsgTimeOrder
<LONG> Data Type

Integer

The serial number of the message indicating the order of occurrence in the case where multiple messages occurred in the same second.

 

Possible solution
(Message_PossibleSolution)

<RO>
<Basic><Standard>
MsgPossibleSolution
<BSTR> Data Type

String

Explanation of a possible solution, for warning or error messages

All Properties

Related object code 1
(MsgRelatedObjectCode)

<RO> <Multi>

WBSRef

Code of the message related object 1.

 

Related object code 2
(MsgRelatedObject2Code)

<RO> <Multi>

WBSRef

Code of the message related object 2.

 

Code/Display name/Alias
(Object_CodeDisplayNameOrAlias)

String

Corresponds to the code, display name or alias depending on the setting in the property String display method of the workspace.

 

Currently editing user code
(Object_UserDuringChangeCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Currently editing user. Mapped in DBIO's [Field mapping].

 

User with right to edit code
(Object_UserDuringCheckOutCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Reserved right to edit user. Mapped in DBIO's [Field mapping].

 

Owner code
(Object_OwnerUserCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Owner. Mapped in DBIO's [Field mapping].

 
 
MsgRelatedObjectCount
<LONG> Data Type
<RO>

 

Number of elements in MsgRelatedObject property's array.

 
ChildAsMessage
<ASOMessage> Data Type
<RO>

 

Obtains the child object specified as Index.
[in:LONG]Index: Position of the child object.

 
AddChildAsMessage
<ASOMessage> Data Type
<Method>

 

Adds a child object with a newCode name.
[in:BSTR]newCode: Name of the new child object.

 
AddMsg
<ASOMessage> Data Type
<Method>

 

Adds a new message.
[in:TMessageType]MsgType: Specifies the type of the message.
[in:BSTR]MsgStr: Message string.

 
AddMsgWithRelatedObj
<ASOMessage> Data Type
<Method>

 

Adds a new message.
[in:TMessageType]MsgType: Specifies the type of the message.
[in:BSTR]MsgStr: Message string.
[in:ASOObjectList]RelatedObjList: List of objects that relate to the message.

 
MsgLevel
<TMessageType> Data Type
<RO>

 

Obtains the severity level of the message.

 
GetAsObject
<ASOObject> Data Type
<Method>

 

Obtains property value as object.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to obtain.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsObject
<VOID> Data Type
<Method>

 

Sets properties as object.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsInteger
<ASOObject> Data Type
<Method>

 

Obtains properties as integer.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsExpression
<ASOObject> Data Type
<Method>

 

Obtains properties as expression.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsTime
<ASOObject> Data Type
<Method>

 

Obtains properties as time.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsTimeSpan
<ASOObject> Data Type
<Method>

 

Obtains properties as time span.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsDouble
<ASOObject> Data Type
<Method>

 

Obtains properties as float.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsBool
<ASOObject> Data Type
<Method>

 

Obtains properties as boolean.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsEnum
<ASOObject> Data Type
<Method>

 

Obtains properties as enum.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsInteger
<VOID> Data Type
<Method>

 

Sets properties as integer.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsExpression
<VOID> Data Type
<Method>

 

Sets properties as expression.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsTime
<VOID> Data Type
<Method>

 

Sets properties as time.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsTimeSpan
<VOID> Data Type
<Method>

 

Sets properties as time span.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsDouble
<VOID> Data Type
<Method>

 

Sets properties as float.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsBool
<VOID> Data Type
<Method>

 

Sets properties as boolean.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsEnum
<VOID> Data Type
<Method>

 

Sets properties as enum.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
MsgRelatedObject2Count
<LONG> Data Type
<RO>

 

Number of elements in MsgRelatedObject2 property's array.


<RO> : Read-Only
<Multi> : Array Type (Starting From 1)

<Basic> : Displays in basic mode
<Standard> : Displays in standard mode

See Also

Message


HelpNo.:C10

© Since 2019 Asprova Corporation, All rights reserved.