MetadataPromptsSource
implements PromptsSource| com.microstrategy.web.beans.MetadataPromptsSource |
Class Overview
This interface is used to represent a source of prompts that originates in the Intelligence Server metadata. This includes, most notably, reports and document objects. It manages three key pieces of information:
- Session information: Each prompt source may originate in different Intelligence Server and/or project.
- Object information: The unique ID of the prompt source object and its type.
- Message ID: So that we can uniquely identify the instance of the prompt question on the Intelligence Server.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract String |
getMessageID()
Returns a report message ID or a document message ID from which
prompts are originated.
| ||||||||||
| abstract String |
getObjectID()
Returns the object ID of a report or a document associated with this
source object.
| ||||||||||
| abstract int |
getObjectSubType()
Returns the subtype of the object from which prompts are originated.
| ||||||||||
| abstract int |
getObjectType()
Returns the type of the object from which prompts are originated.
| ||||||||||
| abstract WebSessionInfo |
getSessionInfo()
Returns the
WebSessionInfo object
associated with this source. | ||||||||||
| abstract boolean |
isReprompted()
Returns a boolean value indicating whether the current
MetadataPromptSource
is in reprompted status. | ||||||||||
| abstract void |
setMessageID(String messageID)
Sets a report message ID or a document message ID from which
prompts are originated.
| ||||||||||
| abstract void |
setObjectID(String objectID)
Sets a report object ID or a document object ID on this source object
| ||||||||||
| abstract void |
setObjectSubType(int objectSubType)
Sets the subtype of the object from which prompts are originated.
| ||||||||||
| abstract void |
setObjectType(int objectType)
Sets the type of the object from which prompts are originated.
| ||||||||||
| abstract void |
setSessionInfo(WebSessionInfo sessionInfo)
Sets a
WebSessionInfo object on this source. | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.microstrategy.web.beans.PromptsSource
| |||||||||||
Public Methods
public abstract String getMessageID ()
Returns a report message ID or a document message ID from which prompts are originated.
Returns
- a message ID of a report or a document
public abstract String getObjectID ()
Returns the object ID of a report or a document associated with this source object.
Returns
- a report object ID or a document object ID.
public abstract int getObjectSubType ()
Returns the subtype of the object from which prompts are originated. This property
is relevant only for Report Writer documents.
Thus, if the object type is DssXmlTypeDocumentDefinition
this property can be used to distinguish whether the document type is an ordinary
document or Report Writing Document. In the latter case, the
subtype will be returned as
DssXmlSubTypeReportWritingDocument
Returns
- the object subtype, a value from
EnumDSSXMLObjectSubTypes.
public abstract int getObjectType ()
Returns the type of the object from which prompts are originated. The
possible value is either DssXmlTypeReportDefinition or
DssXmlTypeDocumentDefinition.
Returns
- the object type, a value from
EnumDSSXMLObjectTypes.
public abstract WebSessionInfo getSessionInfo ()
Returns the WebSessionInfo object
associated with this source.
Returns
- a
WebSessionInfoobject.
public abstract boolean isReprompted ()
Returns a boolean value indicating whether the current MetadataPromptSource
is in reprompted status.
Returns
trueif the currentMetadataPromptSourceis in reprompted status.
public abstract void setMessageID (String messageID)
Sets a report message ID or a document message ID from which prompts are originated.
Parameters
| messageID | a report or document message ID. |
|---|
Throws
| UnsupportedOperationException | thrown if the object is read-only. |
|---|
public abstract void setObjectID (String objectID)
Sets a report object ID or a document object ID on this source object
Parameters
| objectID | a report object ID or a document object ID. |
|---|
Throws
| UnsupportedOperationException | thrown if the object is read-only. |
|---|
public abstract void setObjectSubType (int objectSubType)
Sets the subtype of the object from which prompts are originated. This property
needs to be set only for Report Writer documents.
Thus, if the object type is set to DssXmlTypeDocumentDefinition
this property will be used to distinguish whether the document type is an ordinary
document or Report Writing Document. In the latter case, the caller needs to make
sure that subtype is set to
DssXmlSubTypeReportWritingDocument
Parameters
| objectSubType | a value from EnumDSSXMLObjectSubTypes. |
|---|
Throws
| UnsupportedOperationException | thrown if the object is read-only. |
|---|
public abstract void setObjectType (int objectType)
Sets the type of the object from which prompts are originated. The
possible value is either DssXmlTypeReportDefinition or
DssXmlTypeDocumentDefinition.
Parameters
| objectType | a value from EnumDSSXMLObjectTypes. |
|---|
Throws
| UnsupportedOperationException | thrown if the object is read-only. |
|---|
public abstract void setSessionInfo (WebSessionInfo sessionInfo)
Sets a WebSessionInfo object on this source.
Parameters
| sessionInfo | a WebSessionInfo object. |
|---|
Throws
| UnsupportedOperationException | thrown if the object is read-only. |
|---|