com.netegrity.sdk.policyapi
Class SmResponseGroup

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

All Implemented Interfaces:

SmDomainObject, SmGroup, SmObject, java.lang.Cloneable

public final class SmResponseGroup
extends SmDomainObjectImpl
implements SmGroup

Represents a SiteMinder Response group object.

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	PropResponses Constant to indicate the property Responses.

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

SmResponseGroup()
Constructs a Response Group object.

SmResponseGroup(java.lang.String szName)
Constructs a Response Group object with the specified name.

Method Summary

SmObjId	getAgentType() Gets the object identifier of the agent type associated with the response group.
int	getGroupType() Returns the group type.
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 associated with the response 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 response group objects based on this property.

See Also:

Constant Field Values

PropResponses

public static final java.lang.String PropResponses

Constant to indicate the property Responses.

See Also:

Constant Field Values

Constructor Detail

SmResponseGroup

public SmResponseGroup()

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

SmResponseGroup

public SmResponseGroup(java.lang.String szName)

Constructs a Response Group object with the specified name. By default, the agent type is set to SmAgentType.DefaultAgentType.

Parameters:

name - Name of the Response group.

Method Detail

getGroupType

public int getGroupType()

Returns the group type.

Specified by:

getGroupType in interface SmGroup

Returns:

With response groups, returns SmPolicyApi.Response_Group_Prop.

getAgentType

public SmObjId getAgentType()

Gets the object identifier of the agent type associated with the response group.

Returns:

The object identifier of the agent type associated with the response group.

setAgentType

public void setAgentType(java.lang.Object agentType)

Sets the type of agent associated with the response group.

Parameters:

agentType - The object identifier of the type of agent associated with the response 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.