Primavera Integration API 7.0

com.primavera.integration.client.xml.xmlexporter
Class XMLExporterParams

java.lang.Object
  extended by com.primavera.integration.client.xml.xmlexporter.XMLExporterParams
All Implemented Interfaces:
java.io.Serializable

public class XMLExporterParams
extends java.lang.Object
implements java.io.Serializable

This class represents a parameters object associated with an XMLExporterEvent. You can specify to skip a particular business object type and can also specify the fields to be exported. If no fields are specified or if this parameter object is not modified, the default XML export fields will be used. You can see the list of default XML fields by calling getDefaultXMLExportFields() on each business object class.

See Also:
Serialized Form

Method Summary
 java.lang.String getClassName()
          Gets the name of the business object class about to be exported
 java.lang.String[] getFields()
          Gets the array of fields to be exported for this business object type
 java.util.Set getFieldSet()
          Gets a copy of the fields to be exported for this business object type as a Set.
 boolean isIncluded()
          Reports whether or not this type of business object will be exported
 void setFields(java.util.Set<java.lang.String> fields)
          Sets the array of fields to be exported for this business object type
 void setFields(java.lang.String[] fields)
          Sets the array of fields to be exported for this business object type
 void setIncluded(boolean b)
          Specifies whether to export this type of business object or not.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getClassName

public java.lang.String getClassName()
Gets the name of the business object class about to be exported

Returns:
String the class name

getFields

public java.lang.String[] getFields()
Gets the array of fields to be exported for this business object type

Returns:
String[] the array of field names

getFieldSet

public java.util.Set getFieldSet()
Gets a copy of the fields to be exported for this business object type as a Set. Altering the contents of the returned Set does not affect the fields being exported.

Returns:
String[] the array of field names

setFields

public void setFields(java.lang.String[] fields)
Sets the array of fields to be exported for this business object type

Parameters:
fields - the array of field names

setFields

public void setFields(java.util.Set<java.lang.String> fields)
Sets the array of fields to be exported for this business object type

Parameters:
fields - the set of field names

isIncluded

public boolean isIncluded()
Reports whether or not this type of business object will be exported

Returns:
boolean true if the business object type will be exported

setIncluded

public void setIncluded(boolean b)
Specifies whether to export this type of business object or not. The default is true.

Parameters:
b - true to export, false to skip

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.