Package com.microstrategy.web.objects
Interface WebObjectInfo
-
- All Superinterfaces:
KeyedObject
,WebDisplayUnit
,WebFeatures
,WebPromptSite
- All Known Subinterfaces:
WebAttribute
,WebAttributeForm
,WebBlob
,WebChangeJournalSearch
,WebCommandManagerScript
,WebConstantPrompt
,WebConstantPromptAnswer
,WebCustomGroup
,WebDBConnection
,WebDBLogin
,WebDBMS
,WebDBRole
,WebDerivedElement
,WebDevice
,WebDimension
,WebDimtyPrompt
,WebDimtyPromptAnswer
,WebElementsPrompt
,WebElementsPromptAnswer
,WebExpressionPrompt
,WebExpressionPromptAnswer
,WebFilter
,WebFilterBase
,WebFolder
,WebFormat
,WebFunction
,WebIServerSubscriptionDevice
,WebIServerSubscriptionTrigger
,WebLink
,WebLocaleObjectInfo
,WebMDSecurityFilter
,WebMetric
,WebMonitor
,WebObjectsPrompt
,WebObjectsPromptAnswer
,WebPalette
,WebPerformanceMonitor
,WebProject
,WebPrompt
,WebPromptAnswer
,WebPropertySet
,WebReusableThresholds
,WebScheduleEvent
,WebScheduleTrigger
,WebScheduleTriggerEvent
,WebScheduleTriggerTime
,WebScheduleTriggerTimeDaily
,WebScheduleTriggerTimeMonthly
,WebScheduleTriggerTimeWeekly
,WebScheduleTriggerTimeYearly
,WebSearch
,WebSecurityRole
,WebServerDef
,WebShortcut
,WebTable
,WebTableSource
,WebTemplate
,WebTheme
,WebTimePrompt
,WebTransmitter
,WebUser
,WebUserEntity
,WebUserGroup
- All Known Implementing Classes:
WebBlobImpl
,WebChangeJournalSearchImpl
,WebDBMSImpl
,WebDerivedElementsHelper
,WebDossierPersonalViewShortcutImpl
,WebEmailDeviceImpl
,WebEmailTransmitterImpl
,WebFileDeviceImpl
,WebFTPDeviceImpl
,WebMobileDeviceImpl
,WebPrinterDeviceImpl
,WebReportDefinitionImpl
,WebReusableThresholdsImpl
,WebSyncRecommendationFolder
,WebSyncSearchFolder
,WebTransmitterImpl
public interface WebObjectInfo extends WebDisplayUnit, WebFeatures, WebPromptSite
The WebObjectInfo interface represents the fields on any first class object which resides in metadata. All Web Objects classes which represent first class objects implement this interface.Note that most of these objects are read-only, some of these objects are editable and can be saved back to metadata, Some of them are editable but cannot be saved back to metadata. Refer to
WebObjectSource
for more detail information.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
buildShortObjectAttributes(WebXMLBuilder builder)
void
buildShortXML(WebXMLBuilder builder)
java.lang.String
getAbbreviation()
Returns the abbreviation of this object.int
getAccessGranted()
Returns the current access granted on this object, if available.SimpleList
getAncestors()
Returns aSimpleList
containing the ancestors of this object, if they exist in the object XML.int
getCardStatus()
Returns the status of the hyper card.WebCertifiedInfo
getCertifiedInfo()
java.lang.String[]
getComments()
Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.java.lang.String
getContainerDid()
java.lang.String
getContainerType()
java.lang.String
getCreationTime()
Returns the creation time of this object, if that information is available.long
getCreationTimeStamp()
Get the object creation timestamp in millisecond.java.lang.String
getDataSources()
java.lang.String
getDescription()
Returns the description of the object.int
getExtendedType()
The current extended typeWebObjectsFactory
getFactory()
Returns WebObjectsFactoryint
getFlags()
Returns the flags which determine what data to populate upon calling populate.java.lang.String
getIconPath()
Return the icon path for the objectjava.lang.String
getID()
Returns the DSS ID of the object, if one exists.java.lang.String
getModificationTime()
Returns the last modification time of the object, if that information is available.long
getModificationTimeStamp()
Get the object modification timestamp in millisecond.java.lang.String
getName()
Returns the name of this object.boolean
getNonSchedulable()
Get flag of whether the object is not schedulableint
getOtherNameTransCount()
Returns the count of name translations for locales other than the current effective locale.WebObjectInfo
getOwner()
Returns a WebObjectInfo object which corresponds to the owner of this object.WebFolder
getParent()
Returns the parent folder of the current object, if it exists.int
getPreSaveAsFlags()
Returns the flags which determine the previous save as prompt flag.java.lang.String
getProjectId()
java.lang.String
getProjectName()
int
getPropertyFlags()
Retrieve the current property flagsSimpleList
getPropertySetFilter()
Returns an editableSimpleList
where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state.WebPropertyGroup
getPropertySets()
Returns the property sets associated with this object.WebRecommendationInfo
getRecommendationInfo()
This contains all the information related to a recommendation searchWebObjectSecurity
getSecurity()
Returns theWebObjectSecurity
object associated with this WebObjectInfo object.int
getState()
Returns the state of the object.int
getSubType()
Returns the subtype of the object.int
getType()
Returns the type of this object.java.lang.String
getVersionID()
Returns the Version ID of the object, if one exists.WebViewMediaSettings
getViewMediaSettings()
int
getVisualizationViewMode()
java.lang.String
getXML()
Returns the XML representation of this object.java.lang.String
getXML(boolean encode)
Returns the XML representation of this object.boolean
hasOwner()
boolean
isAncestorNamedFolder(int folderName)
Returns whether the named folder is this object's ancestor.boolean
isDirty()
Returns whether this object has been modified to be different from the object in metadata.boolean
isEmbedded()
boolean
isHidden()
Returns whether the object is a hidden object.boolean
isNew()
Returns whether this object is newly created at client side, which is not in the metadata.boolean
isPopulated()
Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.void
populate()
Populates the fields on this object by asking the Intelligence Server for the object definition.void
populate(java.lang.String xml)
Populates the fields on this object by loading the given object definition XML.void
setAbbreviation(java.lang.String abbreviation)
void
setComments(java.lang.String[] comments)
Set the long description of the object as an array of strings.void
setDataSources(java.lang.String dataSourcesXML)
void
setDescription(java.lang.String description)
Sets the description of the object.void
setExtendedType(int extendedType)
Set the current extended typevoid
setFlags(int flags)
Sets the flags which determine what data to populate upon calling populate.void
setHidden(boolean hidden)
Sets whether the object is a hidden object.void
setIconPath(java.lang.String iconPath)
Set the icon path for the objectvoid
setName(java.lang.String _name)
void
setNonSchedulable(boolean nonSchedulable)
Set flag of whether the object is not schedulablevoid
setPreSaveAsFlags(int flags)
Sets the flags which determine the previous save as prompt flag.void
setPropertyFlags(int flags)
Set the current property flags-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected
-
Methods inherited from interface com.microstrategy.web.objects.WebFeatures
isFeatureAvailable, isFeatureAvailable
-
Methods inherited from interface com.microstrategy.web.objects.WebPromptSite
getPromptInstances
-
-
-
-
Method Detail
-
getID
java.lang.String getID()
Returns the DSS ID of the object, if one exists.- Specified by:
getID
in interfaceWebDisplayUnit
- Returns:
- A String representing the ID of the object.
-
getVersionID
java.lang.String getVersionID()
Returns the Version ID of the object, if one exists.- Returns:
- A String representing the ID of the object version.
-
getType
int getType()
Returns the type of this object. This will be a value fromEnumDSSXMLObjectTypes
.- Returns:
- The type of the object.
-
getSubType
int getSubType()
Returns the subtype of the object. This will be a value fromEnumDSSXMLObjectSubTypes
.- Returns:
- The subtype of the object.
-
getName
java.lang.String getName()
Returns the name of this object. the name retrieved with this method is read-only on this interface, comes from the MetaData name of a first-class object. If you wish to change the name displayed to the screen,WebDisplayUnit.setDisplayName(java.lang.String)
should be used along with theWebDisplayUnit.getDisplayName()
call. Please also note that while only first-class objects (i.e. WebObjectInfo) has a "name" property, many object types (WebElements
, andWebDimtyUnit
) can have their respective "names" accessed or changed on the screen viaWebDisplayUnit.getDisplayName()
andWebDisplayUnit.setDisplayName(java.lang.String)
. If you want to change the object's actual metadata name, it can be done via the appropriateWebObjectSource.save(WebObjectInfo, String)
orWebObjectSource.save(WebObjectInfo, String, WebFolder)
calls.- Returns:
- The name of the object.
-
setName
void setName(java.lang.String _name)
- Since:
- MicroStrategy Web 9.0.0
-
getOtherNameTransCount
int getOtherNameTransCount()
Returns the count of name translations for locales other than the current effective locale.- Returns:
- The count of name translations for locales other than the current effective locale.
-
getFactory
WebObjectsFactory getFactory()
Returns WebObjectsFactory- Returns:
- WebObjectsFactory
-
getAbbreviation
java.lang.String getAbbreviation()
Returns the abbreviation of this object.- Returns:
- The object's abbreviation, if one exists.
-
getDescription
java.lang.String getDescription()
Returns the description of the object.- Returns:
- The current description of this object.
-
getCreationTime
java.lang.String getCreationTime()
Returns the creation time of this object, if that information is available.- Returns:
- A string representing the creation time of this object.
-
getCardStatus
int getCardStatus()
Returns the status of the hyper card. This will be a value fromEnumDssXmlHyperCardStatus
.- Returns:
- An int value of the status of the hyper card.
-
getModificationTime
java.lang.String getModificationTime()
Returns the last modification time of the object, if that information is available.- Returns:
- A string representing the last modification time of the object.
-
isHidden
boolean isHidden()
Returns whether the object is a hidden object.- Returns:
- True if the object is a hidden object in metadata, false if it is not.
-
setHidden
void setHidden(boolean hidden)
Sets whether the object is a hidden object. To save the change of this property to metadata,EnumDSSXMLObjectFlags.DssXmlObjectBrowser
flag need to be set onWebObjectSource
before callingWebObjectSource.save(com.microstrategy.web.objects.WebObjectInfo)
with this object as input parameter.- Parameters:
hidden
- boolean true to set this object to hidden.- Since:
- MicroStrategy Web 8.0.0
-
getAccessGranted
int getAccessGranted()
Returns the current access granted on this object, if available. This comes from the bitwise or(|) of values fromEnumDSSXMLAccessRightFlags
.- Returns:
- The numeric representation of the access this user has to the object.
-
getState
int getState()
Returns the state of the object. This value comes fromEnumDSSXMLObjectState
.- Returns:
- The state of this object.
-
getOwner
WebObjectInfo getOwner() throws WebObjectsException
Returns a WebObjectInfo object which corresponds to the owner of this object.- Returns:
- A WebObjectInfo object, representing the owner of this object
- Throws:
WebObjectsException
- Thrown if the owner of this object is not available.
-
hasOwner
boolean hasOwner()
- Returns:
- whether there is an owner object available.
- Since:
- MicroStrategy Web 9.0.0
-
getPropertySets
WebPropertyGroup getPropertySets() throws WebObjectsException
Returns the property sets associated with this object. Note that this will generally only work with a non-embedded (i.e. standalone) object.- Returns:
- A
WebPropertyGroup
object, which contains the property sets associated with this object. - Throws:
WebObjectsException
- Thrown if the property sets could not be retrieved.
-
getPropertySetFilter
SimpleList getPropertySetFilter()
Returns an editableSimpleList
where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state. Also, once the filter is defined and propertySets are retrieved for an instance, there is no way to retrieve a different set of propertySets- Since:
- MicroStrategy Web 8.0.2
-
getFlags
int getFlags()
Returns the flags which determine what data to populate upon calling populate. This value is the bitwise or(|) of values fromEnumDSSXMLObjectFlags
.- Returns:
- The currently set flags value.
- See Also:
setFlags(int)
-
setFlags
void setFlags(int flags)
Sets the flags which determine what data to populate upon calling populate. This value should be the bitwise or(|) of values fromEnumDSSXMLObjectFlags
.- Parameters:
flags
- The flags value to use for object definition retrieval.- See Also:
getFlags()
-
setDescription
void setDescription(java.lang.String description)
Sets the description of the object. The object must be saved by the save or copy methods on the WebObjectSource object to cause a change to this object to be saved.- Parameters:
description
- The description for the object.- Since:
- MicroStrategy Web 7.5.2
-
populate
void populate() throws WebObjectsException
Populates the fields on this object by asking the Intelligence Server for the object definition.- Throws:
WebObjectsException
- Signals an error while trying to populate this object.
-
populate
void populate(java.lang.String xml) throws WebObjectsException
Populates the fields on this object by loading the given object definition XML.- Parameters:
xml
- The XML String to use to populate this object.- Throws:
WebObjectsException
- Thrown if the XML string could not be loaded into this object.
-
getXML
java.lang.String getXML()
Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell.- Returns:
- The XML representation of the current state of this object.
-
getXML
java.lang.String getXML(boolean encode)
Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell. The encoding parameter will tell whether the XML generated should have special characters HTML encoded.- Parameters:
encode
- If this is true, then the returned string will have all special characters HTML-encoded.- Returns:
- The XML representation of the current state of this object.
-
isPopulated
boolean isPopulated()
Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.- Returns:
- The current population status of this object.
-
getAncestors
SimpleList getAncestors() throws java.lang.UnsupportedOperationException
Returns aSimpleList
containing the ancestors of this object, if they exist in the object XML. If they do not exist in object XML, and this is object has a valid DSSID, a request will be sent back to Intelligence Server to retrieve the ancestors information. These objects will be in order from highest ancestor (usually the root folder) to lowest ancestor (the parent folder).- Returns:
- A
SimpleList
containing the ancestors of the object. - Throws:
java.lang.UnsupportedOperationException
- Thrown if the ancestors could not be found or retrieved for the object.
-
getParent
WebFolder getParent() throws java.lang.UnsupportedOperationException
Returns the parent folder of the current object, if it exists. Note that theWebFolder
object returned will not be automatically populated.- Returns:
- The parent folder of the current object. If this is the root folder, then this method will return null.
- Throws:
java.lang.UnsupportedOperationException
- Thrown if the parent could not be found or retrieved for the object.
-
isAncestorNamedFolder
boolean isAncestorNamedFolder(int folderName) throws WebObjectsException, java.lang.UnsupportedOperationException
Returns whether the named folder is this object's ancestor.- Parameters:
folderName
- An Enumeration inEnumDSSXMLFolderNames
- Returns:
- true if the named folder in the ancestor list, false otherwise.
- Throws:
WebObjectsException
- Thrown if an error occurs in obtaining the DSSID for the named folder.java.lang.UnsupportedOperationException
- Thrown if the ancestors could not be found or retrieved for the object.
-
getSecurity
WebObjectSecurity getSecurity()
Returns theWebObjectSecurity
object associated with this WebObjectInfo object. TheWebObjectSecurity
interfaces allows viewing and modification of the ACL of this object, and the ability to take ownership of the object.- Returns:
- The
WebObjectSecurity
object associated with this WebObjectInfo object. - Since:
- MicroStrategy Web 7.5.2
-
isDirty
boolean isDirty()
Returns whether this object has been modified to be different from the object in metadata. Any changes to this object self or the objects it contains will make this flag to be true. For a modified object, after saving it back to metadata will make this flag to be false.- Returns:
- boolean
true
returned when this object has been modified at client side.false
returned when this object is the same as in metadata. - Since:
- MicroStrategy Web 8.0.0
-
isNew
boolean isNew()
Returns whether this object is newly created at client side, which is not in the metadata. For a new object, after saving it back to metadata will turn this flag to false.- Returns:
- boolean
true
returned when this is a newly created object at client side.false
returned when this object is persisted in metadata. - Since:
- MicroStrategy Web 8.0.0
-
getComments
java.lang.String[] getComments()
Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object. These comments can be set programmatically or using MicroStrategy Desktop (Properties editor -> Long description tab) and are separated by a carriage return.- Returns:
- String array of comments
- Since:
- MicroStrategy Web 8.0.1
-
setComments
void setComments(java.lang.String[] comments)
Set the long description of the object as an array of strings. The long description is also known as the comments.- Parameters:
comments
- String array of comments- Since:
- MicroStrategy Web 8.0.1
-
isEmbedded
boolean isEmbedded()
- Since:
- MicroStrategy Web 9.0.0
-
setDataSources
void setDataSources(java.lang.String dataSourcesXML)
- Since:
- MicroStrategy Web 9.0.0
-
getDataSources
java.lang.String getDataSources()
- Since:
- MicroStrategy Web 9.0.0
-
setAbbreviation
void setAbbreviation(java.lang.String abbreviation)
- Since:
- MicroStrategy Web 8.1.0
-
getViewMediaSettings
WebViewMediaSettings getViewMediaSettings()
- Since:
- MicroStrategy Web 9.0.0
-
getIconPath
java.lang.String getIconPath()
Return the icon path for the object- Returns:
String
containing the icon path for the object
-
setIconPath
void setIconPath(java.lang.String iconPath)
Set the icon path for the object- Parameters:
iconPath
-
-
buildShortXML
void buildShortXML(WebXMLBuilder builder)
-
buildShortObjectAttributes
void buildShortObjectAttributes(WebXMLBuilder builder)
-
getVisualizationViewMode
int getVisualizationViewMode()
-
getPropertyFlags
int getPropertyFlags()
Retrieve the current property flags- Returns:
- int binary OR of
EnumDSSXMLPropertyXmlFlags
-
setPropertyFlags
void setPropertyFlags(int flags)
Set the current property flags- Parameters:
flags
- int binary OR ofEnumDSSXMLPropertyXmlFlags
-
setExtendedType
void setExtendedType(int extendedType)
Set the current extended type- Parameters:
a
- value fromEnumDSSXMLExtendedType
-
getExtendedType
int getExtendedType()
The current extended type- Returns:
- the current extended type (a value from
EnumDSSXMLExtendedType
)
-
getContainerType
java.lang.String getContainerType()
-
getContainerDid
java.lang.String getContainerDid()
-
getNonSchedulable
boolean getNonSchedulable()
Get flag of whether the object is not schedulable- Returns:
- whether the object is not schedulable
-
setNonSchedulable
void setNonSchedulable(boolean nonSchedulable)
Set flag of whether the object is not schedulable
-
getModificationTimeStamp
long getModificationTimeStamp()
Get the object modification timestamp in millisecond.
-
getCreationTimeStamp
long getCreationTimeStamp()
Get the object creation timestamp in millisecond.
-
getCertifiedInfo
WebCertifiedInfo getCertifiedInfo()
-
getProjectId
java.lang.String getProjectId()
- Returns:
- project id of the object
-
getProjectName
java.lang.String getProjectName()
- Returns:
- project name of the object
-
getRecommendationInfo
WebRecommendationInfo getRecommendationInfo()
This contains all the information related to a recommendation search- Returns:
- recommendation info
-
getPreSaveAsFlags
int getPreSaveAsFlags()
Returns the flags which determine the previous save as prompt flag. This value is the integer or(|) of values fromEnumDSSXMLDocSaveAsFlags
.- Returns:
- The previous set flags value.
- See Also:
setPreSaveAsFlags(int)
-
setPreSaveAsFlags
void setPreSaveAsFlags(int flags)
Sets the flags which determine the previous save as prompt flag. This value should be the integer or(|) of values fromEnumDSSXMLDocSaveAsFlags
.- Parameters:
flags
- The flags value to use for object definition retrieval.- See Also:
getPreSaveAsFlags()
-
-