public class

MWSHistoryInfo

extends Object
java.lang.Object
   ↳ com.microstrategy.webservices.MWSHistoryInfo

Class Overview

Contains history information that is sent (as an array) from the web service to the client when the client wants to know the contents of a specific user's inbox. This inbox contains links to executed requests (ie. reports/documents) that have been scheduled or run. Access to the results via message id allows the user to execute once and view the results multiple times. The web service accesses this information using WebInboxSource and WebMessage objects. This class was auto-generated from WSDL by the Apache Axis WSDL2Java emitter.

Summary

Public Constructors
MWSHistoryInfo()
MWSHistoryInfo(String objName, String objID, String objDescription, EnumMWSHistoryRequestStatus status, String folderName, String messageText, String startTime, String finishTime, String lastUpdateTime, String msgID, EnumMWSObjectType objType, EnumMWSObjSubType objSubType, MWSObjectInfo objectInfo, EnumMWSHistoryMessageStatus messageStatus)
Public Methods
String getFinishTime()
Get the history object's finish time.
String getFolderName()
Get the name of the folder associated with this history object.
String getLastUpdateTime()
Get the history object's last update time.
EnumMWSHistoryMessageStatus getMessageStatus()
Get the history object's message status which describes the current state of the associated inbox message.
String getMessageText()
Get the history object's associated message.
String getMsgID()
Get the history object's message ID.
String getObjDescription()
Get the history object's description.
String getObjID()
Get the history object's object ID.
String getObjName()
Get the history object's name.
MWSObjectInfo getObjectInfo()
Gets the objectInfo value for this MWSHistoryInfo.
String getStartTime()
Get the history object's start time.
EnumMWSHistoryRequestStatus getStatus()
Get the history object's request status which describes the current state of the associated inbox's request execution.
void setFinishTime(String finishTime)
Set the history object's finish time.
void setFolderName(String folderName)
Set the history object's folder name.
void setLastUpdateTime(String lastUpdateTime)
Set the history object's last update time.
void setMessageStatus(EnumMWSHistoryMessageStatus messageStatus)
Set the history object's message status.
void setMessageText(String messageText)
Set the history object's associated message.
void setMsgID(String msgID)
Set the history object's message ID.
void setObjDescription(String objDescription)
Set the history object's description.
void setObjID(String objID)
Set the history object's ID.
void setObjName(String objName)
Set the history object's name.
void setObjectInfo(MWSObjectInfo objectInfo)
Sets the objectInfo value for this MWSHistoryInfo.
void setStartTime(String startTime)
Set the history object's start time.
void setStatus(EnumMWSHistoryRequestStatus status)
Set the history object's request status.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MWSHistoryInfo ()

public MWSHistoryInfo (String objName, String objID, String objDescription, EnumMWSHistoryRequestStatus status, String folderName, String messageText, String startTime, String finishTime, String lastUpdateTime, String msgID, EnumMWSObjectType objType, EnumMWSObjSubType objSubType, MWSObjectInfo objectInfo, EnumMWSHistoryMessageStatus messageStatus)

Public Methods

public String getFinishTime ()

Get the history object's finish time. This is the time that the associated request execution finished.

Returns
  • Finish time text.

public String getFolderName ()

Get the name of the folder associated with this history object.

Returns
  • Folder name.

public String getLastUpdateTime ()

Get the history object's last update time. This is the last time that associated inbox source message was modified.

Returns
  • Modification time text.

public EnumMWSHistoryMessageStatus getMessageStatus ()

Get the history object's message status which describes the current state of the associated inbox message.

Returns
  • History request status.

public String getMessageText ()

Get the history object's associated message. Typically this contains the error message for reports/documents that have errors in execution.

Returns
  • Message text.

public String getMsgID ()

Get the history object's message ID. Returns the ID (GUID) of a associated message in the inbox.

Returns
  • GUID

public String getObjDescription ()

Get the history object's description.

Returns
  • Object description.

public String getObjID ()

Get the history object's object ID.

Returns
  • Object ID.

public String getObjName ()

Get the history object's name.

Returns
  • Object name.

public MWSObjectInfo getObjectInfo ()

Gets the objectInfo value for this MWSHistoryInfo.

Returns
  • objectInfo

public String getStartTime ()

Get the history object's start time. This is the time that the associated request execution was started, or will be started (for scheduled requests).

Returns
  • Start time text.

public EnumMWSHistoryRequestStatus getStatus ()

Get the history object's request status which describes the current state of the associated inbox's request execution.

Returns
  • History request status.

public void setFinishTime (String finishTime)

Set the history object's finish time. BrowserGetHistory does this using the associated inbox source message's finish time.

Parameters
finishTime Finish time text.

public void setFolderName (String folderName)

Set the history object's folder name. BrowserGetHistory does this using the name of the folder which contains the associated inbox source message's object.

Parameters
folderName Folder name.

public void setLastUpdateTime (String lastUpdateTime)

Set the history object's last update time. BrowserGetHistory does this using the associated inbox source message's modification time.

Parameters
lastUpdateTime Modification time text.

public void setMessageStatus (EnumMWSHistoryMessageStatus messageStatus)

Set the history object's message status. BrowserGetHistory does this using the associated inbox source message's object message status.

Parameters
messageStatus History request status.

public void setMessageText (String messageText)

Set the history object's associated message. BrowserGetHistory does this using the associated inbox source message's message text.

Parameters
messageText Message text.

public void setMsgID (String msgID)

Set the history object's message ID. BrowserGetHistory does this using the associated inbox source message's GUID.

Parameters
msgID GUID

public void setObjDescription (String objDescription)

Set the history object's description. BrowserGetHistory does this using the associated inbox source message's object description.

Parameters
objDescription Object description.

public void setObjID (String objID)

Set the history object's ID. BrowserGetHistory does this using the associated inbox source message's object ID.

public void setObjName (String objName)

Set the history object's name. BrowserGetHistory does this using the associated inbox source message's display name.

Parameters
objName Object name.

public void setObjectInfo (MWSObjectInfo objectInfo)

Sets the objectInfo value for this MWSHistoryInfo.

public void setStartTime (String startTime)

Set the history object's start time. BrowserGetHistory does this using the associated inbox source message's start time.

Parameters
startTime Start time text.

public void setStatus (EnumMWSHistoryRequestStatus status)

Set the history object's request status. BrowserGetHistory does this using the associated inbox source message's object request status.

Parameters
status History request status.