com.netegrity.sdk.policyapi
Class SmAgentGroup

java.lang.Object
  com.netegrity.sdk.policyapi.SmObjectImpl
      com.netegrity.sdk.policyapi.SmAgentGroup

All Implemented Interfaces:

SmGroup, SmObject, java.lang.Cloneable

public final class SmAgentGroup
extends SmObjectImpl
implements SmGroup

Represents a SiteMinder Agent group object.

This object has global scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropAgentGroups Property name to be specified in the method getGlobalObjectNames().
static java.lang.String	PropAgents The object's Agent property.
static java.lang.String	PropAgentType The object's Agent Type property (searchable).

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.SmObject

ConfigurationClassName, PropDesc, PropName, PropOid

Constructor Summary

SmAgentGroup()
Constructs an Agent group.

SmAgentGroup(java.lang.String name)
Constructs an Agent group object with the specified name.

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

PropAgentGroups

public static final java.lang.String PropAgentGroups

Property name to be specified in the method getGlobalObjectNames().

See Also:

Constant Field Values

PropAgentType

public static final java.lang.String PropAgentType

The object's Agent Type property (searchable). You can search agent groups based on this property.

See Also:

Constant Field Values

PropAgents

public static final java.lang.String PropAgents

The object's Agent property.

See Also:

Constant Field Values

Constructor Detail

SmAgentGroup

public SmAgentGroup()

Constructs an Agent group. This constructor sets the name and description to an empty string. By default, the Agent type is set to SmAgentType.DefaultAgentType.

SmAgentGroup

public SmAgentGroup(java.lang.String name)

Constructs an Agent group object with the specified name. By default, the Agent type is set to SmAgentType.DefaultAgentType.

Parameters:

name - Name of the Agent group.

Method Detail

getGroupType

public int getGroupType()

Returns the group type of the Agent group. This function returns SmPolicyApi.Agent_Group_Prop.

Specified by:

getGroupType in interface SmGroup

Returns:

One of the following types of groups:

 NULL_Group_Prop = 0
 Rule_Group_Prop = 1
 Response_Group_Prop = 2
 Agent_Group_Prop = 3
 

getAgentType

public SmObjId getAgentType()

Gets the object identifier of the type of Agent group.

Returns:

The object identifier of the type of Agent group.

setAgentType

public void setAgentType(java.lang.Object agentType)

Sets the type of Agent group.

Parameters:

agentType - The object identifier of the type of Agent 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 SmObjectImpl

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 SmObjectImpl

Parameters:

properties - The new properties of the object.