com.netegrity.sdk.policyapi
Interface SmObject

All Superinterfaces:

java.lang.Cloneable

All Known Subinterfaces:

SmDomainObject

All Known Implementing Classes:

SmAdmin, SmAgent, SmAgentConfig, SmAgentGroup, SmAgentType, SmAgentTypeAttr, SmAuthAzMap, SmAuthValidateMap, SmCertMap, SmDomain, SmDomainObjectImpl, SmExport, SmHostConfig, SmImport, SmIMSEnvironment, SmKeyManagement, SmMigrationBase, SmObjectImpl, SmODBCQuery, SmPasswordPolicy, SmPolicy, SmPolicyLink, SmPwdPolicyRegularExpression, SmRealm, SmResponse, SmResponseAttr, SmResponseGroup, SmRootConfig, SmRule, SmRuleGroup, SmScheme, SmSelfReg, SmSharedSecretPolicy, SmTrustedHost, SmUserDirectory, SmUserPolicy, SmVariable, SmVariableType

public interface SmObject
extends java.lang.Cloneable

SmObject is the root of the Policy API interfaces.

Since:

SDK 2.0

Field Summary

static java.lang.String	ConfigurationClassName Property name to be specified in the method GetGlobalObjectNames().
static java.lang.String	PropDesc Constant to indicate the object's Description property.
static java.lang.String	PropName Constant to indicate the object's Name property (searchable).
static java.lang.String	PropOid Constant to indicate the object's Object Identifier property (searchable).

Method Summary

java.lang.String	getDescription() Gets the description of the object.
java.lang.String	getName() Gets the name of the object.
java.lang.String	getObjectClassname() Gets the Policy API object class name.
SmObjId	getOid() Gets the object identifier.
boolean	isDomainObject() Specifies whether the current object is a domain object.
boolean	isWriteable() Specifies whether the current object is writable.
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.
void	setName(java.lang.String name) Sets the name of the object.
void	setObjectClassname(java.lang.String className) Sets the Policy API object class name.
void	setOid(java.lang.Object oid) Sets the object identifier for the Object object.
void	setOid(SmObjId oid) Sets the object identifier for the SmObjId object.
java.lang.String	toString() Returns the name of the current object.
void	writeProperties(java.util.Hashtable properties) Copies the object properties to the specified hashtable.
void	writeSearchProperties(java.util.Hashtable properties, java.lang.String[] searchProps) Copies the properties of the object specified in searchProps to the properties hashtable.

Field Detail

PropName

static final java.lang.String PropName

Constant to indicate the object's Name property (searchable). You can search objects based on this property.

See Also:

Constant Field Values

PropOid

static final java.lang.String PropOid

Constant to indicate the object's Object Identifier property (searchable). You can search objects based on this property.

See Also:

Constant Field Values

PropDesc

static final java.lang.String PropDesc

Constant to indicate the object's Description property.

See Also:

Constant Field Values

ConfigurationClassName

static final java.lang.String ConfigurationClassName

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

See Also:

Constant Field Values

Method Detail

getObjectClassname

java.lang.String getObjectClassname()

Gets the Policy API object class name. For example, when called on the SmDomain object, it would return Domain.

Returns:

The policy API object class name.

setObjectClassname

void setObjectClassname(java.lang.String className)

Sets the Policy API object class name.

Parameters:

className - Policy API object class name.

getOid

SmObjId getOid()

Gets the object identifier.

To put the object identifier in string form, use getOidString().

Returns:

The object identifier.

setOid

void setOid(SmObjId oid)

Sets the object identifier for the SmObjId object. Use this method to copy one object ID to another object.

Parameters:

oid - The object identifier.

setOid

void setOid(java.lang.Object oid)

Sets the object identifier for the Object object. This ID is the object's unique object identifier.

Parameters:

oid - The object identifier.

getName

java.lang.String getName()

Gets the name of the object.

Returns:

The name of the object.

setName

void setName(java.lang.String name)

Sets the name of the object.

Parameters:

name - The name of the object.

getDescription

java.lang.String getDescription()

Gets the description of the object.

Returns:

The description of the object.

setDescription

void setDescription(java.lang.String description)

Sets the description of the object.

Parameters:

description - The description of the object.

isWriteable

boolean isWriteable()

Specifies whether the current object is writable.

Returns:

true if the object is writable.

readProperties

void readProperties(java.util.Hashtable properties)

Copies the object properties from the specified hashtable.

Parameters:

properties - The new properties of the object.

writeProperties

void writeProperties(java.util.Hashtable properties)

Copies the object properties to the specified hashtable.

Parameters:

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

isDomainObject

boolean isDomainObject()

Specifies whether the current object is a domain object.

Returns:

true if the object is a domain object.

toString

java.lang.String toString()

Returns the name of the current object.

Overrides:

toString in class java.lang.Object

Returns:

The name of the object.

writeSearchProperties

void writeSearchProperties(java.util.Hashtable properties,
                           java.lang.String[] searchProps)

Copies the properties of the object specified in searchProps to the properties hashtable.

Parameters:

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

searchProps - Object whose search properties will be copied to properties.