com.netegrity.sdk.policyapi
Class SmObjectImpl

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

All Implemented Interfaces:

SmObject, java.lang.Cloneable

Direct Known Subclasses:

SmAdmin, SmAgent, SmAgentConfig, SmAgentGroup, SmAgentType, SmAgentTypeAttr, SmAuthAzMap, SmAuthValidateMap, SmCertMap, SmDomain, SmDomainObjectImpl, SmHostConfig, SmIMSEnvironment, SmKeyManagement, SmMigrationBase, SmODBCQuery, SmPasswordPolicy, SmPwdPolicyRegularExpression, SmRootConfig, SmScheme, SmSelfReg, SmSharedSecretPolicy, SmTrustedHost, SmUserDirectory, SmVariableType

public abstract class SmObjectImpl
extends java.lang.Object
implements SmObject

The root of the Policy API object hierarchy.

Since:

SDK 2.0

Field Summary

static java.lang.String

PropObjectClassName Constant to indicate the property object class name of the object.

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

ConfigurationClassName, PropDesc, PropName, PropOid

Constructor Summary

SmObjectImpl()
Constructs a Policy API object.

SmObjectImpl(java.lang.String className, java.lang.String name)
Constructs a Policy API object with a class name and an object name.

SmObjectImpl(java.lang.String className, java.lang.String name, java.lang.String description)
Construct a Policy API object with a class name, object name, and description.

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.
static SmObject	newObject(java.lang.String strOid) Creates an object with the given oid, of the class determined from the oid.
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.

Methods inherited from class java.lang.Object

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

Field Detail

PropObjectClassName

public static final java.lang.String PropObjectClassName

Constant to indicate the property object class name of the object.

See Also:

Constant Field Values

Constructor Detail

SmObjectImpl

public SmObjectImpl()

Constructs a Policy API object.

SmObjectImpl

public SmObjectImpl(java.lang.String className,
                    java.lang.String name)

Constructs a Policy API object with a class name and an object name.

Parameters:

className - Class name of the object.

name - Name of the object.

SmObjectImpl

public SmObjectImpl(java.lang.String className,
                    java.lang.String name,
                    java.lang.String description)

Construct a Policy API object with a class name, object name, and description.

Parameters:

className - Class name of the object.

name - Name of the object.

description - Description of the object.

Method Detail

getObjectClassname

public java.lang.String getObjectClassname()

Description copied from interface: SmObject

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

Specified by:

getObjectClassname in interface SmObject

Returns:

The policy API object class name.

setObjectClassname

public void setObjectClassname(java.lang.String className)

Description copied from interface: SmObject

Sets the Policy API object class name.

Specified by:

setObjectClassname in interface SmObject

Parameters:

className - Policy API object class name.

getOid

public SmObjId getOid()

Description copied from interface: SmObject

Gets the object identifier.

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

Specified by:

getOid in interface SmObject

Returns:

The object identifier.

setOid

public void setOid(SmObjId Oid)

Description copied from interface: SmObject

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

Specified by:

setOid in interface SmObject

Parameters:

Oid - The object identifier.

setOid

public void setOid(java.lang.Object Oid)

Description copied from interface: SmObject

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

Specified by:

setOid in interface SmObject

Parameters:

Oid - The object identifier.

getName

public java.lang.String getName()

Description copied from interface: SmObject

Gets the name of the object.

Specified by:

getName in interface SmObject

Returns:

The name of the object.

setName

public void setName(java.lang.String name)

Description copied from interface: SmObject

Sets the name of the object.

Specified by:

setName in interface SmObject

Parameters:

name - The name of the object.

getDescription

public java.lang.String getDescription()

Description copied from interface: SmObject

Gets the description of the object.

Specified by:

getDescription in interface SmObject

Returns:

The description of the object.

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: SmObject

Sets the description of the object.

Specified by:

setDescription in interface SmObject

Parameters:

description - The description of the object.

isWriteable

public boolean isWriteable()

Description copied from interface: SmObject

Specifies whether the current object is writable.

Specified by:

isWriteable in interface SmObject

Returns:

true if the object is writable.

isDomainObject

public boolean isDomainObject()

Description copied from interface: SmObject

Specifies whether the current object is a domain object.

Specified by:

isDomainObject in interface SmObject

Returns:

true if the object is a domain object.

toString

public java.lang.String toString()

Description copied from interface: SmObject

Returns the name of the current object.

Specified by:

toString in interface SmObject

Overrides:

toString in class java.lang.Object

Returns:

The name of the object.

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

Parameters:

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

writeSearchProperties

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

Description copied from interface: SmObject

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

Specified by:

writeSearchProperties in interface SmObject

Parameters:

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

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

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

Parameters:

properties - The new properties of the object.

newObject

public static SmObject newObject(java.lang.String strOid)

Creates an object with the given oid, of the class determined from the oid. Returns null on failure.

Parameters:

oid - The object's oid.