wt.viewmarkup
Class PublishingSummary

java.lang.Object
  wt.viewmarkup.PublishingSummary

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, RecentlyVisited, Serializable, WTContained

public class PublishingSummary

extends Object

implements WTContained, Externalizable

Use the newPublishingSummary static factory method(s), not the PublishingSummary constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

static String	AUTHORING_APPLICATION Label for the attribute; Holds the value of getAuthoringApplication().toString() if the object is an EPMDocument, null otherwise.
private static int	AUTHORING_APPLICATION_UPPER_LIMIT
private String	authoringApplication
private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
static long	EXTERNALIZATION_VERSION_UID
static String	JOB_END_TIME Label for the attribute; The time that the job ended.
static String	JOB_REQUEST_QUEUE Label for the attribute; The name of the processing queue that the job was submitted to.
private static int	JOB_REQUEST_QUEUE_UPPER_LIMIT
static String	JOB_REQUEST_SOURCE Label for the attribute; The source of the publish job request.
static String	JOB_REQUEST_TYPE Label for the attribute; The type of publish job request.
static String	JOB_START_TIME Label for the attribute; The time that the job started.
static String	JOB_SUBMIT_TIME Label for the attribute; The time that the job was submitted.
static String	JOB_SUCCESS Label for the attribute; True if the job was successful, false if it failed.
private Timestamp	jobEndTime
private String	jobRequestQueue
private Integer	jobRequestSource
private Integer	jobRequestType
private Timestamp	jobStartTime
private Timestamp	jobSubmitTime
private Boolean	jobSuccess
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo
static String	TYPE_IDENTIFIER Label for the attribute; Holds the String returned from wt.type.TypedUtility.getExternalTypeIdentifier(Object the_instance).
private static int	TYPE_IDENTIFIER_UPPER_LIMIT
private String	typeIdentifier
static String	USER_NAME Label for the attribute; Holds the name of the user who submitted the job.
private static int	USER_NAME_UPPER_LIMIT
private String	userName
static String	WORKER_END_EXEC_TIME Label for the attribute; The time that the worker finished executing.
static String	WORKER_END_TIME Label for the attribute; The time that the worker finished.
static String	WORKER_NAME Label for the attribute; The display name for the worker that processed the request.
private static int	WORKER_NAME_UPPER_LIMIT
static String	WORKER_START_EXEC_TIME Label for the attribute; The time that the worker started executing.
static String	WORKER_START_TIME Label for the attribute; The time that worker started.
static String	WORKER_START_TRANSFER_TIME Label for the attribute; The time that the worker started to transfer.
static String	WORKER_SUCCESS Label for the attribute; True if the worker was successful, false otherwise.
static String	WORKER_TYPE Label for the attribute; The type String of the worker, eg.
private static int	WORKER_TYPE_UPPER_LIMIT
private Timestamp	workerEndExecTime
private Timestamp	workerEndTime
private String	workerName
private Timestamp	workerStartExecTime
private Timestamp	workerStartTime
private Timestamp	workerStartTransferTime
private Boolean	workerSuccess
private String	workerType

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

PublishingSummary()

Method Summary

