com.cisco.provisioning.cpe.extensions.services
Interface GenericObject

All Known Subinterfaces:

ClassOfService, CNR, DatabaseStatistics, DbConfig, DeviceType, DHCPCriteria, DPE, File, FileType, GlobalProperties, IPDevice, License, Node, NodeType, OwnerID, ProvGroup, PublishingPlugin, RDU, ReliableBatchStatus, Request, Server, User, WorkList

public interface GenericObject

This object is a base class for all logical layer objects. It is also the object that can be used to store custom objects in repository.

Method Summary

boolean	equals(Object obj) Compare objects by comparing their PObject identities.
String	getDescription() Get the description
GenericObject	getOriginal() Returns an original version of this object.
Map	getProperties() Returns properties tree
Object	getProperty(String key) Searches for the property with the specified key in the properties map.
long	getSyncRevNumber() Get the sync revision number
int	hashCode() The hash code of this object.
boolean	isDestroyed() Returns true if this object has been destroyed.
boolean	isNew() Returns true if object was created in the current transaction.
String	toString() Returns object identity string

Method Detail

getOriginal

GenericObject getOriginal()

Returns an original version of this object. All changes done during this transaction are ignored. Any related object retrieved through original version are also returned as original versions.

isNew

boolean isNew()

Returns true if object was created in the current transaction.

isDestroyed

boolean isDestroyed()

Returns true if this object has been destroyed. If the object was destroyed it still hangs in memory until we commit the transaction.

getDescription

String getDescription()

Get the description

Returns:

the description found

getSyncRevNumber

long getSyncRevNumber()

Get the sync revision number

Returns:

the sync revision number found

getProperties

Map getProperties()

Returns properties tree

Returns:

Map a map of properties or null if not set

getProperty

Object getProperty(String key)

Searches for the property with the specified key in the properties map. The method returns null if the property is not found.

The keys for the properties are defined in the API layer classes.

Parameters:

key - the property key.

Returns:

the value in the properties map with specified key value.

equals

boolean equals(Object obj)

Compare objects by comparing their PObject identities.

Overrides:

equals in class Object

hashCode

int hashCode()

The hash code of this object. See Object.hashCode() for more information

Overrides:

hashCode in class Object

Returns:

The hascode of this object

toString

String toString()

Returns object identity string

Overrides:

toString in class Object