org.eclipse.corona.collaboration
Interface ICollaborationEvent

All Superinterfaces:
org.osgi.service.event.EventConstants, java.io.Serializable
All Known Subinterfaces:
IProjectEvent
All Known Implementing Classes:
CollaborationEvent, ProjectEvent

public interface ICollaborationEvent
extends java.io.Serializable, org.osgi.service.event.EventConstants

Interface for Collaboration Events


Field Summary
static java.lang.String ACTION_TYPE
          The type of action that initiated the collaboration event
static java.lang.String COLLABORATION_ID
          The collaboration ID uniquely identifies an artifact that is the subject of the collaboration.
static java.lang.String CONTEXT_NAME
          The context name defines the unique name of the collaboration with respect to its CONTEXT_TYPE.
static java.lang.String CONTEXT_TYPE
          The context type specifies the type of collaboration.
static java.lang.String CONTEXT_URI
          The URI that defines the context of this event.
static java.lang.String REMOTE_URI
          The REMOTE_URI defines a list of remote URI that the CollaborationEvent should be routed to.
static java.lang.String RESOURCE_CONTAINER_URI
           
static java.lang.String RESOURCE_NAME
           
static java.lang.String RESOURCE_PROPERTY_CONTACT
           
static java.lang.String RESOURCE_PROPERTY_DESCRIPTION
           
static java.lang.String RESOURCE_PROPERTY_OBJECTIVE
           
static java.lang.String RESOURCE_PROPERTY_PROJECT_LEADER
           
static java.lang.String RESOURCE_PROPERTY_START
           
static java.lang.String RESOURCE_PROPERTY_STATUS
           
static java.lang.String RESOURCE_PROPERTY_TYPE
           
static java.lang.String RESOURCE_PROPERTY_URI
           
static java.lang.String RESOURCE_PROPERTY_VALUE
           
static java.lang.String RESOURCE_TYPE
           
static java.lang.String RESOURCE_URI
           
static java.lang.String ROUTER_ID
           
static java.lang.String TOPIC_ROOT
          The root topic for publishing Collaboration events
static char TOPIC_SEPARATOR
           
 
Fields inherited from interface org.osgi.service.event.EventConstants
BUNDLE_SIGNER, BUNDLE_SYMBOLICNAME, EVENT, EVENT_FILTER, EVENT_TOPIC, EXCEPTION, EXCEPTION_CLASS, EXCEPTION_MESSAGE, EXECPTION_CLASS, MESSAGE, SERVICE, SERVICE_ID, SERVICE_OBJECTCLASS, SERVICE_PID, TIMESTAMP
 
Method Summary
 java.lang.String getActionType()
           
 java.lang.String getContextName()
           
 java.lang.String getContextType()
          Get the context type specifies the type of event.
 java.lang.String getContextURI()
          Get the URI that defines the context of this event.
 void setActionType(java.lang.String actionType)
           
 

Field Detail

TOPIC_ROOT

static final java.lang.String TOPIC_ROOT
The root topic for publishing Collaboration events

See Also:
Constant Field Values

TOPIC_SEPARATOR

static final char TOPIC_SEPARATOR
See Also:
Constant Field Values

CONTEXT_URI

static final java.lang.String CONTEXT_URI
The URI that defines the context of this event. This is normally the URI of the context container that generated the event. This collaboration attribute is required.

See Also:
Constant Field Values

CONTEXT_TYPE

static final java.lang.String CONTEXT_TYPE
The context type specifies the type of collaboration. For example, 'project'. This collaboration attribute is required.

See Also:
Constant Field Values

CONTEXT_NAME

static final java.lang.String CONTEXT_NAME
The context name defines the unique name of the collaboration with respect to its CONTEXT_TYPE. For example, 'Acme' would the name of a collaboration 'Project'. This collaboration attribute is required.

See Also:
Constant Field Values

COLLABORATION_ID

static final java.lang.String COLLABORATION_ID
The collaboration ID uniquely identifies an artifact that is the subject of the collaboration. The ID is unique within the context of CONTEXT_TYPE/CONTEXT_NAME. This collaboration attribute is optional.

See Also:
Constant Field Values

REMOTE_URI

static final java.lang.String REMOTE_URI
The REMOTE_URI defines a list of remote URI that the CollaborationEvent should be routed to. This optional property is used by each CollaborationEventRouter to determine where to route the CollaborationEvent.

See Also:
Constant Field Values

ACTION_TYPE

static final java.lang.String ACTION_TYPE
The type of action that initiated the collaboration event

See Also:
Constant Field Values

RESOURCE_NAME

static final java.lang.String RESOURCE_NAME
See Also:
Constant Field Values

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE
See Also:
Constant Field Values

RESOURCE_URI

static final java.lang.String RESOURCE_URI
See Also:
Constant Field Values

RESOURCE_CONTAINER_URI

static final java.lang.String RESOURCE_CONTAINER_URI
See Also:
Constant Field Values

RESOURCE_PROPERTY_URI

static final java.lang.String RESOURCE_PROPERTY_URI
See Also:
Constant Field Values

RESOURCE_PROPERTY_TYPE

static final java.lang.String RESOURCE_PROPERTY_TYPE
See Also:
Constant Field Values

RESOURCE_PROPERTY_VALUE

static final java.lang.String RESOURCE_PROPERTY_VALUE
See Also:
Constant Field Values

RESOURCE_PROPERTY_DESCRIPTION

static final java.lang.String RESOURCE_PROPERTY_DESCRIPTION
See Also:
Constant Field Values

RESOURCE_PROPERTY_PROJECT_LEADER

static final java.lang.String RESOURCE_PROPERTY_PROJECT_LEADER
See Also:
Constant Field Values

RESOURCE_PROPERTY_CONTACT

static final java.lang.String RESOURCE_PROPERTY_CONTACT
See Also:
Constant Field Values

RESOURCE_PROPERTY_OBJECTIVE

static final java.lang.String RESOURCE_PROPERTY_OBJECTIVE
See Also:
Constant Field Values

RESOURCE_PROPERTY_START

static final java.lang.String RESOURCE_PROPERTY_START
See Also:
Constant Field Values

RESOURCE_PROPERTY_STATUS

static final java.lang.String RESOURCE_PROPERTY_STATUS
See Also:
Constant Field Values

ROUTER_ID

static final java.lang.String ROUTER_ID
See Also:
Constant Field Values
Method Detail

getContextURI

java.lang.String getContextURI()
Get the URI that defines the context of this event. This is normally the URI of the context container that generated the event.

Returns:

getContextType

java.lang.String getContextType()
Get the context type specifies the type of event. For example, 'project'.

Returns:

getContextName

java.lang.String getContextName()
Returns:

setActionType

void setActionType(java.lang.String actionType)

getActionType

java.lang.String getActionType()

Copyright 2006 IBM Corporation and others.
All Rights Reserved.