ext.sulis.change

Class ChangeHelper

Object

ChangeHelper

All Implemented Interfaces:

RemoteAccess

public class ChangeHelper
extends Object
implements RemoteAccess

Field Summary

Fields

Modifier and Type	Field and Description
static String	LATESTMODE_CREATE
static String	LATESTMODE_LINK
static String	LATESTMODE_MODIFY
static int	MAJOR
static int	MINOR

Fields inherited from interface RemoteAccess

versionID

Constructor Summary

Constructors

Constructor and Description
ChangeHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static Persistable	addToChangeActivity(Class linkClass, Changeable2 changeable, WTChangeActivity2 ca) link a changeable to a change activity
static ChangeRecord2	addToChangeActivityResulting(Changeable2 changeable, WTChangeActivity2 ca) link a changeable to a change activity as resulting object
static WTChangeOrder2	addToChangeOrder(Object changeable, Map meta) TODO javadoc
static WTChangeActivity2	createChangeActivity(Changeable2 changeable, WTChangeOrder2 co, Map meta) create a change activity , using the following information from the meta Map: key type used for default Number String number for object, will get "-a" appended null CA-Description String description attribute if empty checks the key Description Description String description attribute - no description supplied - NeedDate Timestamp date needed State String lifecycle state RESOLVED
static WTChangeOrder2	createChangeOrder(Object changeable, Map meta) create a change order for a changeable, getting data from meta Map: for now hardcode some things - may need changing if more flexible usecase is met meta has to contain the following keys: name number (if empty use OIR) delay (defaults to 30 (days)) state (defaults to RESOLVED) description (default=empty)
static WTChangeOrder2	createChangeOrder2(Object changeable, Map meta)
static List<Changeable2>	getChangeablesOfChangeOrder(WTChangeOrder2 co)
static WTChangeOrder2	getChangeOrderByNumber(String changeNumber)
static WTChangeActivity2	getLatestChangeActivity(Changeable2 changeObj, String changeNumber, boolean considerECM)
static WTChangeActivity2	getLatestChangeActivity(Changeable2 changeObj, String changeNumber, boolean considerECM, String latestMode)
static WTChangeActivity2	getLatestChangeActivityForChangeable(Changeable2 changeable)
static WTChangeActivity2	getLatestChangeActivityForChangeable(Changeable2 changeable, String latestMode)
static WTChangeOrder2	getLatestChangeOrder(Changeable2 changeObj, String changeNumber, boolean considerECM)
static WTChangeOrder2	getLatestChangeOrder(Changeable2 changeObj, String changeNumber, boolean considerECM, String latestMode)
static WTChangeActivity2	getRelatedChangeActivity(WTChangeOrder2 co)
static void	loadChangesFromFile(String[] a) TODO javadoc

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LATESTMODE_MODIFY

public static final String LATESTMODE_MODIFY

See Also:

Constant Field Values

LATESTMODE_CREATE

public static final String LATESTMODE_CREATE

See Also:

Constant Field Values

LATESTMODE_LINK

public static final String LATESTMODE_LINK

See Also:

Constant Field Values

MAJOR

public static final int MAJOR

See Also:

Constant Field Values

MINOR

public static final int MINOR

See Also:

Constant Field Values

Constructor Detail

ChangeHelper

public ChangeHelper()

Method Detail

getLatestChangeActivity

public static WTChangeActivity2 getLatestChangeActivity(Changeable2 changeObj,
                                        String changeNumber,
                                        boolean considerECM)
                                                 throws Exception

Throws:

Exception

getLatestChangeActivity

public static WTChangeActivity2 getLatestChangeActivity(Changeable2 changeObj,
                                        String changeNumber,
                                        boolean considerECM,
                                        String latestMode)
                                                 throws Exception

Throws:

Exception

getLatestChangeOrder

public static WTChangeOrder2 getLatestChangeOrder(Changeable2 changeObj,
                                  String changeNumber,
                                  boolean considerECM)
                                           throws Exception

Throws:

Exception

getLatestChangeOrder

public static WTChangeOrder2 getLatestChangeOrder(Changeable2 changeObj,
                                  String changeNumber,
                                  boolean considerECM,
                                  String latestMode)
                                           throws Exception

Throws:

Exception

getChangeOrderByNumber

public static WTChangeOrder2 getChangeOrderByNumber(String changeNumber)
                                             throws Exception

Throws:

Exception

getRelatedChangeActivity

public static WTChangeActivity2 getRelatedChangeActivity(WTChangeOrder2 co)
                                                  throws Exception

Throws:

Exception

getChangeablesOfChangeOrder

public static List<Changeable2> getChangeablesOfChangeOrder(WTChangeOrder2 co)
                                                     throws Exception

Throws:

Exception

createChangeActivity

public static WTChangeActivity2 createChangeActivity(Changeable2 changeable,
                                     WTChangeOrder2 co,
                                     Map meta)
                                              throws Exception

create a change activity , using the following information from the meta Map:

key	type	used for	default
Number	String	number for object, will get "-a" appended	null
CA-Description	String	description attribute	if empty checks the key Description
Description	String	description attribute	- no description supplied -
NeedDate	Timestamp	date needed
State	String	lifecycle state	RESOLVED

Parameters:

changeable - the changeable object

co - the change order

meta - Map with additional data

Returns:

the new WTChangeActivity2

Throws:

Exception

addToChangeActivity

public static Persistable addToChangeActivity(Class linkClass,
                              Changeable2 changeable,
                              WTChangeActivity2 ca)
                                       throws Exception

link a changeable to a change activity

Parameters:

linkClass - the class to use to link objects

changeable - the changeable

ca - the change activity

Returns:

the link

Throws:

Exception

getLatestChangeActivityForChangeable

public static WTChangeActivity2 getLatestChangeActivityForChangeable(Changeable2 changeable)
                                                              throws Exception

Throws:

Exception

getLatestChangeActivityForChangeable

public static WTChangeActivity2 getLatestChangeActivityForChangeable(Changeable2 changeable,
                                                     String latestMode)
                                                              throws Exception

Throws:

Exception

addToChangeActivityResulting

public static ChangeRecord2 addToChangeActivityResulting(Changeable2 changeable,
                                         WTChangeActivity2 ca)
                                                  throws Exception

link a changeable to a change activity as resulting object

Parameters:

changeable - the changeable

ca - the change activity

Returns:

the ChangeRecord2 link

Throws:

Exception

addToChangeOrder

public static WTChangeOrder2 addToChangeOrder(Object changeable,
                              Map meta)
                                       throws Exception

TODO javadoc

Parameters:

changeable -

meta -

Returns:

Throws:

Exception

loadChangesFromFile

public static void loadChangesFromFile(String[] a)
                                throws Exception

TODO javadoc

Parameters:

a -

Throws:

Exception

createChangeOrder

public static WTChangeOrder2 createChangeOrder(Object changeable,
                               Map meta)
                                        throws Exception

 create a change order for a changeable, getting data from meta Map:
       for now hardcode some things - may need changing if more flexible usecase is met
       meta has to contain the following keys:
       name
       number (if empty use OIR)
       delay (defaults to 30 (days))
       state (defaults to RESOLVED)
       description (default=empty)
 

Parameters:

changeable - the object to create change order for

meta - input data

Returns:

new WTChangeOrder2

Throws:

Exception

createChangeOrder2

public static WTChangeOrder2 createChangeOrder2(Object changeable,
                                Map meta)
                                         throws Exception

Throws:

Exception