com.netegrity.sdk.policyapi
Interface SmDomainObject

All Superinterfaces:

java.lang.Cloneable, SmObject

All Known Implementing Classes:

SmDomainObjectImpl, SmPolicy, SmPolicyLink, SmRealm, SmResponse, SmResponseAttr, SmResponseGroup, SmRule, SmRuleGroup, SmUserPolicy, SmVariable

public interface SmDomainObject
extends SmObject

The root interface for domain-based SiteMinder objects.

Since:

SDK 2.0

Field Summary

static java.lang.String

PropDomain The object's Domain object identifier property (searchable).

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

ConfigurationClassName, PropDesc, PropName, PropOid

Method Summary

SmObjId	getDomain() Gets the Object identifier of the Domain object.
java.lang.String	getDomainName() Gets the Domain name of the object Deprecated. The preferred way to get the Domain identifier from Object xx (Realm / Rule/ Response / ResponseAttr / Policy / PolicyLink / UserPolicy) is xx.getDomain()
void	setDomain(java.lang.Object domain) Sets the Object identifier of the Domain object.
void	setDomainName(java.lang.String domainName) Sets the Domain name of the object Deprecated. The preferred way to set the Domain identifier for Object xx (Realm / Rule/ Response / ResponseAttr / Policy / PolicyLink / UserPolicy) is xx.setDomain (domain) or xx.setDomain (domain.getOid())

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

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

Field Detail

PropDomain

static final java.lang.String PropDomain

The object's Domain object identifier property (searchable). You can search for domain objects based on this property.

See Also:

Constant Field Values

Method Detail

setDomain

void setDomain(java.lang.Object domain)

Sets the Object identifier of the Domain object.

Parameters:

domain - The Domain of the object or Object identifier of the Domain object.

getDomain

SmObjId getDomain()

Gets the Object identifier of the Domain object.

Returns:

The Object identifier of the Domain object.

setDomainName

void setDomainName(java.lang.String domainName)

Sets the Domain name of the object

Deprecated. The preferred way to set the Domain identifier for Object xx (Realm / Rule/ Response / ResponseAttr / Policy / PolicyLink / UserPolicy) is xx.setDomain (domain) or xx.setDomain (domain.getOid())

Example:

// First create an empty domain Object.
SmDomain domain = new SmDomain ();
// Get the required domain object.
policyapi.getDomain("RequiredDomainName", domain);
// Now call setDomain of xx = realm / rule/ response / responseAttr / policy / policyLink / userPolicy

xx.setDomain (domain);
or
xx.setDomain (domain.getOid());

Parameters:

domainName - The Domain name of the object.

getDomainName

java.lang.String getDomainName()

Gets the Domain name of the object

Deprecated. The preferred way to get the Domain identifier from Object xx (Realm / Rule/ Response / ResponseAttr / Policy / PolicyLink / UserPolicy) is xx.getDomain()

Example:

String strDomainId = xx.getDomain().toString();

Returns:

The Domain name of the object.