wt.enterprise
Class EnterpriseServiceEvent

java.lang.Object
  extended bywt.events.KeyedEvent
      extended bywt.enterprise.EnterpriseServiceEvent
All Implemented Interfaces:
Serializable

public class EnterpriseServiceEvent
extends KeyedEvent
implements Serializable



Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
private  RevisionControlled copy
           
private  CopyMultiRules copyMultiRules
           
private  CopyObjectInfo[] copyObjectInfo
           
private  Map copyRuleMap
           
private  CopyRules copyRules
           
private  RevisionControlled original
           
static String POST_COPY
          A constant that defines an event key that marks the steps after the persisting the copied object.
static String POST_MULTI_COPY
          A constant that defines an event key that marks the steps after the persisting the copied object.
static String PRE_COPY
          A constant that defines an event key that marks the steps prior to persisting the copied object.
static String PRE_MULTI_COPY
          A constant that defines an event key that marks the steps prior to persisting the copied object.
private static String RESOURCE
           
 
Fields inherited from class wt.events.KeyedEvent
 
Constructor Summary
EnterpriseServiceEvent(String eventType, CopyObjectInfo[] copyInformation, CopyMultiRules copyMultiRules)
          Constructs a EnterpriseServiceEvent instance.
EnterpriseServiceEvent(String eventType, RevisionControlled original, RevisionControlled copy, CopyRules copyRules)
          Constructs a EnterpriseServiceEvent instance.
EnterpriseServiceEvent(String eventType, WTKeyedMap eventTarget, Map copyRuleMap)
          Constructs a EnterpriseServiceEvent instance.
 
Method Summary
static String generateEventKey(String event_type)
          Helper function used to generate the event key from the event type

Supported API: false
 RevisionControlled getCopy()
          Gets the value of the attribute: copy; The new copy of the object.
 CopyMultiRules getCopyMultiRules()
          Gets the value of the attribute: copyMultiRules; Rules used for this multi-copy.
 CopyObjectInfo[] getCopyObjectInfo()
          Gets the value of the attribute: copyObjectInfo; Contains the original, copy, and rules for each multi-copy object.
 Map getCopyRuleMap()
          Gets the value of the attribute: copyRuleMap; Rules used for this copy.
 CopyRules getCopyRules()
          Gets the value of the attribute: copyRules; Rules used for this copy.
 RevisionControlled getOriginal()
          Gets the value of the attribute: original; The original object to be copied.
 WTKeyedMap getTargetMap()
          

Supported API: false
 void setCopy(RevisionControlled a_Copy)
          Sets the value of the attribute: copy; The new copy of the object.
 void setCopyMultiRules(CopyMultiRules a_CopyMultiRules)
          Sets the value of the attribute: copyMultiRules; Rules used for this multi-copy.
 void setCopyObjectInfo(CopyObjectInfo[] a_CopyObjectInfo)
          Sets the value of the attribute: copyObjectInfo; Contains the original, copy, and rules for each multi-copy object.
 void setCopyRuleMap(Map a_CopyRuleMap)
          Sets the value of the attribute: copyRuleMap; Rules used for this copy.
 void setCopyRules(CopyRules a_CopyRules)
          Sets the value of the attribute: copyRules; Rules used for this copy.
 void setOriginal(RevisionControlled a_Original)
          Sets the value of the attribute: original; The original object to be copied.
 KeyedEvent toMultiObjectEvent()
          This is a no-op since this class already has support for multi-object operations.
 KeyedEvent[] toSingleObjectEvents()
          This is a no-op since this class already has support for multi-object operations.
 
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

PRE_COPY

public static final String PRE_COPY
A constant that defines an event key that marks the steps prior to persisting the copied object.

Supported API: false

See Also:
Constant Field Values

POST_COPY

public static final String POST_COPY
A constant that defines an event key that marks the steps after the persisting the copied object.

Supported API: false

See Also:
Constant Field Values

original

private RevisionControlled original

copy

private RevisionControlled copy

copyRules

private CopyRules copyRules

copyRuleMap

private Map copyRuleMap

PRE_MULTI_COPY

public static final String PRE_MULTI_COPY
A constant that defines an event key that marks the steps prior to persisting the copied object.

Supported API: false

See Also:
Constant Field Values

POST_MULTI_COPY

public static final String POST_MULTI_COPY
A constant that defines an event key that marks the steps after the persisting the copied object.

Supported API: false

See Also:
Constant Field Values

copyObjectInfo

private CopyObjectInfo[] copyObjectInfo

copyMultiRules

private CopyMultiRules copyMultiRules
Constructor Detail

EnterpriseServiceEvent

public EnterpriseServiceEvent(String eventType,
                              CopyObjectInfo[] copyInformation,
                              CopyMultiRules copyMultiRules)
