Package com.microstrategy.web.objects
Interface WebFence
-
public interface WebFence
This interface represents a web fence for users, includes user fencing and workload fencing.- Since:
- MicroStrategy Web 10.4
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getFenceDesc()
Return the description of current web fence.java.lang.String
getFenceName()
Return the name of current web fence, actually fence name is unique and can be treated as ID of the fence.java.util.List<WebFenceClusterNode>
getFenceNodes()
Retrieves the list ofWebFenceClusterNode
that is associated with the web fenceint
getFencePrecedence()
Return the precedence of current web fence.java.util.List<WebProjectInstance>
getFenceProjects()
Retrieves the list ofWebProjectInstance
that is associated with the web fenceint
getFenceType()
Return the type of current web fence, 1 represents this fence is user fence; 2 represents this fence is workload fence.java.util.List<WebUserEntity>
getFenceUsers()
Retrieves the list ofWebUserEntity
that is associated with the web fence, actually should be a listWebUser
and/orWebUserGroup
WebFenceClusterNode
newClusterNode()
this method will return a newWebFenceClusterNode
object.void
setFenceDesc(java.lang.String fenceDesc)
set the description of the specific web fence.void
setFencePrecedence(int fencePrecedence)
Set the precedence of specific web fence.void
setFenceType(int fenceType)
set the type of the specific web fence.void
setPrecedenceModified(boolean isPrecedenceModified)
this method will tell if the precedence value has been changed or not.
-
-
-
Method Detail
-
getFenceName
java.lang.String getFenceName()
Return the name of current web fence, actually fence name is unique and can be treated as ID of the fence.
-
getFenceDesc
java.lang.String getFenceDesc()
Return the description of current web fence.
-
setFenceDesc
void setFenceDesc(java.lang.String fenceDesc)
set the description of the specific web fence.
-
getFenceType
int getFenceType()
Return the type of current web fence, 1 represents this fence is user fence; 2 represents this fence is workload fence.
-
setFenceType
void setFenceType(int fenceType)
set the type of the specific web fence.
-
getFenceUsers
java.util.List<WebUserEntity> getFenceUsers()
Retrieves the list ofWebUserEntity
that is associated with the web fence, actually should be a listWebUser
and/orWebUserGroup
-
getFenceProjects
java.util.List<WebProjectInstance> getFenceProjects()
Retrieves the list ofWebProjectInstance
that is associated with the web fence
-
getFenceNodes
java.util.List<WebFenceClusterNode> getFenceNodes()
Retrieves the list ofWebFenceClusterNode
that is associated with the web fence
-
getFencePrecedence
int getFencePrecedence()
Return the precedence of current web fence.
-
setFencePrecedence
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.
-
newClusterNode
WebFenceClusterNode newClusterNode()
this method will return a newWebFenceClusterNode
object.
-
setPrecedenceModified
void setPrecedenceModified(boolean isPrecedenceModified)
this method will tell if the precedence value has been changed or not.
-
-