public interface

WebProjectManipulator

com.microstrategy.web.objects.WebProjectManipulator

Class Overview

The WebProjectManipulator interface represents the behavior of an object that can change properties of a project within a Cluster. An object of this type obtained from a WebClusterMembership object will affect a project on all servers within the membership cluster. And object of this type obtained from a WebClusterMember object will only affect the project for that specific member.

Summary

Public Methods
abstract void applyChanges(WebProjectInstance project)
Applies all changes to the project specified by project.
abstract void setAction(int action)
Sets the action to be applied to the project.
abstract void setMaxWait(int maxWaitSeconds)
Sets the maximum amount of time, in seconds, the API will wait Currently, only supported for Loading project especially when project is offline pending.
abstract void setStatus(int status)
Sets the status to be used when the change is applied

Public Methods

public abstract void applyChanges (WebProjectInstance project)

Applies all changes to the project specified by project.

Parameters
project Project that manipulations will affect
Throws
WebObjectsException

public abstract void setAction (int action)

Sets the action to be applied to the project. Uses the status set in setStatus(int). If the action is DssXmlOpenProject, the status is set directly. If the action is DssXmlIdleProject, the status bits are set. If the action is DssXmlResumeProject, the status bits are reset.

Parameters
action Action to be performed on the project. Value must be from EnumDSSXMLProjectActions.

public abstract void setMaxWait (int maxWaitSeconds)

Sets the maximum amount of time, in seconds, the API will wait Currently, only supported for Loading project especially when project is offline pending. It would wait for project status to change to offline and then load the project. This can be used to provide an upper bound on synchronous execution time. the command will be blocked for given timeout duration until the project status is changed (and thus has performance impact)

Parameters
maxWaitSeconds timeout in seconds

public abstract void setStatus (int status)

Sets the status to be used when the change is applied

Parameters
status Status of the project. Value must be from EnumDSSXMLProjectStatus.