wt.inf.team
Class ContainerTeamServiceEvent

java.lang.Object
  extended bywt.events.KeyedEvent
      extended bywt.inf.team.ContainerTeamServiceEvent
All Implemented Interfaces:
Serializable

public class ContainerTeamServiceEvent
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 ContainerTeamService interface. The event could be used by a custom implementation of the ContainerTeamService.

Supported API: true

Extendable: false

See Also:
KeyedEvent, Serialized Form

Field Summary
static String ADD_MEMBER
          A constant that defines an event key that marks the occurrence of the add_member event

Supported API: false
private static String CLASSNAME
           
static String CONFIRM_PARTICIPATION
          A constant that defines an event key that marks the occurrence of the state_change event

Supported API: false
private  WTUser newUser
           
private  ContainerTeamManagedState previousState
           
private  boolean reassign
           
static String REMOVE_MEMBER
          A constant that defines an event key that marks the occurrence of the remove_member event

Supported API: false
private  WTUser removedUser
           
static String REPLACE_MEMBER
          A constant that defines an event key that marks the occurrence of the replace_user event

Supported API: false
private static String RESOURCE
           
private  ContainerTeamService service
           
static String STATE_CHANGE
          A constant that defines an event key that marks the occurrence of the state_change event

Supported API: false
 
Fields inherited from class wt.events.KeyedEvent
 
Constructor Summary
ContainerTeamServiceEvent(ContainerTeamService service, String eventType, Object eventTarget, boolean reassign)
          Constructs a Conainer Team services event from the specified service and its event type and target.
ContainerTeamServiceEvent(String eventType, WTKeyedMap map)
          Constructs a Conainer Team services event from the specified service and its event type and WTKeyedMap target.
 
Method Summary
private  void addEventAttributes(ContainerTeamServiceEvent event)
           
static String generateEventKey(String eventType)
          Generates an event key from an event type

Supported API: false
 WTUser getNewUser()
          Gets the value of the attribute: newUser.
 ContainerTeamManagedState getPreviousState()
          Gets the value of the attribute: previousState.
 WTUser getRemovedUser()
          Gets the value of the attribute: removedUser.
 ContainerTeamService getService()
          Gets the value of the attribute: service; The Container Team service that emits events.
 ContainerTeamManaged getTarget()
          Gets the target of the event.
 WTKeyedMap getTargets()
          Multi-object getter.
 boolean isReassign()
          Gets the value of the attribute: reassign.
 void setNewUser(WTUser a_NewUser)
          Sets the value of the attribute: newUser.
 void setPreviousState(ContainerTeamManagedState a_PreviousState)
          Sets the value of the attribute: previousState.
 void setReassign(boolean a_Reassign)
          Sets the value of the attribute: reassign.
 void setRemovedUser(WTUser a_RemovedUser)
          Sets the value of the attribute: removedUser.
 void setService(ContainerTeamService a_Service)
          Sets the value of the attribute: service; The Container Team service that emits events.
 KeyedEvent toMultiObjectEvent()
          Converts an event with a single target object to a multiple object event by creating a new target object of type WTKeyedMap with key = the single object event's target object and value = the reassign value.
 KeyedEvent[] toSingleObjectEvents()
          Constructs an array of KeyedEvent objects given a multi-object event.
 
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

STATE_CHANGE

public static final String STATE_CHANGE
A constant that defines an event key that marks the occurrence of the state_change event

Supported API: false

See Also:
Constant Field Values

ADD_MEMBER

public static final String ADD_MEMBER
A constant that defines an event key that marks the occurrence of the add_member event

Supported API: false

See Also:
Constant Field Values

REMOVE_MEMBER

public static final String REMOVE_MEMBER
A constant that defines an event key that marks the occurrence of the remove_member event

Supported API: false

See Also:
Constant Field Values

REPLACE_MEMBER

public static final String REPLACE_MEMBER
A constant that defines an event key that marks the occurrence of the replace_user event

Supported API: false

See Also:
Constant Field Values

CONFIRM_PARTICIPATION

public static final String CONFIRM_PARTICIPATION
A constant that defines an event key that marks the occurrence of the state_change event

