com.jadeworld.jade.rootschema
Class Notification

java.lang.Object
  com.jadeworld.jade.rootschema.Object
      com.jadeworld.jade.rootschema.Notification

public class Notification
extends Object

Field Summary

Fields inherited from class com.jadeworld.jade.rootschema.Object

oid

Constructor Summary

Notification()

Method Summary

java.util.Calendar	elapsedTime() The read-only elapsedTime property of the Notification class is set to the time that the notification request has been in place.
int	eventType() The read-only eventType property of the Notification class is set to the eventType parameter of the notification request.
int	featureNumber() The feature number is zero for notifications registered against classes, and the identifying number of the interface method that was mapped by the subscriber to receive an event notification, for notifications registered against interfaces.
boolean	isInterface() isInterface is false for notifications registered against classes, and true for notifications registered against interfaces.
Process	requestedBy() The process that submitted the notification request.
java.util.Calendar	requestTime() The date and time of the notification request.
int	responseType() The responseType parameter of the notification request.
int	serialNumber() An internally-assigned value.
java.lang.Object	subscriber() Returns a reference to the object to which the notification is delivered.
java.lang.Object	target() Returns a reference to the object that is the target of a notification request.
int	typeNumber() The type number is zero for notifications registered against classes, and the identifying number of the associated interface, for notifications registered against interfaces.
int	userTag() The eventTag parameter of the notification request.

Methods inherited from class com.jadeworld.jade.rootschema.Object

changeObjectVolatility, creationTime, edition, equals, exclusiveLock, getClassNumberForObject, getInstanceIdForObject, getLockStatus, getName, getObjectStringForObject, getObjectVolatility, getOidString, getOidStringForObject, getPropertyValue, hashCode, hasMembers, isImportedObject, isKindOf, isLockedByMe, isObjectFrozen, isObjectNonSharedTransient, isObjectPersistent, isObjectSharedTransient, isObjectStable, isObjectTransient, isObjectVolatile, isSharedTransient, isSystemObject, isTransient, latestEdition, lock, makeObjectFrozen, makeObjectStable, makeObjectVolatile, reserveLock, sdeCauseEvent, sdsCauseEvent, setPropertyValue, sharedLock, toString, tryLock, unlock, updateObjectEdition

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Notification

public Notification()

Method Detail

elapsedTime

public java.util.Calendar elapsedTime()

The read-only elapsedTime property of the Notification class is set to the time that the notification request has been in place.

Returns:

The time that the notification request has been active.

eventType

public int eventType()

The read-only eventType property of the Notification class is set to the eventType parameter of the notification request. The eventType property specifies the type of event for which the notification is requested. The global constants in the SystemEvents category for the types of event that can be requested are listed in the following table.

 Global Constant Integer Value Description

 Any_System_Event 0 Object has been created, deleted, or updated

 Object_Create_Event 4 Object has been created

 Object_Delete_Event 6 Object has been deleted

 Object_Update_Event 3 Object has been updated

Returns:

notification event type.

featureNumber

public int featureNumber()

The feature number is zero for notifications registered against classes, and the identifying number of the interface method that was mapped by the subscriber to receive an event notification, for notifications registered against interfaces.

Returns:

Feature number.

isInterface

public boolean isInterface()

isInterface is false for notifications registered against classes, and true for notifications registered against interfaces.

Returns:

false

requestTime

public java.util.Calendar requestTime()

The date and time of the notification request.

Returns:

The date and time of the notification request.

requestedBy

public Process requestedBy()

The process that submitted the notification request.

Returns:

The notification request process instance.

responseType

public int responseType()

The responseType parameter of the notification request.
The responseType parameter specifies the frequency with which an event notification is to be sent.
The NotificationResponses category global constants for the types of response that can be sent are listed in the following table.

 Global Constant Integer Value Description
>
 Response_Cancel 1 Sends a notification when the class receives a matching event and then
 cancels the notification

 Response_Continuous 0 Sends a notification whenever the class receives a matching event

 Response_Suspend 2 Sends a notification when the class receives a matching event and then
 suspends notification until the user refreshes the local copy of the class

Returns:

the notification response type.

serialNumber

public int serialNumber()

An internally-assigned value.

Returns:

The internal serial number.

subscriber

public java.lang.Object subscriber()

Returns a reference to the object to which the notification is delivered.

Returns:

The object which is the subscriber of the notification.

target

public java.lang.Object target()

Returns a reference to the object that is the target of a notification request.

Returns:

The oject which is the target of the notification.

typeNumber

public int typeNumber()

The type number is zero for notifications registered against classes, and the identifying number of the associated interface, for notifications registered against interfaces.

Returns:

The notification type number.

userTag

public int userTag()

The eventTag parameter of the notification request.
The eventTag parameter specifies an integer value (for example, an index into an array) that is returned with each notification.

Returns:

The notification user tag.