com.netegrity.sdk.policyapi
Class SmPolicyLink

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

All Implemented Interfaces:

SmDomainObject, SmObject, java.lang.Cloneable

public final class SmPolicyLink
extends SmDomainObjectImpl

Represents a SiteMinder Policy Link object.

This object links the rule and response for a given policy.

Policy Link objects do not have a name or a description.

This object has domain scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropPolicy Constant to indicate the property Policy (searchable).
static java.lang.String	PropResponse Constant to indicate the property Response.
static java.lang.String	PropRule Constant to indicate the property Rule.

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

PropObjectClassName

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

SmPolicyLink()
Constructs a Policy Link object.

SmPolicyLink(java.lang.Object rule, java.lang.Object response, java.lang.Object policy, java.lang.Object domain)
Constructs a Policy Link object for a specified rule, policy, domain, and optionally, response.

Method Summary

java.lang.String	getDescription() Returns null for Policy Link objects.
java.lang.String	getName() Returns null for Policy Link objects.
SmObjId	getPolicy() Gets the object identifier of the policy.
SmObjId	getResponse() Gets the Object identifier of the response.
SmObjId	getRule() Gets the Object identifier of the rule.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setDescription(java.lang.String description) Sets the description of the object to null.
void	setName(java.lang.String name) Sets the name of the object to null.
void	setPolicy(java.lang.Object policy) Set the policy.
void	setResponse(java.lang.Object response) Set the response.
void	setRule(java.lang.Object rule) Sets the rule.
java.lang.String	toString() Returns the name of the rule.
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

getObjectClassname, getOid, newObject, setObjectClassname, setOid, setOid, 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

getObjectClassname, getOid, setObjectClassname, setOid, setOid, writeSearchProperties

Field Detail

PropRule

public static final java.lang.String PropRule

Constant to indicate the property Rule.

See Also:

Constant Field Values

PropPolicy

public static final java.lang.String PropPolicy

Constant to indicate the property Policy (searchable). You can search Policy Link objects based on this property.

See Also:

Constant Field Values

PropResponse

public static final java.lang.String PropResponse

Constant to indicate the property Response.

See Also:

Constant Field Values

Constructor Detail

SmPolicyLink

public SmPolicyLink()

Constructs a Policy Link object. Name and description properties are not set for Policy Link objects.

SmPolicyLink

public SmPolicyLink(java.lang.Object rule,
                    java.lang.Object response,
                    java.lang.Object policy,
                    java.lang.Object domain)

Constructs a Policy Link object for a specified rule, policy, domain, and optionally, response.

Name and description properties are not set for Policy Link objects.

Parameters:

rule - The Object identifier of the rule.

response - The Object identifier of the response. Response is optional in a Policy Link.

policy - The Object identifier of the policy where the rule and response will be linked.

domain - The Object identifier of the domain where the policy can be found.

Method Detail

getName

public java.lang.String getName()

Returns null for Policy Link objects. These objects don't have a name property.

Specified by:

getName in interface SmObject

Overrides:

getName in class SmObjectImpl

Returns:

null.

setName

public void setName(java.lang.String name)

Sets the name of the object to null. Policy Link objects don't have a name property.

Specified by:

setName in interface SmObject

Overrides:

setName in class SmObjectImpl

Parameters:

name - The name of the object.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the object to null. Policy Link objects don't have a description property.

Specified by:

setDescription in interface SmObject

Overrides:

setDescription in class SmObjectImpl

Parameters:

name - The description of the object.

getDescription

public java.lang.String getDescription()

Returns null for Policy Link objects. These objects don't have a name property.

Specified by:

getDescription in interface SmObject

Overrides:

getDescription in class SmObjectImpl

Returns:

null.

toString

public java.lang.String toString()

Returns the name of the rule.

Specified by:

toString in interface SmObject

Overrides:

toString in class SmObjectImpl

Returns:

The name of the rule.

getRule

public SmObjId getRule()

Gets the Object identifier of the rule.

Returns:

The Object identifier of the rule.

setRule

public void setRule(java.lang.Object rule)

Sets the rule.

Parameters:

rule - The Object identifier of the rule.

getResponse

public SmObjId getResponse()

Gets the Object identifier of the response.

Returns:

The Object identifier of the response.

setResponse

public void setResponse(java.lang.Object response)

Set the response.

Parameters:

response - The Object identifier of the response.

getPolicy

public SmObjId getPolicy()

Gets the object identifier of the policy.

Returns:

The Object identifier of the Policy.

setPolicy

public void setPolicy(java.lang.Object policy)

Set the policy.

Parameters:

policy - The Object identifier of the policy.

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.