Package com.microstrategy.web.objects
Interface WebParsedObject
-
- All Known Subinterfaces:
WebParsedMetric
,WebParsedModel
public interface WebParsedObject
This interface represents an object resulted from parsing by backend. The main part is a token stream, and it may also contain a symbol folder used for resolving naming ambiguity.- Since:
- MicroStrategy Web 11.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDescription()
Get the description of this object.java.lang.String
getID()
Get the DSS id of the object.WebFolder
getLocalSymbolFolder()
Get the local symbol folder for this token stream.java.lang.String
getName()
Get the name of this object.int
getRejectErrorCode()
Returns the reject error code generated by backend parser for the token stream.java.lang.String
getRejectErrorDescription()
Returns the reject error description generated by backend parser for the token stream.WebFolder
getSearchResultsFolder()
Get the search results folder for this token stream.int
getSubType()
Get the subType of this object.WebTokenStream
getTokenStream()
Get the token stream for this object.int
getType()
Get the type of this object.void
load(int parserOutFlags)
Load the token stream for this object from backend.void
save(int parserOutFlags)
Save the object.void
saveAs(java.lang.String folderID, boolean isOverwrite, int parserOutFlags)
Save the object as a new object.void
setDescription(java.lang.String desc)
Set the description of this object.void
setName(java.lang.String name)
Set the name of this object.void
setNew(boolean isNew)
Set whether it is a new object or saved one.void
setType(int type)
Set the type of this object.void
validate(int parserOutFlags)
Validate the object.
-
-
-
Method Detail
-
getID
java.lang.String getID()
Get the DSS id of the object.- Returns:
- DSS id
-
getDescription
java.lang.String getDescription()
Get the description of this object.- Returns:
- description
-
setDescription
void setDescription(java.lang.String desc)
Set the description of this object.- Parameters:
desc
-
-
getName
java.lang.String getName()
Get the name of this object.- Returns:
- name
-
setName
void setName(java.lang.String name)
Set the name of this object.- Parameters:
name
-
-
getType
int getType()
Get the type of this object.- Returns:
- type of this object in
EnumDSSXMLObjectTypes
-
setType
void setType(int type)
Set the type of this object.- Parameters:
type
- inEnumDSSXMLObjectTypes
-
getSubType
int getSubType()
Get the subType of this object.- Returns:
- subType in
EnumDSSXMLObjectSubTypes
-
setNew
void setNew(boolean isNew)
Set whether it is a new object or saved one.
-
getLocalSymbolFolder
WebFolder getLocalSymbolFolder()
Get the local symbol folder for this token stream.- Returns:
- local symbol folder
-
getSearchResultsFolder
WebFolder getSearchResultsFolder()
Get the search results folder for this token stream.- Returns:
- search results folder
-
getTokenStream
WebTokenStream getTokenStream()
Get the token stream for this object.- Returns:
- token stream
-
getRejectErrorCode
int getRejectErrorCode()
Returns the reject error code generated by backend parser for the token stream.- Returns:
- reject error code
-
getRejectErrorDescription
java.lang.String getRejectErrorDescription()
Returns the reject error description generated by backend parser for the token stream.- Returns:
- reject error description
-
load
void load(int parserOutFlags) throws WebObjectsException
Load the token stream for this object from backend.- Parameters:
parserOutFlags
- values fromEnumDSSXMLParserOutFlags
- Throws:
WebObjectsException
-
validate
void validate(int parserOutFlags) throws WebObjectsException
Validate the object.- Parameters:
parserOutFlags
- values fromEnumDSSXMLParserOutFlags
- Throws:
WebObjectsException
-
save
void save(int parserOutFlags) throws WebObjectsException
Save the object.- Parameters:
parserOutFlags
- values fromEnumDSSXMLParserOutFlags
- Throws:
WebObjectsException
-
saveAs
void saveAs(java.lang.String folderID, boolean isOverwrite, int parserOutFlags) throws WebObjectsException
Save the object as a new object.- Parameters:
folderID
- in which folder the object should be savedisOverwrite
- whether to overwrite the existing objectparserOutFlags
- values fromEnumDSSXMLParserOutFlags
- Throws:
WebObjectsException
-
-