Supported API: false

See Also:
Constant Field Values

service

private ContainerTeamService service

removedUser

private WTUser removedUser

newUser

private WTUser newUser

previousState

private ContainerTeamManagedState previousState

reassign

private boolean reassign
Constructor Detail

ContainerTeamServiceEvent

public ContainerTeamServiceEvent(ContainerTeamService service,
                                 String eventType,
                                 Object eventTarget,
                                 boolean reassign)
                          throws WTException,
                                 WTPropertyVetoException
Constructs a Conainer Team services event from the specified service and its event type and target.

Supported API: false

Parameters:
service -
eventType -
eventTarget -
reassign -
Throws:
WTException
WTPropertyVetoException

ContainerTeamServiceEvent

public ContainerTeamServiceEvent(String eventType,
                                 WTKeyedMap map)
Constructs a Conainer Team services event from the specified service and its event type and WTKeyedMap target. The WTKeyedMap has keys = target objects and values = Boolean reassign value.

Supported API: false

Parameters:
eventType -
map -
Method Detail

getService

public ContainerTeamService getService()
Gets the value of the attribute: service; The Container Team service that emits events.

Supported API: false

Returns:
ContainerTeamService

setService

public void setService(ContainerTeamService a_Service)
                throws WTPropertyVetoException
Sets the value of the attribute: service; The Container Team service that emits events.

Supported API: false

Parameters:
a_Service -
Throws:
WTPropertyVetoException

getRemovedUser

public WTUser getRemovedUser()
Gets the value of the attribute: removedUser.

Supported API: false

Returns:
WTUser

setRemovedUser

public void setRemovedUser(WTUser a_RemovedUser)
                    throws WTPropertyVetoException
Sets the value of the attribute: removedUser.

Supported API: false

Parameters:
a_RemovedUser -
Throws:
WTPropertyVetoException

getNewUser

public WTUser getNewUser()
Gets the value of the attribute: newUser.

Supported API: false

Returns:
WTUser

setNewUser

public void setNewUser(WTUser a_NewUser)
                throws WTPropertyVetoException
Sets the value of the attribute: newUser.

Supported API: false

Parameters:
a_NewUser -
Throws:
WTPropertyVetoException

getPreviousState

public ContainerTeamManagedState getPreviousState()
Gets the value of the attribute: previousState.

Supported API: false

Returns:
ContainerTeamManagedState

setPreviousState

public void setPreviousState(ContainerTeamManagedState a_PreviousState)
                      throws WTPropertyVetoException
Sets the value of the attribute: previousState.

Supported API: false

Parameters:
a_PreviousState -
Throws:
WTPropertyVetoException

isReassign

public boolean isReassign()
Gets the value of the attribute: reassign.

Supported API: false

Returns:
boolean

setReassign

public void setReassign(boolean a_Reassign)
                 throws WTPropertyVetoException
Sets the value of the attribute: reassign.

Supported API: false

Parameters:
a_Reassign -
Throws:
WTPropertyVetoException

getTarget

public ContainerTeamManaged getTarget()
Gets the target of the event.

Supported API: false

Returns:
ContainerTeamManaged
See Also:
ContainerTeamServiceEvent

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()
Converts an event with a single target object to a multiple object event by creating a new target object of type WTKeyedMap with key = the single object event's target object and value = the reassign value. Additional appropriate values are added to the event based on event type.

Supported API: false

Overrides:
toMultiObjectEvent in class KeyedEvent
Returns:
KeyedEvent

toSingleObjectEvents

public KeyedEvent[] toSingleObjectEvents()
                                  throws WTException
Constructs an array of KeyedEvent objects given a multi-object event. Additional appropriate values are added to each event based on event type.

Supported API: false

Overrides:
toSingleObjectEvents in class KeyedEvent
Returns:
KeyedEvent[]
Throws:
WTException

getTargets

public WTKeyedMap getTargets()
Multi-object getter. Returns a WTKeyedMap with keys = target objects and values = reassign Boolean value.

Supported API: false

Returns:
WTKeyedMap

addEventAttributes

private void addEventAttributes(ContainerTeamServiceEvent event)