private void	authoringApplicationValidate(String a_AuthoringApplication)
void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
Timestamp	getJobEndTime() Gets the value of the attribute: JOB_END_TIME.
String	getJobRequestQueue() Gets the value of the attribute: JOB_REQUEST_QUEUE.
Integer	getJobRequestSource() Gets the value of the attribute: JOB_REQUEST_SOURCE.
Integer	getJobRequestType() Gets the value of the attribute: JOB_REQUEST_TYPE.
Timestamp	getJobStartTime() Gets the value of the attribute: JOB_START_TIME.
Timestamp	getJobSubmitTime() Gets the value of the attribute: JOB_SUBMIT_TIME.
Boolean	getJobSuccess() Gets the value of the attribute: JOB_SUCCESS.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
String	getTypeIdentifier() Gets the value of the attribute: TYPE_IDENTIFIER.
String	getUserName() Gets the value of the attribute: USER_NAME.
Timestamp	getWorkerEndExecTime() Gets the value of the attribute: WORKER_END_EXEC_TIME.
Timestamp	getWorkerEndTime() Gets the value of the attribute: WORKER_END_TIME.
String	getWorkerName() Gets the value of the attribute: WORKER_NAME.
Timestamp	getWorkerStartExecTime() Gets the value of the attribute: WORKER_START_EXEC_TIME.
Timestamp	getWorkerStartTime() Gets the value of the attribute: WORKER_START_TIME.
Timestamp	getWorkerStartTransferTime() Gets the value of the attribute: WORKER_START_TRANSFER_TIME.
Boolean	getWorkerSuccess() Gets the value of the attribute: WORKER_SUCCESS.
String	getWorkerType() Gets the value of the attribute: WORKER_TYPE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String a_TypeIdentifier, String a_UserName, String a_AuthoringApplication, Boolean a_JobSuccess, Integer a_JobRequestType, Integer a_JobRequestSource, Timestamp a_JobSubmitTime, Timestamp a_JobStartTime, Timestamp a_JobEndTime) Supports initialization, following construction of an instance.
private void	jobEndTimeValidate(Timestamp a_JobEndTime)
private void	jobRequestQueueValidate(String a_JobRequestQueue)
private void	jobRequestSourceValidate(Integer a_JobRequestSource)
private void	jobRequestTypeValidate(Integer a_JobRequestType)
private void	jobStartTimeValidate(Timestamp a_JobStartTime)
private void	jobSubmitTimeValidate(Timestamp a_JobSubmitTime)
private void	jobSuccessValidate(Boolean a_JobSuccess)
static PublishingSummary	newPublishingSummary(String a_TypeIdentifier, String a_UserName, String a_AuthoringApplication, Boolean a_JobSuccess, Integer a_JobRequestType, Integer a_JobRequestSource, Timestamp a_JobSubmitTime, Timestamp a_JobStartTime, Timestamp a_JobEndTime) Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
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(PublishingSummary thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAuthoringApplication(String a_AuthoringApplication) Sets the value of the attribute: AUTHORING_APPLICATION.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setJobEndTime(Timestamp a_JobEndTime) Sets the value of the attribute: JOB_END_TIME.
void	setJobRequestQueue(String a_JobRequestQueue) Sets the value of the attribute: JOB_REQUEST_QUEUE.
void	setJobRequestSource(Integer a_JobRequestSource) Sets the value of the attribute: JOB_REQUEST_SOURCE.
void	setJobRequestType(Integer a_JobRequestType) Sets the value of the attribute: JOB_REQUEST_TYPE.
void	setJobStartTime(Timestamp a_JobStartTime) Sets the value of the attribute: JOB_START_TIME.
void	setJobSubmitTime(Timestamp a_JobSubmitTime) Sets the value of the attribute: JOB_SUBMIT_TIME.
void	setJobSuccess(Boolean a_JobSuccess) Sets the value of the attribute: JOB_SUCCESS.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setTypeIdentifier(String a_TypeIdentifier) Sets the value of the attribute: TYPE_IDENTIFIER.
void	setUserName(String a_UserName) Sets the value of the attribute: USER_NAME.
void	setWorkerEndExecTime(Timestamp a_WorkerEndExecTime) Sets the value of the attribute: WORKER_END_EXEC_TIME.
void	setWorkerEndTime(Timestamp a_WorkerEndTime) Sets the value of the attribute: WORKER_END_TIME.
void	setWorkerName(String a_WorkerName) Sets the value of the attribute: WORKER_NAME.
void	setWorkerStartExecTime(Timestamp a_WorkerStartExecTime) Sets the value of the attribute: WORKER_START_EXEC_TIME.
void	setWorkerStartTime(Timestamp a_WorkerStartTime) Sets the value of the attribute: WORKER_START_TIME.
void	setWorkerStartTransferTime(Timestamp a_WorkerStartTransferTime) Sets the value of the attribute: WORKER_START_TRANSFER_TIME.
void	setWorkerSuccess(Boolean a_WorkerSuccess) Sets the value of the attribute: WORKER_SUCCESS.
void	setWorkerType(String a_WorkerType) Sets the value of the attribute: WORKER_TYPE.
String	toString() Returns the conceptual (modeled) name for the class.
private void	typeIdentifierValidate(String a_TypeIdentifier)
private void	userNameValidate(String a_UserName)
private void	workerNameValidate(String a_WorkerName)
private void	workerTypeValidate(String a_WorkerType)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

TYPE_IDENTIFIER

public static final String TYPE_IDENTIFIER

Label for the attribute; Holds the String returned from wt.type.TypedUtility.getExternalTypeIdentifier(Object the_instance).

Supported API: false

See Also:

Constant Field Values

TYPE_IDENTIFIER_UPPER_LIMIT

private static int TYPE_IDENTIFIER_UPPER_LIMIT

typeIdentifier

private String typeIdentifier

USER_NAME

public static final String USER_NAME

Label for the attribute; Holds the name of the user who submitted the job.

Supported API: false

See Also:

Constant Field Values

USER_NAME_UPPER_LIMIT

private static int USER_NAME_UPPER_LIMIT

userName

private String userName

AUTHORING_APPLICATION

public static final String AUTHORING_APPLICATION

Label for the attribute; Holds the value of getAuthoringApplication().toString() if the object is an EPMDocument, null otherwise.

Supported API: false

See Also:

Constant Field Values

AUTHORING_APPLICATION_UPPER_LIMIT

private static int AUTHORING_APPLICATION_UPPER_LIMIT

authoringApplication

private String authoringApplication

JOB_SUCCESS

public static final String JOB_SUCCESS

Label for the attribute; True if the job was successful, false if it failed.

Supported API: false

See Also:

Constant Field Values

jobSuccess

private Boolean jobSuccess

JOB_REQUEST_TYPE

public static final String JOB_REQUEST_TYPE

Label for the attribute; The type of publish job request.

Supported API: false

See Also:

Constant Field Values

jobRequestType

private Integer jobRequestType

JOB_REQUEST_SOURCE

public static final String JOB_REQUEST_SOURCE

Label for the attribute; The source of the publish job request.

Supported API: false

See Also:

Constant Field Values

jobRequestSource

private Integer jobRequestSource

JOB_REQUEST_QUEUE

public static final String JOB_REQUEST_QUEUE

Label for the attribute; The name of the processing queue that the job was submitted to.

Supported API: false

See Also:

Constant Field Values

JOB_REQUEST_QUEUE_UPPER_LIMIT

private static int JOB_REQUEST_QUEUE_UPPER_LIMIT

jobRequestQueue

private String jobRequestQueue

JOB_SUBMIT_TIME

public static final String JOB_SUBMIT_TIME

Label for the attribute; The time that the job was submitted.

Supported API: false

See Also:

Constant Field Values

jobSubmitTime

private Timestamp jobSubmitTime

JOB_START_TIME

public static final String JOB_START_TIME

Label for the attribute; The time that the job started.

Supported API: false

See Also:

Constant Field Values

jobStartTime

private Timestamp jobStartTime

JOB_END_TIME

public static final String JOB_END_TIME

Label for the attribute; The time that the job ended.

Supported API: false

See Also:

Constant Field Values

jobEndTime

private Timestamp jobEndTime

WORKER_TYPE

public static final String WORKER_TYPE

Label for the attribute; The type String of the worker, eg. PROE, OFFICE, etc.

Supported API: false

See Also:

Constant Field Values

WORKER_TYPE_UPPER_LIMIT

private static int WORKER_TYPE_UPPER_LIMIT

workerType

private String workerType

WORKER_NAME

public static final String WORKER_NAME

Label for the attribute; The display name for the worker that processed the request.

Supported API: false

See Also:

Constant Field Values

WORKER_NAME_UPPER_LIMIT

private static int WORKER_NAME_UPPER_LIMIT

workerName

private String workerName

WORKER_SUCCESS

public static final String WORKER_SUCCESS

Label for the attribute; True if the worker was successful, false otherwise.

Supported API: false

See Also:

Constant Field Values

workerSuccess

private Boolean workerSuccess

WORKER_START_TIME

public static final String WORKER_START_TIME

Label for the attribute; The time that worker started.

Supported API: false

See Also:

Constant Field Values

workerStartTime

private Timestamp workerStartTime

WORKER_START_TRANSFER_TIME

public static final String WORKER_START_TRANSFER_TIME

Label for the attribute; The time that the worker started to transfer.

Supported API: false

See Also:

Constant Field Values

workerStartTransferTime

private Timestamp workerStartTransferTime

WORKER_START_EXEC_TIME

public static final String WORKER_START_EXEC_TIME

Label for the attribute; The time that the worker started executing.

Supported API: false

See Also:

Constant Field Values

workerStartExecTime

private Timestamp workerStartExecTime

WORKER_END_EXEC_TIME

public static final String WORKER_END_EXEC_TIME

Label for the attribute; The time that the worker finished executing.

Supported API: false

See Also:

Constant Field Values

workerEndExecTime

private Timestamp workerEndExecTime

WORKER_END_TIME

public static final String WORKER_END_TIME

Label for the attribute; The time that the worker finished.

Supported API: false

See Also:

Constant Field Values

workerEndTime

private Timestamp workerEndTime

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

thePersistInfo

private PersistInfo thePersistInfo

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

PublishingSummary

public PublishingSummary()

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(PublishingSummary 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

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getTypeIdentifier

public String getTypeIdentifier()

Gets the value of the attribute: TYPE_IDENTIFIER. Holds the String returned from wt.type.TypedUtility.getExternalTypeIdentifier(Object the_instance).

Supported API: false

Returns:

String

setTypeIdentifier

public void setTypeIdentifier(String a_TypeIdentifier)
                       throws WTPropertyVetoException

Sets the value of the attribute: TYPE_IDENTIFIER. Holds the String returned from wt.type.TypedUtility.getExternalTypeIdentifier(Object the_instance).

Supported API: false

Parameters:

a_TypeIdentifier -

Throws:

WTPropertyVetoException

typeIdentifierValidate

private void typeIdentifierValidate(String a_TypeIdentifier)
                             throws WTPropertyVetoException

Parameters:

a_TypeIdentifier -

Throws:

WTPropertyVetoException

getUserName

public String getUserName()

Gets the value of the attribute: USER_NAME. Holds the name of the user who submitted the job.

Supported API: false

Returns:

String

setUserName

public void setUserName(String a_UserName)
                 throws WTPropertyVetoException

Sets the value of the attribute: USER_NAME. Holds the name of the user who submitted the job.

Supported API: false

Parameters:

a_UserName -

Throws:

WTPropertyVetoException

userNameValidate

private void userNameValidate(String a_UserName)
                       throws WTPropertyVetoException

Parameters:

a_UserName -

Throws:

WTPropertyVetoException

getAuthoringApplication

public String getAuthoringApplication()

Gets the value of the attribute: AUTHORING_APPLICATION. Holds the value of getAuthoringApplication().toString() if the object is an EPMDocument, null otherwise.

Supported API: false

Returns:

String

setAuthoringApplication

public void setAuthoringApplication(String a_AuthoringApplication)
                             throws WTPropertyVetoException

Sets the value of the attribute: AUTHORING_APPLICATION. Holds the value of getAuthoringApplication().toString() if the object is an EPMDocument, null otherwise.

Supported API: false

Parameters:

a_AuthoringApplication -

Throws:

WTPropertyVetoException

authoringApplicationValidate

private void authoringApplicationValidate(String a_AuthoringApplication)
                                   throws WTPropertyVetoException

Parameters:

a_AuthoringApplication -

Throws:

WTPropertyVetoException

getJobSuccess

public Boolean getJobSuccess()

Gets the value of the attribute: JOB_SUCCESS. True if the job was successful, false if it failed.

Supported API: false

Returns:

Boolean

setJobSuccess

public void setJobSuccess(Boolean a_JobSuccess)
                   throws WTPropertyVetoException

Sets the value of the attribute: JOB_SUCCESS. True if the job was successful, false if it failed.

Supported API: false

Parameters:

a_JobSuccess -

Throws:

WTPropertyVetoException

jobSuccessValidate

private void jobSuccessValidate(Boolean a_JobSuccess)
                         throws WTPropertyVetoException

Parameters:

a_JobSuccess -

Throws:

WTPropertyVetoException

getJobRequestType

public Integer getJobRequestType()

Gets the value of the attribute: JOB_REQUEST_TYPE. The type of publish job request.

Supported API: false

Returns:

Integer

setJobRequestType

public void setJobRequestType(Integer a_JobRequestType)
                       throws WTPropertyVetoException

Sets the value of the attribute: JOB_REQUEST_TYPE. The type of publish job request.

Supported API: false

Parameters:

a_JobRequestType -

Throws:

WTPropertyVetoException

jobRequestTypeValidate

private void jobRequestTypeValidate(Integer a_JobRequestType)
                             throws WTPropertyVetoException

Parameters:

a_JobRequestType -

Throws:

WTPropertyVetoException

getJobRequestSource

public Integer getJobRequestSource()

Gets the value of the attribute: JOB_REQUEST_SOURCE. The source of the publish job request.

Supported API: false

Returns:

Integer

setJobRequestSource

public void setJobRequestSource(Integer a_JobRequestSource)
                         throws WTPropertyVetoException

Sets the value of the attribute: JOB_REQUEST_SOURCE. The source of the publish job request.

Supported API: false

Parameters:

a_JobRequestSource -

Throws:

WTPropertyVetoException

jobRequestSourceValidate

private void jobRequestSourceValidate(Integer a_JobRequestSource)
                               throws WTPropertyVetoException

Parameters:

a_JobRequestSource -

Throws:

WTPropertyVetoException

getJobRequestQueue

public String getJobRequestQueue()

Gets the value of the attribute: JOB_REQUEST_QUEUE. The name of the processing queue that the job was submitted to.

Supported API: false

Returns:

String

setJobRequestQueue

public void setJobRequestQueue(String a_JobRequestQueue)
                        throws WTPropertyVetoException

Sets the value of the attribute: JOB_REQUEST_QUEUE. The name of the processing queue that the job was submitted to.

Supported API: false

Parameters:

a_JobRequestQueue -

Throws:

WTPropertyVetoException

jobRequestQueueValidate

private void jobRequestQueueValidate(String a_JobRequestQueue)
                              throws WTPropertyVetoException

Parameters:

a_JobRequestQueue -

Throws:

WTPropertyVetoException

getJobSubmitTime

public Timestamp getJobSubmitTime()

Gets the value of the attribute: JOB_SUBMIT_TIME. The time that the job was submitted.

Supported API: false

Returns:

Timestamp

setJobSubmitTime

public void setJobSubmitTime(Timestamp a_JobSubmitTime)
                      throws WTPropertyVetoException

Sets the value of the attribute: JOB_SUBMIT_TIME. The time that the job was submitted.

Supported API: false

Parameters:

a_JobSubmitTime -

Throws:

WTPropertyVetoException

jobSubmitTimeValidate

private void jobSubmitTimeValidate(Timestamp a_JobSubmitTime)
                            throws WTPropertyVetoException

Parameters:

a_JobSubmitTime -

Throws:

WTPropertyVetoException

getJobStartTime

public Timestamp getJobStartTime()

Gets the value of the attribute: JOB_START_TIME. The time that the job started.

Supported API: false

Returns:

Timestamp

setJobStartTime

public void setJobStartTime(Timestamp a_JobStartTime)
                     throws WTPropertyVetoException

Sets the value of the attribute: JOB_START_TIME. The time that the job started.

Supported API: false

Parameters:

a_JobStartTime -

Throws:

WTPropertyVetoException

jobStartTimeValidate

private void jobStartTimeValidate(Timestamp a_JobStartTime)
                           throws WTPropertyVetoException

Parameters:

a_JobStartTime -

Throws:

WTPropertyVetoException

getJobEndTime

public Timestamp getJobEndTime()

Gets the value of the attribute: JOB_END_TIME. The time that the job ended.

Supported API: false

Returns:

Timestamp

setJobEndTime

public void setJobEndTime(Timestamp a_JobEndTime)
                   throws WTPropertyVetoException

Sets the value of the attribute: JOB_END_TIME. The time that the job ended.

Supported API: false

Parameters:

a_JobEndTime -

Throws:

WTPropertyVetoException

jobEndTimeValidate

private void jobEndTimeValidate(Timestamp a_JobEndTime)
                         throws WTPropertyVetoException

Parameters:

a_JobEndTime -

Throws:

WTPropertyVetoException

getWorkerType

public String getWorkerType()

Gets the value of the attribute: WORKER_TYPE. The type String of the worker, eg. PROE, OFFICE, etc.

Supported API: false

Returns:

String

setWorkerType

public void setWorkerType(String a_WorkerType)
                   throws WTPropertyVetoException

Sets the value of the attribute: WORKER_TYPE. The type String of the worker, eg. PROE, OFFICE, etc.

Supported API: false

Parameters:

a_WorkerType -

Throws:

WTPropertyVetoException

workerTypeValidate

private void workerTypeValidate(String a_WorkerType)
                         throws WTPropertyVetoException

Parameters:

a_WorkerType -

Throws:

WTPropertyVetoException

getWorkerName

public String getWorkerName()

Gets the value of the attribute: WORKER_NAME. The display name for the worker that processed the request.

Supported API: false

Returns:

String

setWorkerName

public void setWorkerName(String a_WorkerName)
                   throws WTPropertyVetoException

Sets the value of the attribute: WORKER_NAME. The display name for the worker that processed the request.

Supported API: false

Parameters:

a_WorkerName -

Throws:

WTPropertyVetoException

workerNameValidate

private void workerNameValidate(String a_WorkerName)
                         throws WTPropertyVetoException

Parameters:

a_WorkerName -

Throws:

WTPropertyVetoException

getWorkerSuccess

public Boolean getWorkerSuccess()

Gets the value of the attribute: WORKER_SUCCESS. True if the worker was successful, false otherwise.

Supported API: false

Returns:

Boolean

setWorkerSuccess

public void setWorkerSuccess(Boolean a_WorkerSuccess)
                      throws WTPropertyVetoException

Sets the value of the attribute: WORKER_SUCCESS. True if the worker was successful, false otherwise.

Supported API: false

Parameters:

a_WorkerSuccess -

Throws:

WTPropertyVetoException

getWorkerStartTime

public Timestamp getWorkerStartTime()

Gets the value of the attribute: WORKER_START_TIME. The time that worker started.

Supported API: false

Returns:

Timestamp

setWorkerStartTime

public void setWorkerStartTime(Timestamp a_WorkerStartTime)
                        throws WTPropertyVetoException

Sets the value of the attribute: WORKER_START_TIME. The time that worker started.

Supported API: false

Parameters:

a_WorkerStartTime -

Throws:

WTPropertyVetoException

getWorkerStartTransferTime

public Timestamp getWorkerStartTransferTime()

Gets the value of the attribute: WORKER_START_TRANSFER_TIME. The time that the worker started to transfer.

Supported API: false

Returns:

Timestamp

setWorkerStartTransferTime

public void setWorkerStartTransferTime(Timestamp a_WorkerStartTransferTime)
                                throws WTPropertyVetoException

Sets the value of the attribute: WORKER_START_TRANSFER_TIME. The time that the worker started to transfer.

Supported API: false

Parameters:

a_WorkerStartTransferTime -

Throws:

WTPropertyVetoException

getWorkerStartExecTime

public Timestamp getWorkerStartExecTime()

Gets the value of the attribute: WORKER_START_EXEC_TIME. The time that the worker started executing.

Supported API: false

Returns:

Timestamp

setWorkerStartExecTime

public void setWorkerStartExecTime(Timestamp a_WorkerStartExecTime)
                            throws WTPropertyVetoException

Sets the value of the attribute: WORKER_START_EXEC_TIME. The time that the worker started executing.

Supported API: false

Parameters:

a_WorkerStartExecTime -

Throws:

WTPropertyVetoException

getWorkerEndExecTime

public Timestamp getWorkerEndExecTime()

Gets the value of the attribute: WORKER_END_EXEC_TIME. The time that the worker finished executing.

Supported API: false

Returns:

Timestamp

setWorkerEndExecTime

public void setWorkerEndExecTime(Timestamp a_WorkerEndExecTime)
                          throws WTPropertyVetoException

Sets the value of the attribute: WORKER_END_EXEC_TIME. The time that the worker finished executing.

Supported API: false

Parameters:

a_WorkerEndExecTime -

Throws:

WTPropertyVetoException

getWorkerEndTime

public Timestamp getWorkerEndTime()

Gets the value of the attribute: WORKER_END_TIME. The time that the worker finished.

Supported API: false

Returns:

Timestamp

setWorkerEndTime

public void setWorkerEndTime(Timestamp a_WorkerEndTime)
                      throws WTPropertyVetoException

Sets the value of the attribute: WORKER_END_TIME. The time that the worker finished.

Supported API: false

Parameters:

a_WorkerEndTime -

Throws:

WTPropertyVetoException

newPublishingSummary

public static PublishingSummary newPublishingSummary(String a_TypeIdentifier,
                                                     String a_UserName,
                                                     String a_AuthoringApplication,
                                                     Boolean a_JobSuccess,
                                                     Integer a_JobRequestType,
                                                     Integer a_JobRequestSource,
                                                     Timestamp a_JobSubmitTime,
                                                     Timestamp a_JobStartTime,
                                                     Timestamp a_JobEndTime)
                                              throws WTException

Supported API: false

Parameters:

a_TypeIdentifier -

a_UserName -

a_AuthoringApplication -

a_JobSuccess -

a_JobRequestType -

a_JobRequestSource -

a_JobSubmitTime -

a_JobStartTime -

a_JobEndTime -

Returns:

PublishingSummary

Throws:

WTException

initialize

protected void initialize(String a_TypeIdentifier,
                          String a_UserName,
                          String a_AuthoringApplication,
                          Boolean a_JobSuccess,
                          Integer a_JobRequestType,
                          Integer a_JobRequestSource,
                          Timestamp a_JobSubmitTime,
                          Timestamp a_JobStartTime,
                          Timestamp a_JobEndTime)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

a_TypeIdentifier -

a_UserName -

a_AuthoringApplication -

a_JobSuccess -

a_JobRequestType -

a_JobRequestSource -

a_JobSubmitTime -

a_JobStartTime -

a_JobEndTime -

Throws:

WTException

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

getContainer

public WTContainer getContainer()

Gets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

getContainer in interface WTContained

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

Sets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

setContainer in interface WTContained

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContained

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContained

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

Gets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

Sets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Returns:

int