Summary: Methods | Inherited Methods | [Expand All]

public interface

WebServerDef

implements WebObjectInfo

com.microstrategy.web.objects.WebServerDef

Class Overview

This interface represents a Server Definition object, which is a type of first-class object. The first class objects of type EnumDSSXMLObjectTypes.DssXmlTypeServerDef will implement this interface when viewed through the Web Objects. This interface contains methods to examine and change the settings of the ServerDef object. In order to save any changes made to this interface, the save or copy methods on WebObjectSource must be called.

Summary

Public Methods
abstract boolean	getApplyOnSave() This method will return the current setting of the apply on save flag.
abstract WebChannels	getChannels() Returns a list of channels which exist on the server.
abstract WebFences	getFences()
abstract WebLDAPSettings	getLDAPSettings() Returns a collection of LDAP-related settings, which can be used to modify the LDAP settings of the server definition object.
abstract WebProjectReferences	getProjectReferences() Returns the project references which are registered with this Server Definition object.
abstract WebServerSettings	getServerSettings() Returns the collection of server settings on the server definition.
abstract WebSimpleSecurityPluginSettings	getSimpleSecurityPluginSettings()
abstract void	setApplyOnSave(boolean applyOnSave) This method will set the apply on save flag to the given value.

[Expand]

Inherited Methods

From interface com.microstrategy.utils.KeyedObject

From interface com.microstrategy.web.objects.WebDisplayUnit

abstract void	addDetails(boolean details) This method will add or remove details from the display unit.
abstract void	applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
abstract boolean	canHighlight()
abstract WebDisplayUnits	getChildUnits() Returns the collection of child display units, or null if the object is not a collection.
abstract String	getDisplayName() Returns the display name associated with this object.
abstract int	getDisplayUnitType() Returns the type of display unit that this object represents.
abstract String	getID() Returns the DSS ID of the display unit.
abstract boolean	hasDetails() Returns whether this display unit currently has details enabled.
abstract void	highlightUnit() Sets this display unit to be highlighted.
abstract void	highlightUnit(boolean details) Sets this display unit to be highlighted.
abstract boolean	isHighlighted() Returns whether this unit is highlighted.
abstract boolean	isObjectInfo() Returns true if underlying Web Object can be cast to `WebObjectInfo`.
abstract boolean	isSelected() Returns whether this display unit is selected.
abstract void	setDisplayName(String displayName) This method will set the value of the display name.
abstract void	setSelected(boolean selected) Sets the current unit's selection status.

From interface com.microstrategy.web.objects.WebFeatures

From interface com.microstrategy.web.objects.WebObjectInfo

abstract void	buildShortObjectAttributes(WebXMLBuilder builder)
abstract void	buildShortXML(WebXMLBuilder builder)
abstract String	getAbbreviation() Returns the abbreviation of this object.
abstract int	getAccessGranted() Returns the current access granted on this object, if available.
abstract SimpleList	getAncestors() Returns a `SimpleList` containing the ancestors of this object, if they exist in the object XML.
abstract String[]	getComments() Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
abstract String	getContainerDid()
abstract String	getContainerType()
abstract String	getCreationTime() Returns the creation time of this object, if that information is available.
abstract String	getDataSources()
abstract String	getDescription() Returns the description of the object.
abstract int	getExtendedType() The current extended type
abstract WebObjectsFactory	getFactory() Returns WebObjectsFactory
abstract int	getFlags() Returns the flags which determine what data to populate upon calling populate.
abstract String	getID() Returns the DSS ID of the object, if one exists.
abstract String	getIconPath() Return the icon path for the object
abstract String	getModificationTime() Returns the last modification time of the object, if that information is available.
abstract long	getModificationTimeStamp()
abstract String	getName() Returns the name of this object.
abstract boolean	getNonSchedulable() Get flag of whether the object is not schedulable
abstract int	getOtherNameTransCount() Returns the count of name translations for locales other than the current effective locale.
abstract WebObjectInfo	getOwner() Returns a WebObjectInfo object which corresponds to the owner of this object.
abstract WebFolder	getParent() Returns the parent folder of the current object, if it exists.
abstract int	getPropertyFlags() Retrieve the current property flags
abstract SimpleList	getPropertySetFilter() Returns an editable `SimpleList` 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.
abstract WebPropertyGroup	getPropertySets() Returns the property sets associated with this object.
abstract WebObjectSecurity	getSecurity() Returns the `WebObjectSecurity` object associated with this WebObjectInfo object.
abstract int	getState() Returns the state of the object.
abstract int	getSubType() Returns the subtype of the object.
abstract int	getType() Returns the type of this object.
abstract String	getVersionID() Returns the Version ID of the object, if one exists.
abstract WebViewMediaSettings	getViewMediaSettings()
abstract int	getVisualizationViewMode()
abstract String	getXML(boolean encode) Returns the XML representation of this object.
abstract String	getXML() Returns the XML representation of this object.
abstract boolean	hasOwner()
abstract boolean	isAncestorNamedFolder(int folderName) Returns whether the named folder is this object's ancestor.
abstract boolean	isDirty() Returns whether this object has been modified to be different from the object in metadata.
abstract boolean	isEmbedded()
abstract boolean	isHidden() Returns whether the object is a hidden object.
abstract boolean	isNew() Returns whether this object is newly created at client side, which is not in the metadata.
abstract boolean	isPopulated() Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
abstract void	populate() Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void	populate(String xml) Populates the fields on this object by loading the given object definition XML.
abstract void	setAbbreviation(String abbreviation)
abstract void	setComments(String[] comments) Set the long description of the object as an array of strings.
abstract void	setDataSources(String dataSourcesXML)
abstract void	setDescription(String description) Sets the description of the object.
abstract void	setExtendedType(int extendedType) Set the current extended type
abstract void	setFlags(int flags) Sets the flags which determine what data to populate upon calling populate.
abstract void	setHidden(boolean hidden) Sets whether the object is a hidden object.
abstract void	setIconPath(String iconPath) Set the icon path for the object
abstract void	setName(String _name)
abstract void	setNonSchedulable(boolean nonSchedulable) Set flag of whether the object is not schedulable
abstract void	setPropertyFlags(int flags) Set the current property flags

