wt.team
Class TeamServiceEvent

java.lang.Object
  wt.events.KeyedEvent
      wt.team.TeamServiceEvent

All Implemented Interfaces:

Serializable

public class TeamServiceEvent

extends KeyedEvent

implements Serializable

Provides a service specific event extended from KeyedEvent used in conjunction with the standard implementation of the server-side functionality as defined by the TeamService interface. The event could be used by a custom implementation of the TeamService.

Supported API: true

Extendable: false

See Also:

KeyedEvent, Serialized Form

Field Summary

private static String	CLASSNAME
private static String	RESOURCE
static String	RETEAM A constant that defines an event key that marks the occurrence of the reteam event Supported API: false
private TeamService	service

Fields inherited from class wt.events.KeyedEvent

Constructor Summary

TeamServiceEvent(String eventType, Object target)
Constructs a Team services event from the specified event type and target.

TeamServiceEvent(String eventType, WTCollection eventTargets)
Constructs a Team services event from the specified event type and target.

TeamServiceEvent(TeamService service, String eventType, TeamManaged eventTarget)
Constructs a Team services event from the specified service and its event type and target.

Method Summary

static String	generateEventKey(String eventType) Generates an event key from an event type Supported API: false
TeamService	getService() Gets the value of the attribute: service; The Team service that emits events.
TeamManaged	getTarget() Gets the target of the event.
WTCollection	getTargets() Returns WTCollection of event targets.
void	setService(TeamService a_Service) Sets the value of the attribute: service; The Team service that emits events.
KeyedEvent	toMultiObjectEvent() Given a single object event convert it to a multi object event with a WTCollection target.
KeyedEvent[]	toSingleObjectEvents() Given an event with a target object of type WTCollection convert it to an array of single object KeyedEvents.

Methods inherited from class wt.events.KeyedEvent

generateEventKey, generateEventKey, getConceptualClassname, getEventKey, getEventTarget, getEventType, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

RETEAM

public static final String RETEAM

A constant that defines an event key that marks the occurrence of the reteam event

Supported API: false

See Also:

Constant Field Values

service

private TeamService service

Constructor Detail

TeamServiceEvent

public TeamServiceEvent(TeamService service,
                        String eventType,
                        TeamManaged eventTarget)
                 throws TeamException,
                        WTPropertyVetoException

Constructs a Team services event from the specified service and its event type and target.

Supported API: false

Parameters:

service -

eventType -

eventTarget -

Throws:

TeamException

WTPropertyVetoException

TeamServiceEvent

public TeamServiceEvent(String eventType,
                        WTCollection eventTargets)

Constructs a Team services event from the specified event type and target.

Parameters:

eventType -

TeamServiceEvent

public TeamServiceEvent(String eventType,
                        Object target)

Constructs a Team services event from the specified event type and target.

Parameters:

eventType -

Method Detail

getService

public TeamService getService()

Gets the value of the attribute: service; The Team service that emits events.

Supported API: false

Returns:

TeamService

setService

public void setService(TeamService a_Service)
                throws WTPropertyVetoException

Sets the value of the attribute: service; The Team service that emits events.

Supported API: false

Parameters:

a_Service -

Throws:

WTPropertyVetoException

getTarget

public TeamManaged getTarget()

Gets the target of the event.

Supported API: false

Returns:

TeamManaged

See Also:

TeamServiceEvent

generateEventKey

public static String generateEventKey(String eventType)

Generates an event key from an event type

Supported API: false

Parameters:

eventType -

Returns:

String

toMultiObjectEvent

public KeyedEvent toMultiObjectEvent()

Given a single object event convert it to a multi object event with a WTCollection target.

Supported API: false

Overrides:

toMultiObjectEvent in class KeyedEvent

Returns:

KeyedEvent

toSingleObjectEvents

public KeyedEvent[] toSingleObjectEvents()
                                  throws WTException

Given an event with a target object of type WTCollection convert it to an array of single object KeyedEvents.

Supported API: false

Overrides:

toSingleObjectEvents in class KeyedEvent

Returns:

KeyedEvent[]

Throws:

WTException

getTargets

public WTCollection getTargets()

Returns WTCollection of event targets.

Supported API: false

Returns:

WTCollection