public abstract class WitsmlMessage extends WitsmlObject
The message object is used to provide a central location for informative time stamped information about another well related object. These messages can represent alarms, warnings, events, etc.
Messages can be instantiated in two different ways in JWitsml client programs:
// Get wells from remote server List<WitsmlMessage> messages = witsmlServer.get(WitsmlWell.class, new WitsmlQuery(), wellbore);
// Create instance WitsmlMessage message = witsmlServer.newInstance(WitsmlMessage.class, "my message", wellbore); // Set properties message.setTime(new Date()); message.setActivityCode("drilling"); message.setMd(new Value(1200.8, "m")); message.setType(WitsmlMessage.Type.ALARM); message.setSeverity(WitsmlMessage.Severity.MINOR); : // Add to remote server witsmlServer.add(message);
Modifier and Type | Class and Description |
---|---|
static class |
WitsmlMessage.Probability
Message probability.
|
static class |
WitsmlMessage.Severity
Message severity.
|
static class |
WitsmlMessage.Type
These values represent the type of a message.
|
Modifier and Type | Method and Description |
---|---|
String |
getActivityCode()
Return the activity code of this message.
|
String |
getActivityDetail()
Return the activity detail of this message.
|
Value |
getMd()
Return the MD of this message.
|
Value |
getMdBit()
Return the MD bit of this message.
|
WitsmlMessage.Probability |
getProbability()
Return the probability of this message.
|
WitsmlMessage.Severity |
getSeverity()
Return the severity of this message.
|
String |
getText()
Return the text of this message.
|
Date |
getTime()
Return the time of this message.
|
WitsmlMessage.Type |
getType()
Return the type of this message.
|
void |
setActivityCode(String activityCode)
Set the activity code of this message.
|
void |
setActivityDetail(String activityDetail)
Set the activity detail of this message.
|
void |
setMd(Value md)
Set the MD of this message.
|
void |
setMdBit(Value mdBit)
Set the MD bit of this message.
|
void |
setProbability(WitsmlMessage.Probability probability)
Set the probability of this message.
|
void |
setSeverity(WitsmlMessage.Severity severity)
Set the severity of this message.
|
void |
setText(String text)
Set the text of this message.
|
void |
setTime(Date time)
Set the time of this message.
|
void |
setType(WitsmlMessage.Type type)
Set the type of this message.
|
equals, getAddQuery, getAliases, getCitation, getCommonData, getEtpResource, getEtpServer, getId, getName, getParent, getParentId, getReadLock, getServer, getVersion, getWitsmlServer, getWitsmlType, getWriteLock, hashCode, newAliases, newCitation, newCommonData, setEtpResource, setName, toString
public final Date getTime()
Corresponds to the WITSML property dTim
:
Date and time the information is related to.
public void setTime(Date time)
Corresponds to the WITSML property dTim
:
Date and time the information is related to.
time
- The time to set.
May be null indicating absent or unknown.public final String getActivityCode()
Corresponds to the WITSML property activityCode
:
A code used to define rig activity.
public void setActivityCode(String activityCode)
Corresponds to the WITSML property activityCode
:
A code used to define rig activity.
activityCode
- The activity code to set.
May be null indicating absent or unknown.public final String getActivityDetail()
Corresponds to the WITSML property detailActivity
:
Custom string to further define an activity.
public void setActivityDetail(String activityDetail)
Corresponds to the WITSML property detailActivity
:
Custom string to further define an activity.
activityDetail
- The activity detail to set.
May be null indicating absent or unknown.public final Value getMd()
Corresponds to the WITSML property md
:
Along hole measured depth of measurement from the drill datum.
public void setMd(Value md)
Corresponds to the WITSML property md
:
Along hole measured depth of measurement from the drill datum.
md
- The MD to set.
May be null indicating absent or unknown.public final Value getMdBit()
Corresponds to the WITSML property mdBit
:
Along hole measured depth of measurement from the drill datum.
public void setMdBit(Value mdBit)
Corresponds to the WITSML property mdBit
:
Along hole measured depth of measurement from the drill datum.
mdBit
- The MD bit to set.
May be null indicating absent or unknown.public final WitsmlMessage.Type getType()
Corresponds to the WITSML property typeMessage
:
Message type.
public void setType(WitsmlMessage.Type type)
Corresponds to the WITSML property typeMessage
:
Message type.
type
- The type to set.
May be null indicating absent or unknown.public final String getText()
Corresponds to the WITSML property messageText
:
Message text.
public void setText(String text)
Corresponds to the WITSML property messageText
:
Message text.
text
- The text to set.
May be null indicating absent or unknown.public final WitsmlMessage.Severity getSeverity()
Corresponds to the WITSML property severity
:
Severity of incident.
public void setSeverity(WitsmlMessage.Severity severity)
Corresponds to the WITSML property severity
:
Severity of incident.
severity
- The severity to set.
May be null indicating absent or unknown.public final WitsmlMessage.Probability getProbability()
Corresponds to the WITSML property warnProbability
:
A warning probability (applies to warning).
public void setProbability(WitsmlMessage.Probability probability)
Corresponds to the WITSML property warnProbability
:
A warning probability (applies to warning).
probability
- The probability to set.
May be null indicating absent or unknown.Copyright © 2023 Petroware AS - https://petroware.no