From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract boolean getApplyOnSave ()

This method will return the current setting of the apply on save flag. This flag will tell whether, for a ServerDef being used by the Intelligence Server, a direction will be sent to the Intelligence Server to refresh the runtime settings from the ServerDef will be sent when saving the ServerDef. If a ServerDef is obtained from the WebObjectSource.getActiveServerDef call, this will be true by default, otherwise it will be false by default. Note that if this is set on a ServerDef which is not being used by the Intelligence Server, nothing will happen.

Returns

The current value of the apply on save flag.

public abstract WebChannels getChannels ()

Returns a list of channels which exist on the server. This collection of channels can be used to examine or modify the channel settings on the server.

Returns

A WebChannels collection which contains all channels on the server definition.

public abstract WebFences getFences ()

Throws

WebObjectsException

public abstract WebLDAPSettings getLDAPSettings ()

Returns a collection of LDAP-related settings, which can be used to modify the LDAP settings of the server definition object.

Returns

A WebLDAPSettings collection, containing all LDAP settings for the server definition.

public abstract WebProjectReferences getProjectReferences ()

Returns the project references which are registered with this Server Definition object. The return interface from this method can also be used to add, remove, and modify the project references registered with the Server Definition object.

Returns

A WebProjectReferences collection containing the project references registered with the server definition object.

public abstract WebServerSettings getServerSettings ()

Returns the collection of server settings on the server definition. This collection can be used to examine and modify the settings of the server definition object.

Returns

A collection which contains all settings on the server definition.

public abstract WebSimpleSecurityPluginSettings getSimpleSecurityPluginSettings ()

public abstract void setApplyOnSave (boolean applyOnSave)

This method will set the apply on save flag to the given value. This flag will tell whether, for a ServerDef being used by the Intelligence Server, a direction will be sent to the Intelligence Server to refresh the runtime settings from the ServerDef will be sent when saving the ServerDef. Note that if this is set on a ServerDef which is not being used by the Intelligence Server, nothing will happen.

Parameters

applyOnSave	The new setting for the flag.

Interfaces

Classes

Enums

Exceptions

WebServerDef

Class Overview

Summary

Public Methods

public abstract boolean getApplyOnSave ()

Returns

public abstract WebChannels getChannels ()

Returns

public abstract WebFences getFences ()

Throws

public abstract WebLDAPSettings getLDAPSettings ()

Returns

public abstract WebProjectReferences getProjectReferences ()

Returns

public abstract WebServerSettings getServerSettings ()

Returns

public abstract WebSimpleSecurityPluginSettings getSimpleSecurityPluginSettings ()

public abstract void setApplyOnSave (boolean applyOnSave)

Parameters