wt.sandbox
Class InitialCheckinData

java.lang.Object
  extended bywt.sandbox.InitialCheckinData
All Implemented Interfaces:
Evolvable, Externalizable, Serializable

public class InitialCheckinData
extends Object
implements Evolvable

Base class container for caller data supported by SandboxService upon initial object check in. This data is applied to newly created initial check-in versions before they are saved by InitialCheckinDataApplicator. Subclasses of this class can be used if a suitable subclass of InitialCheckinDataApplicator is used to provide support for any additional data.

Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private  String cadName
           
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
private  Folder folder
           
private  LifeCycleTemplateReference lifeCycleTemplateRef
           
private  String name
           
private  String number
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
private  WTContainerRef targetContainerRef
           
private  TeamTemplateReference teamTemplateRef
           
private  ViewReference view
           
 
Constructor Summary
InitialCheckinData()
           
 
Method Summary
 String getCadName()
          Gets the value of the attribute: cadName; CAD name to be given to object master (ignored if master is not an EPMDocumentMaster)

Supported API: false
 Folder getFolder()
          Gets the value of the attribute: folder; folder checked in object is to be placed in

Supported API: false
 LifeCycleTemplateReference getLifeCycleTemplateRef()
          Gets the value of the attribute: lifeCycleTemplateRef; reference to lifecycle template to be applied to checked in object

Supported API: false
 String getName()
          Gets the value of the attribute: name; name to be given to object master

Supported API: false
 String getNumber()
          Gets the value of the attribute: number; number to be given to object master

Supported API: false
 WTContainerRef getTargetContainerRef()
          Gets the value of the attribute: targetContainerRef; container object is to be checked in to

Supported API: false
 TeamTemplateReference getTeamTemplateRef()
          Gets the value of the attribute: teamTemplateRef; reference to team template to be applied to checked-in object

Supported API: false
 ViewReference getView()
          Gets the value of the attribute: view; view object is to be assigned to (ignored if object is not ViewManaged)

Supported API: false
 void readExternal(ObjectInput input)
          Reads the non-transient fields of this class from an external source.
private  boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source, which is not the current version.
protected  boolean readVersion(InitialCheckinData thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setCadName(String a_CadName)
          Sets the value of the attribute: cadName; CAD name to be given to object master (ignored if master is not an EPMDocumentMaster)

Supported API: false
 void setFolder(Folder a_Folder)
          Sets the value of the attribute: folder; folder checked in object is to be placed in

Supported API: false
 void setLifeCycleTemplateRef(LifeCycleTemplateReference a_LifeCycleTemplateRef)
          Sets the value of the attribute: lifeCycleTemplateRef; reference to lifecycle template to be applied to checked in object

Supported API: false
 void setName(String a_Name)
          Sets the value of the attribute: name; name to be given to object master

Supported API: false
 void setNumber(String a_Number)
          Sets the value of the attribute: number; number to be given to object master

Supported API: false
 void setTargetContainerRef(WTContainerRef a_TargetContainerRef)
          Sets the value of the attribute: targetContainerRef; container object is to be checked in to

Supported API: false
 void setTeamTemplateRef(TeamTemplateReference a_TeamTemplateRef)
          Sets the value of the attribute: teamTemplateRef; reference to team template to be applied to checked-in object

Supported API: false
 void setView(ViewReference a_View)
          Sets the value of the attribute: view; view object is to be assigned to (ignored if object is not ViewManaged)

Supported API: false
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

targetContainerRef

private WTContainerRef targetContainerRef

folder

private Folder folder

teamTemplateRef

private TeamTemplateReference teamTemplateRef

lifeCycleTemplateRef

private LifeCycleTemplateReference lifeCycleTemplateRef

view

private ViewReference view

number

private String number

name

private String name

cadName

private String cadName

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID
See Also:
Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID
See Also:
Constant Field Values
Constructor Detail

InitialCheckinData

public InitialCheckinData()
Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException
Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:
writeExternal in interface Externalizable
Parameters:
output -
Throws:
IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:
readExternal in interface Externalizable
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(InitialCheckinData thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:
thisObject -
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException
Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

getTargetContainerRef

public WTContainerRef getTargetContainerRef()
Gets the value of the attribute: targetContainerRef; container object is to be checked in to

Supported API: false

Returns:
WTContainerRef

setTargetContainerRef

public void setTargetContainerRef(WTContainerRef a_TargetContainerRef)
Sets the value of the attribute: targetContainerRef; container object is to be checked in to

Supported API: false

Parameters:
a_TargetContainerRef -

getFolder

public Folder getFolder()
Gets the value of the attribute: folder; folder checked in object is to be placed in

Supported API: false

Returns:
Folder

setFolder

public void setFolder(Folder a_Folder)
Sets the value of the attribute: folder; folder checked in object is to be placed in

Supported API: false

Parameters:
a_Folder -

getTeamTemplateRef

public TeamTemplateReference getTeamTemplateRef()
Gets the value of the attribute: teamTemplateRef; reference to team template to be applied to checked-in object

Supported API: false

Returns:
TeamTemplateReference

setTeamTemplateRef

public void setTeamTemplateRef(TeamTemplateReference a_TeamTemplateRef)
Sets the value of the attribute: teamTemplateRef; reference to team template to be applied to checked-in object

Supported API: false

Parameters:
a_TeamTemplateRef -

getLifeCycleTemplateRef

public LifeCycleTemplateReference getLifeCycleTemplateRef()
Gets the value of the attribute: lifeCycleTemplateRef; reference to lifecycle template to be applied to checked in object

Supported API: false

Returns:
LifeCycleTemplateReference

setLifeCycleTemplateRef

public void setLifeCycleTemplateRef(LifeCycleTemplateReference a_LifeCycleTemplateRef)
Sets the value of the attribute: lifeCycleTemplateRef; reference to lifecycle template to be applied to checked in object

Supported API: false

Parameters:
a_LifeCycleTemplateRef -

getView

public ViewReference getView()
Gets the value of the attribute: view; view object is to be assigned to (ignored if object is not ViewManaged)

Supported API: false

Returns:
ViewReference

setView

public void setView(ViewReference a_View)
Sets the value of the attribute: view; view object is to be assigned to (ignored if object is not ViewManaged)

Supported API: false

Parameters:
a_View -

getNumber

public String getNumber()
Gets the value of the attribute: number; number to be given to object master

Supported API: false

Returns:
String

setNumber

public void setNumber(String a_Number)
Sets the value of the attribute: number; number to be given to object master

Supported API: false

Parameters:
a_Number -

getName

public String getName()
Gets the value of the attribute: name; name to be given to object master

Supported API: false

Returns:
String

setName

public void setName(String a_Name)
Sets the value of the attribute: name; name to be given to object master

Supported API: false

Parameters:
a_Name -

getCadName

public String getCadName()
Gets the value of the attribute: cadName; CAD name to be given to object master (ignored if master is not an EPMDocumentMaster)

Supported API: false

Returns:
String

setCadName

public void setCadName(String a_CadName)
Sets the value of the attribute: cadName; CAD name to be given to object master (ignored if master is not an EPMDocumentMaster)

Supported API: false

Parameters:
a_CadName -