java.lang.Object
com.primavera.integration.client.xml.xmlexporter.XMLExporter

public class XMLExporter extends Object

The XML Exporter will export collections of any type of business object to XML according to a flat schema (p6apibo.xsd).

Every business object can be exported, by specifying a where clause to use for loading the objects. When objects are exported, the fields to be exported can be specified. If the fields parameter is null, the business object's set of writable and minimum fields will be exported by default.

Business objects that support spreads (EPS, Project, WBS, Activity, ResourceAssignment) can be exported with spread data using the special methods provided. Note that spread fields must be specified as there are no default spread fields.

In addition to the XML support in the XMLExporter, individual business objects can write themselves to XML using toString(), which adheres to the same flat XML schema (p6apibo.xsd) used by this XML Exporter.

The exportFullProject() methods are used to export a project and all related data. The XML file can then be imported using the flat XMLImporter. The CreateNewProject and UpdateExistingProject operations of the P6 Web Services' Import service can also read XML attachments that conform to this schema. Note that Documents are exported but may not be imported.

The default encoding is UTF-8. You can change this encoding using the setEncoding() method.

  • Constructor Details

    • XMLExporter

      public XMLExporter(Session session)
      Construct an XMLExporter.
      Parameters:
      session - the session object
  • Method Details

    • getSpacing

      public String getSpacing()
      Gets the spacing for indentation in the XML file. By default a tab character is used.
      Returns:
      the String to be prepended for each indentation
    • setSpacing

      public void setSpacing(String sSpacing)
      Sets the spacing for indentation in the XML file. By default a tab character is used. The spacing can be set to an empty string to generate smaller XML files.
      Parameters:
      sSpacing - a String to be prepended for each indentation
    • isIpmdarExport

      public boolean isIpmdarExport()
      Indicates this export is for IPMDAR
      Returns:
      the String
    • setIpmdarExport

      public void setIpmdarExport(boolean isIpmDar)
      Sets this export for IPMDAR
      Parameters:
      String - returns the uncefact flag
    • isCPP

      public boolean isCPP()
    • setCPP

      public void setCPP(boolean isCPP)
    • isUncefactExport

      public boolean isUncefactExport()
      Indicates this export is for uncefact
      Returns:
      the String
    • setUncefactExport

      public void setUncefactExport(boolean isUncefact)
      Sets this export for uncefact
      Parameters:
      String - returns the uncefact flag
    • isUnifierExport

      public boolean isUnifierExport()
      Indicates this export is for unifier
      Returns:
      boolean
    • setUnifierExport

      public void setUnifierExport(boolean isUnifier)
      Sets this export for unifier
    • isCBSAssignedOnlyFlag

      public boolean isCBSAssignedOnlyFlag()
      Indicates only cbs assigned activites to be exported for unifier
      Returns:
      boolean
    • setCBSAssignedOnlyFlag

      public void setCBSAssignedOnlyFlag(boolean isCBSAssignedOnlyFlag)
      Indicates only cbs assigned activites to be exported for unifier
    • getEncoding

      public String getEncoding()
      Gets the encoding for the XML output. The default is "UTF-8".
      Returns:
      the String the encoding to use for output
    • setEncoding

      public void setEncoding(String sEncoding) throws UnsupportedEncodingException
      Sets the encoding for the XML output. The default is "UTF-8".
      Parameters:
      sEncoding - the encoding to use for output
      Throws:
      UnsupportedEncodingException - if the encoding value is not supported
    • getLineSeparator

      public String getLineSeparator()
      Gets the line separator string that is appended to every line in the XML output. The default is the value of the "line.separator" System property.
      Returns:
      the String to be appended to every line of output
    • setLineSeparator

      public void setLineSeparator(String sSeparator)
      Sets the line separator string that is appended to every line in the XML output. The default is the value of the "line.separator" System property.
      Parameters:
      sSeparator - the String to be appended to every line of output
    • getTaskUIDMap

      public Map<Integer,Integer> getTaskUIDMap()
    • setTaskUIDMap

      public void setTaskUIDMap(Map<Integer,Integer> m_taskUIDMap)
    • exportFullProject

      public void exportFullProject(OutputStream os, ObjectId projectId, String[] fields, XMLExporterListener listener) throws ServerException, NetworkException, BusinessObjectException, XMLExporterException
      Fully export a specific project. Child objects of the project are exported as well: activities, calendars, etc. An optional XMLExporterListener can be specified, which will receive notification of all XMLExporterEvents. This allows you to specify the fields to be exported, and also allows you to specify whether particular child classes should be exported.
      Parameters:
      os - the OutputStream to receive all generated XML output
      projectId - the ObjectId of the project to export
      fields - the Project fields to export. If null, all fields are exported.
      listener - an optional XMLExporterListener that will receive notification of all XMLExporterEvents
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
      XMLExporterException
    • exportFullProject

      public void exportFullProject(OutputStream os, ObjectId projectId, String[] fields, XMLExporterListener listener, SpreadPeriodType periodType, ObjectId mspUdfTypeId) throws ServerException, NetworkException, BusinessObjectException, XMLExporterException
      Fully export a specific project with future bucket planning spreads. Child objects of the project are exported as well: activities, calendars, etc. An optional XMLExporterListener can be specified, which will receive notification of all XMLExporterEvents. This allows you to specify the fields to be exported, and also allows you to specify whether particular child classes should be exported.
      Parameters:
      os - the OutputStream to receive all generated XML output
      projectId - the ObjectId of the project to export
      fields - the Project fields to export. If null, all fields are exported.
      listener - an optional XMLExporterListener that will receive notification of all XMLExporterEvents
      periodType - the ResourceAssignmentSpread period type to export. If the exported XML will be imported again, it is recommended to use a period such as weekly or monthly due to performance reasons. If this parameter is null, no future bucket planning spreads will be exported with the project, but raw curve values will still appear on resource assignments where applicable. Hourly periods are not supported.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
      IllegalArgumentException - if the project ObjectId parameter was null or an unsupported spread period type was specified
      XMLExporterException
    • exportFullProjects

      public void exportFullProjects(OutputStream os, List<ObjectId> projectObjectIdList, String[] fields, XMLExporterListener listener) throws BusinessObjectException, XMLExporterException, ServerException, NetworkException
      Fully export a set of projects. Child objects of the project are exported as well: activities, calendars, etc. An optional XMLExporterListener can be specified, which will receive notification of all XMLExporterEvents. This allows you to specify the fields to be exported, and also allows you to specify whether particular child classes should be exported.
      Parameters:
      os - the OutputStream to receive all generated XML output
      projectObjectIdList - the Set of ObjectIds of all the projects to export
      fields - the Project fields to export. If null, all fields are exported.
      listener - an optional XMLExporterListener that will receive notification of all XMLExporterEvents
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
      XMLExporterException
    • exportFullProjects

      public void exportFullProjects(OutputStream os, List<ObjectId> projectObjectIdList, String[] fields, XMLExporterListener listener, SpreadPeriodType periodType, ObjectId mspUdfTypeId) throws BusinessObjectException, XMLExporterException, ServerException, NetworkException
      Fully export a specific project with future bucket planning spreads. Child objects of the project are exported as well: activities, calendars, etc. An optional XMLExporterListener can be specified, which will receive notification of all XMLExporterEvents. This allows you to specify the fields to be exported, and also allows you to specify whether particular child classes should be exported.
      Parameters:
      os - the OutputStream to receive all generated XML output
      projectObjectIdList - the Set of ObjectIds of all the projects to export
      fields - the Project fields to export. If null, all fields are exported.
      listener - an optional XMLExporterListener that will receive notification of all XMLExporterEvents
      periodType - the ResourceAssignmentSpread period type to export. If the exported XML will be imported again, it is recommended to use a period such as weekly or monthly due to performance reasons. If this parameter is null, no future bucket planning spreads will be exported with the project, but raw curve values will still appear on resource assignments where applicable. Hourly periods are not supported.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
      IllegalArgumentException - if the project ObjectId parameter was null or an unsupported spread period type was specified
      XMLExporterException
    • exportFullProjects

      public void exportFullProjects(OutputStream os, List<ObjectId> projectObjectIdList, String[] fields, XMLExporterListener listener, SpreadPeriodType periodType) throws BusinessObjectException, XMLExporterException, ServerException, NetworkException
      Fully export a specific project with future bucket planning spreads. Child objects of the project are exported as well: activities, calendars, etc. An optional XMLExporterListener can be specified, which will receive notification of all XMLExporterEvents. This allows you to specify the fields to be exported, and also allows you to specify whether particular child classes should be exported.
      Parameters:
      os - the OutputStream to receive all generated XML output
      projectObjectIdList - the Set of ObjectIds of all the projects to export
      fields - the Project fields to export. If null, all fields are exported.
      listener - an optional XMLExporterListener that will receive notification of all XMLExporterEvents
      periodType - the ResourceAssignmentSpread period type to export. If the exported XML will be imported again, it is recommended to use a period such as weekly or monthly due to performance reasons. If this parameter is null, no future bucket planning spreads will be exported with the project, but raw curve values will still appear on resource assignments where applicable. Hourly periods are not supported.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
      IllegalArgumentException - if the project ObjectId parameter was null or an unsupported spread period type was specified
      XMLExporterException
    • exportFullProjectToMSPXml

      public void exportFullProjectToMSPXml(OutputStream os, ObjectId projectId, String[] fields, XMLExporterListener listener, SpreadPeriodType periodType, ObjectId mspUdfTypeId, Map<Object,Object> propMap, Logger logger) throws ServerException, NetworkException, BusinessObjectException, XMLExporterException
      Fully export a specific project in MSP XML format. Child objects of the project are exported as well: activities, calendars, etc.
      Parameters:
      os - the OutputStream to receive all generated MSP XML output
      projectId - id of the project to export
      fields - the Project fields to export. If null, all fields are exported.
      listener - an optional XMLExporterListener that will receive notification of all XMLExporterEvents
      periodType - the ResourceAssignmentSpread period type to export. If the exported XML will be imported again, it is recommended to use a period such as weekly or monthly due to performance reasons. If this parameter is null, no future bucket planning spreads will be exported with the project, but raw curve values will still appear on resource assignments where applicable. Hourly periods are not supported.
      mspUdfTypeId - MSP udftype id
      propMap - property map
      logger - the logger to log messages on msp xml export
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
      XMLExporterException
      IllegalArgumentException - if the project ObjectId parameter was null or an unsupported spread period type was specified
    • exportActivities

      public void exportActivities(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activities.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activities returned
      sOrderBy - an optional order by clause for ordering the set of activities returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityUpdates

      public void exportActivityUpdates(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity updates.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity updates returned
      sOrderBy - an optional order by clause for ordering the set of activity updates returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivitiesWithLiveSpread

      public void exportActivitiesWithLiveSpread(OutputStream os, Project parent, String[] fields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activities for a particular project with live spread data.
      Parameters:
      os - the OutputStream to receive all generated XML output
      parent - the parent project
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activities returned
      sOrderBy - an optional order by clause for ordering the set of activities returned
      spreadFields - the fields to include in the spread object
      periodType - the period of the spread data (hour, day, etc.)
      startDate - the start date of the spread
      endDate - the end date of the spread
      bIncludeCumulative - indicates whether to include cumulative spread data
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityCodeAssignments

      public void exportActivityCodeAssignments(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity code assignments.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity code assignments returned
      sOrderBy - an optional order by clause for ordering the set of activity code assignments returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityCodes

      public void exportActivityCodes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity codes.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity codes returned
      sOrderBy - an optional order by clause for ordering the set of activity codes returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityCodeTypes

      public void exportActivityCodeTypes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity code types.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity code types returned
      sOrderBy - an optional order by clause for ordering the set of activity code types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityExpenses

      public void exportActivityExpenses(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity expenses.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity expenses returned
      sOrderBy - an optional order by clause for ordering the set of activity expenses returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityNotes

      public void exportActivityNotes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity notes.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity notes returned
      sOrderBy - an optional order by clause for ordering the set of activity notes returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityOwners

      public void exportActivityOwners(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity owners.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity owners returned
      sOrderBy - an optional order by clause for ordering the set of activity owners returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityPeriodActuals

      public void exportActivityPeriodActuals(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity period actuals.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity period actuals returned
      sOrderBy - an optional order by clause for ordering the set of activity period actuals returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityRisks

      public void exportActivityRisks(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity risks.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity steps returned
      sOrderBy - an optional order by clause for ordering the set of activity steps returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivitySteps

      public void exportActivitySteps(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity steps.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity steps returned
      sOrderBy - an optional order by clause for ordering the set of activity steps returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityStepTemplates

      public void exportActivityStepTemplates(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity step templates.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity step templates returned
      sOrderBy - an optional order by clause for ordering the set of activity step templates returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityStepTemplateItems

      public void exportActivityStepTemplateItems(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity step template items.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity step template items returned
      sOrderBy - an optional order by clause for ordering the set of activity step template items returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportActivityStepUpdates

      public void exportActivityStepUpdates(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of activity step updates.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of activity step updates returned
      sOrderBy - an optional order by clause for ordering the set of activity step updates returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportBaselineProjects

      public void exportBaselineProjects(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Deprecated.
      Export a collection of baseline projects.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of baseline projects returned
      sOrderBy - an optional order by clause for ordering the set of baseline projects returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportBaselineProject

      public void exportBaselineProject(OutputStream os, ObjectId projectId, String[] fields, XMLExporterListener listener) throws ServerException, NetworkException, BusinessObjectException, XMLExporterException
      Export a collection of baseline projects.
      Parameters:
      os - the OutputStream to receive all generated XML output
      Baseline - Project Id. Baseline id should be followed by its project id.
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of baseline projects returned
      sOrderBy - an optional order by clause for ordering the set of baseline projects returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
      XMLExporterException
    • exportBaselineProjects

      public void exportBaselineProjects(OutputStream os, List<ObjectId> projectIds, String[] fields, XMLExporterListener listener) throws ServerException, NetworkException, BusinessObjectException, XMLExporterException
      Export a collection of baseline projects.
      Parameters:
      os - the OutputStream to receive all generated XML output
      Baseline - Project Ids. Baseline ids should be followed by their corresponding project ids.
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of baseline projects returned
      sOrderBy - an optional order by clause for ordering the set of baseline projects returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
      XMLExporterException
    • exportBaselineTypes

      public void exportBaselineTypes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of baseline types.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of baseline types returned
      sOrderBy - an optional order by clause for ordering the set of baseline types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectBudgetChangeLogs

      public void exportProjectBudgetChangeLogs(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of budget change logs.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of budget change logs returned
      sOrderBy - an optional order by clause for ordering the set of budget change logs returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportCalendars

      public void exportCalendars(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of calendars.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of calendars returned
      sOrderBy - an optional order by clause for ordering the set of calendars returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportChangeSets

      public void exportChangeSets(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of change sets.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of change sets returned
      sOrderBy - an optional order by clause for ordering the set of change sets returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportCostAccounts

      public void exportCostAccounts(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of cost accounts.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of cost accounts returned
      sOrderBy - an optional order by clause for ordering the set of cost accounts returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportCurrencies

      public void exportCurrencies(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of currencies.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of currencies returned
      sOrderBy - an optional order by clause for ordering the set of currencies returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportDocuments

      public void exportDocuments(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of documents.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of document objects returned
      sOrderBy - an optional order by clause for ordering the set of document objects returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportDocumentStatusCodes

      public void exportDocumentStatusCodes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of document status codes.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of document status code objects returned
      sOrderBy - an optional order by clause for ordering the set of document status code objects returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportDocumentCategories

      public void exportDocumentCategories(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of document categories.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of document categories returned
      sOrderBy - an optional order by clause for ordering the set of document categories returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportEPS

      public void exportEPS(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of EPS objects.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of EPS objects returned
      sOrderBy - an optional order by clause for ordering the set of EPS objects returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportEPSWithSummarizedSpread

      public void exportEPSWithSummarizedSpread(OutputStream os, String[] fields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of EPS objects with summarized spread data.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of EPS objects returned
      sOrderBy - an optional order by clause for ordering the set of EPS objects returned
      spreadFields - the fields to include in the spread object
      periodType - the period of the spread data (hour, day, etc.)
      startDate - the start date of the spread
      endDate - the end date of the spread
      bIncludeCumulative - indicates whether to include cumulative spread data
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportEPSBudgetChangeLogs

      public void exportEPSBudgetChangeLogs(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of EPS budget change logs.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of EPS budget change logs returned
      sOrderBy - an optional order by clause for ordering the set of EPS budget change logs returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportEPSFundings

      public void exportEPSFundings(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of EPS fundings.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of EPS fundings returned
      sOrderBy - an optional order by clause for ordering the set of EPS fundings returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportEPSNotes

      public void exportEPSNotes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of EPS notes.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of EPS notes returned
      sOrderBy - an optional order by clause for ordering the set of EPS notes returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportEPSSpendingPlans

      public void exportEPSSpendingPlans(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of EPS spending plans.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of EPS spending plans returned
      sOrderBy - an optional order by clause for ordering the set of EPS spending plans returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportExpenseCategories

      public void exportExpenseCategories(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of expense categories.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of expense categories returned
      sOrderBy - an optional order by clause for ordering the set of expense categories returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportFinancialPeriods

      public void exportFinancialPeriods(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of financial periods.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of financial periods returned
      sOrderBy - an optional order by clause for ordering the set of financial periods returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportFundingSources

      public void exportFundingSources(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of funding sources.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of funding sources returned
      sOrderBy - an optional order by clause for ordering the set of funding sources returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportGlobalPreferences

      public void exportGlobalPreferences(OutputStream os, String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Export the global preferences.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportGlobalProfiles

      public void exportGlobalProfiles(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of global profiles.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of global profiles returned
      sOrderBy - an optional order by clause for ordering the set of global profiles returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportIssueHistories

      public void exportIssueHistories(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of issue histories.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of issue histories returned
      sOrderBy - an optional order by clause for ordering the set of issue histories returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportLocations

      public void exportLocations(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of locations.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of change sets returned
      sOrderBy - an optional order by clause for ordering the set of change sets returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportNotebookTopics

      public void exportNotebookTopics(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of notebook topics.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of notebook topics returned
      sOrderBy - an optional order by clause for ordering the set of notebook topics returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportOBS

      public void exportOBS(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of OBS objects.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of OBS objects returned
      sOrderBy - an optional order by clause for ordering the set of OBS objects returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportOverheadCodes

      public void exportOverheadCodes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of overhead codes.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of overhead codes returned
      sOrderBy - an optional order by clause for ordering the set of overhead codes returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjects

      public void exportProjects(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of projects. Note that this method only exports project-level data. To export a project with related objects, use the exportFullProject.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of projects returned
      sOrderBy - an optional order by clause for ordering the set of projects returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectsWithSummarizedSpread

      public void exportProjectsWithSummarizedSpread(OutputStream os, String[] fields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of projects with summarized spread data. Note that this method only exports project-level data. To export a project with related objects, use the exportFullProject.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of projects returned
      sOrderBy - an optional order by clause for ordering the set of projects returned
      spreadFields - the fields to include in the spread object
      periodType - the period of the spread data (hour, day, etc.)
      startDate - the start date of the spread
      endDate - the end date of the spread
      bIncludeCumulative - indicates whether to include cumulative spread data
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectCodeAssignments

      public void exportProjectCodeAssignments(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project code assignments.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project code assignments returned
      sOrderBy - an optional order by clause for ordering the set of project code assignments returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectCodes

      public void exportProjectCodes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project codes code type.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project codes returned
      sOrderBy - an optional order by clause for ordering the set of project codes returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectCodeTypes

      public void exportProjectCodeTypes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project code types.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project code types returned
      sOrderBy - an optional order by clause for ordering the set of project code types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectDocuments

      public void exportProjectDocuments(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project documents.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project documents returned
      sOrderBy - an optional order by clause for ordering the set of project documents returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectFundings

      public void exportProjectFundings(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project fundings.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project fundings returned
      sOrderBy - an optional order by clause for ordering the set of project fundings returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectIssues

      public void exportProjectIssues(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project issues.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project issues returned
      sOrderBy - an optional order by clause for ordering the set of project issues returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectNotes

      public void exportProjectNotes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project notes.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project notes returned
      sOrderBy - an optional order by clause for ordering the set of project notes returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectPortfolios

      public void exportProjectPortfolios(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project portfolios.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project portfolios returned
      sOrderBy - an optional order by clause for ordering the set of project portfolios returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectProfiles

      public void exportProjectProfiles(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project profiles.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project profiles returned
      sOrderBy - an optional order by clause for ordering the set of project profiles returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectResources

      public void exportProjectResources(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project resources.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project resources returned
      sOrderBy - an optional order by clause for ordering the set of project resources returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectResourceCategories

      public void exportProjectResourceCategories(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project resource categories.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project resource categories returned
      sOrderBy - an optional order by clause for ordering the set of project resource categories returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectResourceQuantities

      public void exportProjectResourceQuantities(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project resource quantities.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project resource quantities returned
      sOrderBy - an optional order by clause for ordering the set of project resource quantities returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectSpendingPlans

      public void exportProjectSpendingPlans(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project spending plans.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project spending plans returned
      sOrderBy - an optional order by clause for ordering the set of project spending plans returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportProjectThresholds

      public void exportProjectThresholds(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of project thresholds.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of project thresholds returned
      sOrderBy - an optional order by clause for ordering the set of project thresholds returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRelationships

      public void exportRelationships(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of relationships.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of relationships returned
      sOrderBy - an optional order by clause for ordering the set of relationships returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResources

      public void exportResources(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resources.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resources returned
      sOrderBy - an optional order by clause for ordering the set of resources returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceAccess

      public void exportResourceAccess(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource access objects.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource access objects returned
      sOrderBy - an optional order by clause for ordering the set of resource access objects returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceAssignmentPeriodActuals

      public void exportResourceAssignmentPeriodActuals(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource assignment period actuals.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource assignment period actuals returned
      sOrderBy - an optional order by clause for ordering the set of resource assignment period actuals returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceAssignments

      public void exportResourceAssignments(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource assignments.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource assignments returned
      sOrderBy - an optional order by clause for ordering the set of resource assignments returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceAssignmentUpdates

      public void exportResourceAssignmentUpdates(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource assignment updates.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource assignment updates returned
      sOrderBy - an optional order by clause for ordering the set of resource assignment updates returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceAssignmentsWithLiveSpread

      public void exportResourceAssignmentsWithLiveSpread(OutputStream os, Project parent, String[] fields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource assignments for a particular project with live spread data.
      Parameters:
      os - the OutputStream to receive all generated XML output
      parent - the parent project
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource assignments returned
      sOrderBy - an optional order by clause for ordering the set of resource assignments returned
      spreadFields - the fields to include in the spread object
      periodType - the period of the spread data (hour, day, etc.)
      startDate - the start date of the spread
      endDate - the end date of the spread
      bIncludeCumulative - indicates whether to include cumulative spread data
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceAssignmentsWithLiveSpread

      public void exportResourceAssignmentsWithLiveSpread(OutputStream os, Resource parent, String[] fields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource assignments for a particular resource with live spread data.
      Parameters:
      os - the OutputStream to receive all generated XML output
      parent - the parent resource
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource assignments returned
      sOrderBy - an optional order by clause for ordering the set of resource assignments returned
      spreadFields - the fields to include in the spread object
      periodType - the period of the spread data (hour, day, etc.)
      startDate - the start date of the spread
      endDate - the end date of the spread
      bIncludeCumulative - indicates whether to include cumulative spread data
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceCodeAssignments

      public void exportResourceCodeAssignments(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource code assignments.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource code assignments returned
      sOrderBy - an optional order by clause for ordering the set of resource code assignments returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceCodes

      public void exportResourceCodes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource codes.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource codes returned
      sOrderBy - an optional order by clause for ordering the set of resource codes returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceCodeTypes

      public void exportResourceCodeTypes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource code types.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource code types returned
      sOrderBy - an optional order by clause for ordering the set of resource code types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceCurves

      public void exportResourceCurves(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource curves.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource curves returned
      sOrderBy - an optional order by clause for ordering the set of resource curves returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceLocations

      public void exportResourceLocations(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource locations.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of change sets returned
      sOrderBy - an optional order by clause for ordering the set of change sets returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceRates

      public void exportResourceRates(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource rates.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource rates returned
      sOrderBy - an optional order by clause for ordering the set of resource rates returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceRoles

      public void exportResourceRoles(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource roles.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource roles returned
      sOrderBy - an optional order by clause for ordering the set of resource roles returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportResourceTeams

      public void exportResourceTeams(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of resource teams.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of resource teams returned
      sOrderBy - an optional order by clause for ordering the set of resource teams returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRiskCategories

      public void exportRiskCategories(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of risk categories.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of risk types returned
      sOrderBy - an optional order by clause for ordering the set of risk types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRiskThresholds

      public void exportRiskThresholds(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of risk thresholds.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of risk types returned
      sOrderBy - an optional order by clause for ordering the set of risk types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRiskThresholdLevels

      public void exportRiskThresholdLevels(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of risk threshold levels.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of risk types returned
      sOrderBy - an optional order by clause for ordering the set of risk types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRiskMatrices

      public void exportRiskMatrices(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of risk matrices.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of risk types returned
      sOrderBy - an optional order by clause for ordering the set of risk types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRiskMatrixScores

      public void exportRiskMatrixScores(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of risk matrix scores.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of risk types returned
      sOrderBy - an optional order by clause for ordering the set of risk types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRiskMatrixThresholds

      public void exportRiskMatrixThresholds(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of risk matrix thresholds.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of risk types returned
      sOrderBy - an optional order by clause for ordering the set of risk types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRisks

      public void exportRisks(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of risks.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of risk types returned
      sOrderBy - an optional order by clause for ordering the set of risk types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRiskImpacts

      public void exportRiskImpacts(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of risk impacts.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of risk types returned
      sOrderBy - an optional order by clause for ordering the set of risk types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRiskResponsePlans

      public void exportRiskResponsePlans(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of risk response plans.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of risk types returned
      sOrderBy - an optional order by clause for ordering the set of risk types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRiskResponseActions

      public void exportRiskResponseActions(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of risk response actions.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of risk types returned
      sOrderBy - an optional order by clause for ordering the set of risk types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRiskResponseActionImpacts

      public void exportRiskResponseActionImpacts(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of risk response action impacts.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of risk types returned
      sOrderBy - an optional order by clause for ordering the set of risk types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRoleCodeAssignments

      public void exportRoleCodeAssignments(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of role code assignments.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of role code assignments returned
      sOrderBy - an optional order by clause for ordering the set of role code assignments returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRolceCodes

      public void exportRolceCodes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of role codes.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of role codes returned
      sOrderBy - an optional order by clause for ordering the set of role codes returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRoleCodeTypes

      public void exportRoleCodeTypes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of role code types.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of role code types returned
      sOrderBy - an optional order by clause for ordering the set of role code types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRoleLimits

      public void exportRoleLimits(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of role limits.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of role limits returned
      sOrderBy - an optional order by clause for ordering the set of role limits returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRoleRates

      public void exportRoleRates(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of role rates.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of role rates returned
      sOrderBy - an optional order by clause for ordering the set of role rates returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRoles

      public void exportRoles(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of roles.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of roles returned
      sOrderBy - an optional order by clause for ordering the set of roles returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportRoleTeams

      public void exportRoleTeams(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of role teams.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of role teams returned
      sOrderBy - an optional order by clause for ordering the set of role teams returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportScheduleOptions

      public void exportScheduleOptions(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export the schedule options for the current user.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of schedule options returned
      sOrderBy - an optional order by clause for ordering the set of schedule options returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportShifts

      public void exportShifts(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of shifts. All associated ShiftPeriods for each Shift are exported as well.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of shifts returned
      sOrderBy - an optional order by clause for ordering the set of shifts returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportThresholdParameters

      public void exportThresholdParameters(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of threshold parameters.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of threshold parameters returned
      sOrderBy - an optional order by clause for ordering the set of threshold parameters returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportTimesheets

      public void exportTimesheets(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of timesheets. All associated ResourceHours for each timesheet are exported as well.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of timesheets returned
      sOrderBy - an optional order by clause for ordering the set of timesheets returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportTimesheetAudits

      public void exportTimesheetAudits(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of timesheet audits.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of timesheet audits returned
      sOrderBy - an optional order by clause for ordering the set of timesheet audits returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportTimesheetDelegates

      public void exportTimesheetDelegates(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of timesheet delegates.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of timesheet delegates returned
      sOrderBy - an optional order by clause for ordering the set of timesheet delegates returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportTimesheetPeriods

      public void exportTimesheetPeriods(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of timesheet periods.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of timesheet periods returned
      sOrderBy - an optional order by clause for ordering the set of timesheet periods returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportUDFCodes

      public void exportUDFCodes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of UDF codes.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of UDF codes returned
      sOrderBy - an optional order by clause for ordering the set of UDF codes returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportUDFTypes

      public void exportUDFTypes(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of UDF types.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of UDF types returned
      sOrderBy - an optional order by clause for ordering the set of UDF types returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportUDFValues

      public void exportUDFValues(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of UDF values.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of UDF values returned
      sOrderBy - an optional order by clause for ordering the set of UDF values returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportUnitOfMeasures

      public void exportUnitOfMeasures(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of units of measure.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of units of measure returned
      sOrderBy - an optional order by clause for ordering the set of units of measure returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportUsers

      public void exportUsers(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of users.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of users returned
      sOrderBy - an optional order by clause for ordering the set of users returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportUserFieldTitles

      public void exportUserFieldTitles(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of user field titles.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of user field titles returned
      sOrderBy - an optional order by clause for ordering the set of user field titles returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportUserLicenses

      public void exportUserLicenses(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of user licenses.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of user licenses returned
      sOrderBy - an optional order by clause for ordering the set of user licenses returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportUserOBS

      public void exportUserOBS(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of user OBS objects.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of user OBS objects returned
      sOrderBy - an optional order by clause for ordering the set of user OBS objects returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportWBS

      public void exportWBS(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of WBS objects.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of WBS objects returned
      sOrderBy - an optional order by clause for ordering the set of WBS objects returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportWBSWithSummarizedSpread

      public void exportWBSWithSummarizedSpread(OutputStream os, Project parent, String[] fields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of WBS objects for a particular project with summarized spread data.
      Parameters:
      os - the OutputStream to receive all generated XML output
      parent - the parent project
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of WBS objects returned
      sOrderBy - an optional order by clause for ordering the set of WBS objects returned
      spreadFields - the fields to include in the spread object
      periodType - the period of the spread data (hour, day, etc.)
      startDate - the start date of the spread
      endDate - the end date of the spread
      bIncludeCumulative - indicates whether to include cumulative spread data
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportWBSCategories

      public void exportWBSCategories(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of WBS categories.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of WBS categories returned
      sOrderBy - an optional order by clause for ordering the set of WBS categories returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportWBSMilestones

      public void exportWBSMilestones(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of WBS milestones.
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of WBS milestones returned
      sOrderBy - an optional order by clause for ordering the set of WBS milestones returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • exportUserInterfaceViews

      public void exportUserInterfaceViews(OutputStream os, String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Export a collection of user interface views
      Parameters:
      os - the OutputStream to receive all generated XML output
      fields - the fields to export. If null, all fields are exported.
      sWhereClause - an optional where clause used to limit the set of user interface views returned
      sOrderBy - an optional order by clause for ordering the set of user interface views returned
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setLogFile

      public void setLogFile(String sLogFilePath)
      Sets the output file path for import log
      Parameters:
      sLogFilePath - the log file path, if not set, or set to null or empty, then use import file name appended with ".log" as log file name
    • getLogFile

      public String getLogFile()
      Gets the output file path for import log
      Returns:
      the current import log file path
    • addLogHandler

      public void addLogHandler(Handler handler)
      Add a log handler
      Parameters:
      handler -
    • removeLogHandler

      public void removeLogHandler(Handler handler)