com.netegrity.sdk.policyapi
Class SmRuleGroup

java.lang.Object
  com.netegrity.sdk.policyapi.SmObjectImpl
      com.netegrity.sdk.policyapi.SmDomainObjectImpl
          com.netegrity.sdk.policyapi.SmRuleGroup

All Implemented Interfaces:

SmDomainObject, SmGroup, SmObject, java.lang.Cloneable

public final class SmRuleGroup
extends SmDomainObjectImpl
implements SmGroup

Represents a SiteMinder Rule group.

This object has domain scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropAgentType Constant to indicate the property Agent Type (searchable).
static java.lang.String	PropRules Constant to indicate the property Rules.

Fields inherited from class com.netegrity.sdk.policyapi.SmObjectImpl

PropObjectClassName

Fields inherited from interface com.netegrity.sdk.policyapi.SmGroup

Agent_Group_Prop, NULL_Group_Prop, Response_Group_Prop, Rule_Group_Prop

Fields inherited from interface com.netegrity.sdk.policyapi.SmDomainObject

PropDomain

Fields inherited from interface com.netegrity.sdk.policyapi.SmObject

ConfigurationClassName, PropDesc, PropName, PropOid

Constructor Summary

SmRuleGroup()
Constructs a rule group.

SmRuleGroup(java.lang.String szName)
Constructs a rule group with the specified name.

Method Summary

SmObjId	getAgentType() Gets the object identifier of the agent type for the rule group.
int	getGroupType() Returns the group type for the rule group.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setAgentType(java.lang.Object AgentType) Sets the agent type for the rule group.
void	writeProperties(java.util.Hashtable properties) Copies the object properties to the specified hashtable.

Methods inherited from class com.netegrity.sdk.policyapi.SmDomainObjectImpl

getDomain, getDomainName, isDomainObject, isWriteable, setDomain, setDomainName

Methods inherited from class com.netegrity.sdk.policyapi.SmObjectImpl

getDescription, getName, getObjectClassname, getOid, newObject, setDescription, setName, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.netegrity.sdk.policyapi.SmObject

getDescription, getName, getObjectClassname, getOid, setDescription, setName, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Field Detail

PropAgentType

public static final java.lang.String PropAgentType

Constant to indicate the property Agent Type (searchable). You can search rule group objects based on this property.

See Also:

Constant Field Values

PropRules

public static final java.lang.String PropRules

Constant to indicate the property Rules.

See Also:

Constant Field Values

Constructor Detail

SmRuleGroup

public SmRuleGroup()

Constructs a rule group. This constructor sets the name and description to an empty String. By default, the agent type is set to SmAgentType.DefaultAgentType.

SmRuleGroup

public SmRuleGroup(java.lang.String szName)

Constructs a rule group with the specified name. By default, the agent type is set to SmAgentType.DefaultAgentType.

Parameters:

name - Name of the Rule group.

Method Detail

getGroupType

public int getGroupType()

Returns the group type for the rule group.

Specified by:

getGroupType in interface SmGroup

Returns:

SmPolicyApi.Rule_Group_Prop.

getAgentType

public SmObjId getAgentType()

Gets the object identifier of the agent type for the rule group.

Returns:

The object identifier of the agent type for the rule group.

setAgentType

public void setAgentType(java.lang.Object AgentType)

Sets the agent type for the rule group. The agent type for a rule group must correspond to the agent type of the rules within the rule group.

Parameters:

agentType - The object identifier of the agent type to set for the rule group.

writeProperties

public void writeProperties(java.util.Hashtable properties)

Description copied from interface: SmObject

Copies the object properties to the specified hashtable.

Specified by:

writeProperties in interface SmObject

Overrides:

writeProperties in class SmDomainObjectImpl

Parameters:

properties - The hashtable where the object properties will be copied.

readProperties

public void readProperties(java.util.Hashtable properties)

Description copied from interface: SmObject

Copies the object properties from the specified hashtable.

Specified by:

readProperties in interface SmObject

Overrides:

readProperties in class SmDomainObjectImpl

Parameters:

properties - The new properties of the object.