Package com.microstrategy.web.beans
Interface MetadataPromptsSource
-
- All Superinterfaces:
PromptsSource
public interface MetadataPromptsSource extends PromptsSource
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.
- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getMessageID()
Returns a report message ID or a document message ID from which prompts are originated.java.lang.String
getObjectID()
Returns the object ID of a report or a document associated with this source object.int
getObjectSubType()
Returns the subtype of the object from which prompts are originated.int
getObjectType()
Returns the type of the object from which prompts are originated.WebSessionInfo
getSessionInfo()
Returns theWebSessionInfo
object associated with this source.boolean
isReprompted()
Returns a boolean value indicating whether the currentMetadataPromptSource
is in reprompted status.void
setMessageID(java.lang.String messageID)
Sets a report message ID or a document message ID from which prompts are originated.void
setObjectID(java.lang.String objectID)
Sets a report object ID or a document object ID on this source objectvoid
setObjectSubType(int objectSubType)
Sets the subtype of the object from which prompts are originated.void
setObjectType(int objectType)
Sets the type of the object from which prompts are originated.void
setSessionInfo(WebSessionInfo sessionInfo)
Sets aWebSessionInfo
object on this source.-
Methods inherited from interface com.microstrategy.web.beans.PromptsSource
getType, getWebPrompts
-
-
-
-
Method Detail
-
getSessionInfo
WebSessionInfo getSessionInfo()
Returns theWebSessionInfo
object associated with this source.- Returns:
- a
WebSessionInfo
object.
-
setSessionInfo
void setSessionInfo(WebSessionInfo sessionInfo) throws java.lang.UnsupportedOperationException
Sets aWebSessionInfo
object on this source.- Parameters:
sessionInfo
- aWebSessionInfo
object.- Throws:
java.lang.UnsupportedOperationException
- thrown if the object is read-only.
-
getObjectID
java.lang.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.
-
setObjectID
void setObjectID(java.lang.String objectID) throws java.lang.UnsupportedOperationException
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:
java.lang.UnsupportedOperationException
- thrown if the object is read-only.
-
getObjectType
int getObjectType()
Returns the type of the object from which prompts are originated. The possible value is eitherDssXmlTypeReportDefinition
orDssXmlTypeDocumentDefinition
.- Returns:
- the object type, a value from
EnumDSSXMLObjectTypes
.
-
setObjectSubType
void setObjectSubType(int objectSubType) throws java.lang.UnsupportedOperationException
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 toEnumDSSXMLObjectTypes.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 toEnumDSSXMLObjectSubTypes.DssXmlSubTypeReportWritingDocument
- Parameters:
objectSubType
- a value fromEnumDSSXMLObjectSubTypes
.- Throws:
java.lang.UnsupportedOperationException
- thrown if the object is read-only.- Since:
- MicroStrategy Web 8.0.0
-
getObjectSubType
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 isEnumDSSXMLObjectTypes.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 asEnumDSSXMLObjectSubTypes.DssXmlSubTypeReportWritingDocument
- Returns:
- the object subtype, a value from
EnumDSSXMLObjectSubTypes
. - Since:
- MicroStrategy Web 8.0.0
-
setObjectType
void setObjectType(int objectType) throws java.lang.UnsupportedOperationException
Sets the type of the object from which prompts are originated. The possible value is eitherDssXmlTypeReportDefinition
orDssXmlTypeDocumentDefinition
.- Parameters:
objectType
- a value fromEnumDSSXMLObjectTypes
.- Throws:
java.lang.UnsupportedOperationException
- thrown if the object is read-only.
-
getMessageID
java.lang.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
-
setMessageID
void setMessageID(java.lang.String messageID) throws java.lang.UnsupportedOperationException
Sets a report message ID or a document message ID from which prompts are originated.- Parameters:
messageID
- a report or document message ID.- Throws:
java.lang.UnsupportedOperationException
- thrown if the object is read-only.
-
isReprompted
boolean isReprompted()
Returns a boolean value indicating whether the currentMetadataPromptSource
is in reprompted status.- Returns:
true
if the currentMetadataPromptSource
is in reprompted status.- Since:
- MicroStrategy Web 8.0.1
-
-