Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class Methodology

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.object.Methodology

public class Methodology
extends BusinessObject

Methodologies are stored in the Methodology Manager database and are used with the Project Architect job service.

See Also:   Quick reference of Methodology fields


Constructor Summary
Methodology(Session session)
          Class constructor specifying the Session.
Methodology(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
Methodology(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
static java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getName()
          Gets the name of the Methodology.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 MethodologyType getType()
          Gets the type of the Methodology, one of 'Base', 'Plug-In', or 'Activity Library'.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static Methodology load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single Methodology object from the database.
static BOIterator<Methodology> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple Methodology objects from the database.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull, setObjectId
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Methodology

public Methodology(Session session)
Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.

Parameters:
session - the Session

Methodology

public Methodology(Session session,
                   ObjectId objId)
            throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object.

Parameters:
session - the Session
objId - the ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

Methodology

public Methodology(Session session,
                   com.primavera.infr.db.PrmRowSet rowSet,
                   int iIndex)
            throws BusinessObjectException
Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.

Parameters:
session - the Session
rowSet - the PrmRowSet retrieved from the server
iIndex - the row index in the PrmRowSet associated with this business object
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
Method Detail

load

public static Methodology load(Session session,
                               java.lang.String[] fields,
                               ObjectId objId)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Loads a single Methodology object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the Methodology object
Returns:
Methodology the Methodology object
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

load

public static BOIterator<Methodology> load(Session session,
                                           java.lang.String[] fields,
                                           ObjectId[] objIds)
                                    throws ServerException,
                                           NetworkException,
                                           BusinessObjectException
Loads multiple Methodology objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the Methodology objects
Returns:
BOIterator a business object iterator used to get the results of the load request
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

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the Methodology. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field Name
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getType

public MethodologyType getType()
                        throws BusinessObjectException
Gets the type of the Methodology, one of 'Base', 'Plug-In', or 'Activity Library'. Only 'Base' or 'Plug-In' may be used with Project Architect. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field Type
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getFilterableFields

public static java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.String[] getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:
String[] an array of exported fields

toString

public java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

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