public interface

WebFence

com.microstrategy.web.objects.WebFence

Class Overview

This interface represents a web fence for users, includes user fencing and workload fencing.

Summary

Public Methods
abstract String getFenceDesc()
Return the description of current web fence.
abstract String getFenceName()
Return the name of current web fence, actually fence name is unique and can be treated as ID of the fence.
abstract List<WebFenceClusterNode> getFenceNodes()
Retrieves the list of WebFenceClusterNode that is associated with the web fence
abstract int getFencePrecedence()
Return the precedence of current web fence.
abstract List<WebProjectInstance> getFenceProjects()
Retrieves the list of WebProjectInstance that is associated with the web fence
abstract int getFenceType()
Return the type of current web fence, 1 represents this fence is user fence; 2 represents this fence is workload fence.
abstract List<WebUserEntity> getFenceUsers()
Retrieves the list of WebUserEntity that is associated with the web fence, actually should be a list WebUser and/or WebUserGroup
abstract WebFenceClusterNode newClusterNode()
this method will return a new WebFenceClusterNode object.
abstract void setFenceDesc(String fenceDesc)
set the description of the specific web fence.
abstract void setFencePrecedence(int fencePrecedence)
Set the precedence of specific web fence.
abstract void setFenceType(int fenceType)
set the type of the specific web fence.
abstract void setPrecedenceModified(boolean isPrecedenceModified)
this method will tell if the precedence value has been changed or not.

Public Methods

public abstract String getFenceDesc ()

Return the description of current web fence.

public abstract String getFenceName ()

Return the name of current web fence, actually fence name is unique and can be treated as ID of the fence.

public abstract List<WebFenceClusterNode> getFenceNodes ()

Retrieves the list of WebFenceClusterNode that is associated with the web fence

public abstract int getFencePrecedence ()

Return the precedence of current web fence.

public abstract List<WebProjectInstance> getFenceProjects ()

Retrieves the list of WebProjectInstance that is associated with the web fence

public abstract int getFenceType ()

Return the type of current web fence, 1 represents this fence is user fence; 2 represents this fence is workload fence.

public abstract List<WebUserEntity> getFenceUsers ()

Retrieves the list of WebUserEntity that is associated with the web fence, actually should be a list WebUser and/or WebUserGroup

public abstract WebFenceClusterNode newClusterNode ()

this method will return a new WebFenceClusterNode object.

public abstract void setFenceDesc (String fenceDesc)

set the description of the specific web fence.

public abstract void setFencePrecedence (int fencePrecedence)

Set the precedence of specific web fence. The position to put the fence in the fence list, 1-based, if no precedence, or if the given preference is <=1 then it will be added to the end of the list.

public abstract void setFenceType (int fenceType)

set the type of the specific web fence.

public abstract void setPrecedenceModified (boolean isPrecedenceModified)

this method will tell if the precedence value has been changed or not.