com.webmethods.portal.event

Interface IPortalEvent

All Superinterfaces:

IEvent, INotifiableEvent, Serializable

All Known Subinterfaces:

IAddEvent, IAddNoteEvent, IAddReferenceEvent, IAutoClassificationEvent, ICacheInvalidateEvent, ICopyEvent, ICopyReferenceEvent, ICreateEvent, IDeleteEvent, IModifyEvent, IMoveEvent, IMoveReferenceEvent, IPermissionsEvent, IPortal2ThingsEvent, IPortal3ThingsEvent, IPurgeEvent, IRemoveEvent, IRemoveReferenceEvent, IScheduleEvent, IScheduleManagementEvent, ISetAcesEvent, ISetAnonymousEvent, ISetAuthSchemeEvent, ISetOwnerEvent, ISetPolicyEvent, IThingEvent, ITransferEvent, IUpdateEvent, IWorkspaceUpdateEvent

public interface IPortalEvent
extends INotifiableEvent

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IPortalEvent.IListener
static interface	IPortalEvent.ISynchronousListener
static class	IPortalEvent.Listeners
static class	IPortalEvent.QueueListeners
static class	IPortalEvent.SynchronousListeners

Field Summary

Fields

Modifier and Type	Field and Description
static int	OPERATION_ADD
static int	OPERATION_ALL
static int	OPERATION_CREATE
static int	OPERATION_DEFAULT
static int	OPERATION_DELETE
static int	OPERATION_GROUP_PORTAL
static int	OPERATION_GROUP_WORKFLOW
static int	OPERATION_MOVE
static int	OPERATION_NO_OP
static int	OPERATION_NONE
static int	OPERATION_READ
static int	OPERATION_REMOVE
static int	OPERATION_UPDATE
static int	STATUS_ANY
static int	STATUS_DENIED
static int	STATUS_ERROR
static int	STATUS_SUCCESS

Method Summary

Modifier and Type	Method and Description
int	getOperation() Gets the operation code associated with this event.
int	getOperation(String operation_name) Looks up the operation code using the operation name.
String	getOperationName() Gets the string representation of the operation code associated with this event.
String	getOperationName(int operation) Looks up the string representation of the operation code.
String	getOperationTemplateName() Gets the notification rendering template name.
String	getOperationTemplateName(int operation) Looks up the rendering layout name based on the operation code.
IThingID	getRelationId() Gets the id of the relation thing associated with this event.
boolean	getRelationIsFrom() Gets the from value of the relation associated with this event.
int	getStatus() Gets the status code associated with this event.
int	getStatus(String status_name) Looks up the status code using the status name.
String	getStatusName() Gets the string representation of the status code associated with this event.
String	getStatusName(int status) Looks up the status name using the status code.
IThingID	getThingId() Gets the id of the thing associated with this event.
IThingID	getUserId() Gets the id of the user associated with this event.
boolean	isDeliverable() Deliverable event flag which indicates if given event should be delivered to subscribers Normally this is 'true', but in some circumstances we would like to avoid notification on certain events

Methods inherited from interface com.webmethods.rtl.event.IEvent

getJcrSessionID, getJcrSessionUserData, getSourceIP, getTimestamp, getVMID, isLocalEvent, raise

Field Detail

STATUS_ANY

static final int STATUS_ANY

See Also:

Constant Field Values

STATUS_SUCCESS

static final int STATUS_SUCCESS

See Also:

Constant Field Values

STATUS_DENIED

static final int STATUS_DENIED

See Also:

Constant Field Values

STATUS_ERROR

static final int STATUS_ERROR

See Also:

Constant Field Values

OPERATION_GROUP_PORTAL

static final int OPERATION_GROUP_PORTAL

See Also:

Constant Field Values

OPERATION_GROUP_WORKFLOW

static final int OPERATION_GROUP_WORKFLOW

See Also:

Constant Field Values

OPERATION_ALL

static final int OPERATION_ALL

See Also:

Constant Field Values

OPERATION_NONE

static final int OPERATION_NONE

See Also:

Constant Field Values

OPERATION_CREATE

static final int OPERATION_CREATE

See Also:

Constant Field Values

OPERATION_READ

static final int OPERATION_READ

See Also:

Constant Field Values

OPERATION_UPDATE

static final int OPERATION_UPDATE

See Also:

Constant Field Values

OPERATION_DELETE

static final int OPERATION_DELETE

See Also:

Constant Field Values

OPERATION_ADD

static final int OPERATION_ADD

See Also:

Constant Field Values

OPERATION_REMOVE

static final int OPERATION_REMOVE

See Also:

Constant Field Values

OPERATION_NO_OP

static final int OPERATION_NO_OP

See Also:

Constant Field Values

OPERATION_MOVE

static final int OPERATION_MOVE

See Also:

Constant Field Values

OPERATION_DEFAULT

static final int OPERATION_DEFAULT

See Also:

Constant Field Values

Method Detail

getThingId

IThingID getThingId()

Gets the id of the thing associated with this event.

Returns:

IThingID of the thing

getRelationId

IThingID getRelationId()

Gets the id of the relation thing associated with this event.

Returns:

IThingID of the relation

getRelationIsFrom

boolean getRelationIsFrom()

Gets the from value of the relation associated with this event.

Returns:

boolean value of relation from

getOperation

int getOperation()

Gets the operation code associated with this event.

Returns:

operation code

getStatus

int getStatus()

Gets the status code associated with this event.

Returns:

status code

getUserId

IThingID getUserId()

Gets the id of the user associated with this event.

Returns:

IThingID of the user

getOperationName

String getOperationName()

Gets the string representation of the operation code associated with this event. In most cases, it is the verb corresponding to the operation.

Returns:

operation name

getOperationTemplateName

String getOperationTemplateName()

Gets the notification rendering template name. The template name usually depends on the operation.

Returns:

template name

See Also:

ISubscriptionService.getAppCriteriaLayout(com.webmethods.portal.service.meta2.thing.IThingID)

getStatusName

String getStatusName()

Gets the string representation of the status code associated with this event.

Returns:

status name

getOperationName

String getOperationName(int operation)

Looks up the string representation of the operation code.

Parameters:

operation - the operation code

Returns:

operation name. If a name is not found for the code, the string value of the code is returned, for example "123".

getOperationTemplateName

String getOperationTemplateName(int operation)

Looks up the rendering layout name based on the operation code.

Parameters:

operation - the operation code

Returns:

layout name. If the operation code does not have a layout defined, or the operation code is not one of the predefined, an empty string is returned.

getOperation

int getOperation(String operation_name)

Looks up the operation code using the operation name.

Parameters:

operation_name - the operation name

Returns:

operation code name. If the operation name is not known, the returned value is undefined.

getStatusName

String getStatusName(int status)

Looks up the status name using the status code.

Parameters:

status - the status code

Returns:

status code name. If the status code is not one of the known one, the string value of the code, for example "123" is returned.

getStatus

int getStatus(String status_name)

Looks up the status code using the status name.

Parameters:

status_name - the status name

Returns:

status code name. If the status name is not known, the returned value is undefined.

isDeliverable

boolean isDeliverable()

Deliverable event flag which indicates if given event should be delivered to subscribers Normally this is 'true', but in some circumstances we would like to avoid notification on certain events

Returns: