Package com.ptc.windchill.mpml.nc

Class NCFileLog

java.lang.Object

com.ptc.windchill.mpml.nc.NCFileLog

public class NCFileLog
extends Object

This class represents a log created for the sake of informing the user of the NC/XML file import. An instance of this class may be created at several stages of the import, and during the import and operation creation, all important messages are logged in this class. When the import is over, the messages logged are bundled into a text, which is sent back to the client for display to the user.

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
void	add(NCFileLog iLog)	Add all entries from an existing log to this log.
void	addEntry(String iObjectName, String identity, MPMLinkServerHelper.GenerateFromNCXMLStatusCode iStatus, String iComments)	Add an entry to the log.

Methods inherited from class java.lang.Object

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

Method Details

addEntry

public void addEntry(String iObjectName,
 String identity,
 MPMLinkServerHelper.GenerateFromNCXMLStatusCode iStatus,
 String iComments)

Add an entry to the log. The purpose of this call is to log: (1) the object name for which the log is created; (2) a global status for the import (SUCCESS, WARNING, FAILURE); (3) a detailed description of the status.

Supported API: true

Parameters:

iObjectName - The name of the object described in this entry.

identity - The identity of the object described in this entry.

iStatus - The global status of the import for the object.

iComments - The detailed description of the status. This parameter is a collection, so more than one description line may be passed. N.B. The comments inserted here should use the client's locale, not the server's.

add

public void add(NCFileLog iLog)

Add all entries from an existing log to this log.

Supported API: true

Parameters:

iLog - The log to concatenate.