Constructs a EnterpriseServiceEvent instance.

Supported API: false

Parameters:
eventType -
copyInformation - Contains the original, copy and rules for each object to be copied.
copyMultiRules - Rules used for this multi-copy.

EnterpriseServiceEvent

public EnterpriseServiceEvent(String eventType,
                              RevisionControlled original,
                              RevisionControlled copy,
                              CopyRules copyRules)
Constructs a EnterpriseServiceEvent instance.

Supported API: false

Parameters:
eventType -
original - The original object to be copied.
copy - The new copy of the object.
copyRules - Rules used for this copy.

EnterpriseServiceEvent

public EnterpriseServiceEvent(String eventType,
                              WTKeyedMap eventTarget,
                              Map copyRuleMap)
Constructs a EnterpriseServiceEvent instance.

Supported API: false

Parameters:
eventType -
eventTarget - A map where the key is the original and the value is the copy.
copyRuleMap - A map where the key is an ObjectReference to the original and the values is the CopyRules.
Method Detail

getOriginal

public RevisionControlled getOriginal()
Gets the value of the attribute: original; The original object to be copied.

Supported API: false

Returns:
RevisionControlled

setOriginal

public void setOriginal(RevisionControlled a_Original)
                 throws WTPropertyVetoException
Sets the value of the attribute: original; The original object to be copied.

Supported API: false

Parameters:
a_Original -
Throws:
WTPropertyVetoException

getCopy

public RevisionControlled getCopy()
Gets the value of the attribute: copy; The new copy of the object.

Supported API: false

Returns:
RevisionControlled

setCopy

public void setCopy(RevisionControlled a_Copy)
             throws WTPropertyVetoException
Sets the value of the attribute: copy; The new copy of the object.

Supported API: false

Parameters:
a_Copy -
Throws:
WTPropertyVetoException

getCopyRules

public CopyRules getCopyRules()
Gets the value of the attribute: copyRules; Rules used for this copy.

Supported API: false

Returns:
CopyRules

setCopyRules

public void setCopyRules(CopyRules a_CopyRules)
                  throws WTPropertyVetoException
Sets the value of the attribute: copyRules; Rules used for this copy.

Supported API: false

Parameters:
a_CopyRules -
Throws:
WTPropertyVetoException

getCopyRuleMap

public Map getCopyRuleMap()
Gets the value of the attribute: copyRuleMap; Rules used for this copy. Keys are ObjectReferences to the original object and the values are the CopyRules.

Supported API: false

Returns:
Map

setCopyRuleMap

public void setCopyRuleMap(Map a_CopyRuleMap)
                    throws WTPropertyVetoException
Sets the value of the attribute: copyRuleMap; Rules used for this copy. Keys are ObjectReferences to the original object and the values are the CopyRules.

Supported API: false

Parameters:
a_CopyRuleMap -
Throws:
WTPropertyVetoException

getCopyObjectInfo

public CopyObjectInfo[] getCopyObjectInfo()
Gets the value of the attribute: copyObjectInfo; Contains the original, copy, and rules for each multi-copy object.

Supported API: false

Returns:
CopyObjectInfo[]

setCopyObjectInfo

public void setCopyObjectInfo(CopyObjectInfo[] a_CopyObjectInfo)
                       throws WTPropertyVetoException
Sets the value of the attribute: copyObjectInfo; Contains the original, copy, and rules for each multi-copy object.

Supported API: false

Parameters:
a_CopyObjectInfo -
Throws:
WTPropertyVetoException

getCopyMultiRules

public CopyMultiRules getCopyMultiRules()
Gets the value of the attribute: copyMultiRules; Rules used for this multi-copy.

Supported API: false

Returns:
CopyMultiRules

setCopyMultiRules

public void setCopyMultiRules(CopyMultiRules a_CopyMultiRules)
                       throws WTPropertyVetoException
Sets the value of the attribute: copyMultiRules; Rules used for this multi-copy.

Supported API: false

Parameters:
a_CopyMultiRules -
Throws:
WTPropertyVetoException

generateEventKey

public static String generateEventKey(String event_type)
Helper function used to generate the event key from the event type

Supported API: false

Parameters:
event_type -
Returns:
String

toSingleObjectEvents

public KeyedEvent[] toSingleObjectEvents()
                                  throws WTException
This is a no-op since this class already has support for multi-object operations.

Supported API: false

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

toMultiObjectEvent

public KeyedEvent toMultiObjectEvent()
This is a no-op since this class already has support for multi-object operations.

Supported API: false

Overrides:
toMultiObjectEvent in class KeyedEvent
Returns:
KeyedEvent

getTargetMap

public WTKeyedMap getTargetMap()


Supported API: false

Returns:
WTKeyedMap