Primavera Integration API 7.0

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

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.ProjectNote

public class ProjectNote
extends BusinessObject

Project notes are used as a way of specifying one or more notes on a project or WBS element. You may specify one note on each project or WBS for every notebook topic that exists.

Notes are set and retrieved as HTML using the getNote() and setNote() methods. To retrieve the note without HTML, use getRawTextNote().

See Also:   Quick reference of ProjectNote fields


Constructor Summary
ProjectNote(Session session)
          Class constructor specifying the Session.
ProjectNote(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ProjectNote(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId create()
          Creates this ProjectNote object in the database.
static ObjectId[] create(Session session, ProjectNote[] projectnotes)
          Creates multiple ProjectNote objects in the database.
 void delete()
          Deletes this ProjectNote object from the database.
static void delete(Session session, ProjectNote[] projectnotes)
          Deletes multiple ProjectNote objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 boolean getAvailableForActivity()
          Gets the flag indicating whether this note is available for Activity objects.
 boolean getAvailableForEPS()
          Gets the flag indicating whether this note is available for EPS objects.
 boolean getAvailableForProject()
          Gets the flag indicating whether this note is available for Project objects.
 boolean getAvailableForWBS()
          Gets the flag indicating whether this note is available for WBS objects.
 java.util.Date getCreateDate()
          Gets the date this note was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this note.
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.
 boolean getIsBaseline()
          Gets the boolean value indicating if this business object is related to a Project or Baseline.
 java.util.Date getLastUpdateDate()
          Gets the date this note was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this note.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getNote()
          Gets the information that is associated with the notebook topic.
 java.lang.String getNotebookTopicName()
          Gets the name of the associated notebook topic.
 ObjectId getNotebookTopicObjectId()
          Gets the unique ID of the associated notebook topic.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 java.lang.String getProjectId()
          Gets the short code that uniquely identifies the project associated with this note.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
 java.lang.String getRawTextNote()
          Gets the information that is associated with the notebook topic, without any HTML.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 java.lang.String getWBSCode()
          Gets the short code assigned to each WBS element for identification.
 java.lang.String getWBSName()
          Gets the name of the WBS element associated with this note.
 ObjectId getWBSObjectId()
          Gets the unique ID of the associated WBS.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ProjectNote load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ProjectNote object from the database.
static BOIterator<ProjectNote> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ProjectNote objects from the database.
 NotebookTopic loadNotebookTopic(java.lang.String[] fields)
          Loads an associated NotebookTopic object from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 WBS loadWBS(java.lang.String[] fields)
          Loads an associated WBS object from the database.
 void setNote(java.lang.String s)
          Sets the information that is associated with the notebook topic.
 void setNotebookTopicObjectId(ObjectId o)
          Sets the unique ID of the associated notebook topic.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setProjectObjectId(ObjectId o)
          Sets the unique ID of the associated project.
 void setWBSObjectId(ObjectId o)
          Sets the unique ID of the associated WBS.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this ProjectNote object in the database.
static void update(Session session, ProjectNote[] projectnotes)
          Updates multiple ProjectNote objects in the database.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProjectNote

public ProjectNote(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

ProjectNote

public ProjectNote(Session session,
                   ObjectId objId)
            throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.

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

ProjectNote

public ProjectNote(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

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this ProjectNote object in the database.

Returns:
ObjectId the unique ID of the newly created ProjectNote 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

create

public static ObjectId[] create(Session session,
                                ProjectNote[] projectnotes)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple ProjectNote objects in the database.

Parameters:
session - the Session object
projectnotes - array of ProjectNote objects to create
Returns:
ObjectId[] the array of unique IDs of newly created ProjectNote objects
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 ProjectNote load(Session session,
                               java.lang.String[] fields,
                               ObjectId objId)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Loads a single ProjectNote object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the ProjectNote object
Returns:
ProjectNote the ProjectNote 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<ProjectNote> load(Session session,
                                           java.lang.String[] fields,
                                           ObjectId[] objIds)
                                    throws ServerException,
                                           NetworkException,
                                           BusinessObjectException
Loads multiple ProjectNote objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the ProjectNote 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

update

public void update()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Updates this ProjectNote object in the database.

Overrides:
update in class BOBase
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

update

public static void update(Session session,
                          ProjectNote[] projectnotes)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple ProjectNote objects in the database.

Parameters:
session - the Session object
projectnotes - array of ProjectNote objects to update
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

delete

public void delete()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this ProjectNote object from the database.

Overrides:
delete in class BOBase
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

delete

public static void delete(Session session,
                          ProjectNote[] projectnotes)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple ProjectNote objects from the database.

Parameters:
session - the Session object
projectnotes - array of ProjectNote objects to delete
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

loadProject

public Project loadProject(java.lang.String[] fields)
                    throws ServerException,
                           NetworkException,
                           BusinessObjectException
Loads an associated Project object from the database.

Parameters:
fields - fields to load
Returns:
Project the Project 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

loadWBS

public WBS loadWBS(java.lang.String[] fields)
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Loads an associated WBS object from the database.

Parameters:
fields - fields to load
Returns:
WBS the WBS 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

loadNotebookTopic

public NotebookTopic loadNotebookTopic(java.lang.String[] fields)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Loads an associated NotebookTopic object from the database.

Parameters:
fields - fields to load
Returns:
NotebookTopic the NotebookTopic 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

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

setObjectId

public void setObjectId(ObjectId o)
                 throws BusinessObjectException
Sets the unique ID generated by the system.

Overrides:
setObjectId in class BusinessObject
Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getProjectObjectId

public ObjectId getProjectObjectId()
                            throws BusinessObjectException
Gets the unique ID of the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setProjectObjectId

public void setProjectObjectId(ObjectId o)
                        throws BusinessObjectException
Sets the unique ID of the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getProjectId

public java.lang.String getProjectId()
                              throws BusinessObjectException
Gets the short code that uniquely identifies the project associated with this note.

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

getWBSObjectId

public ObjectId getWBSObjectId()
                        throws BusinessObjectException
Gets the unique ID of the associated WBS. This field is automatically loaded by default whenever this type of business object is loaded from the database. 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 WBSObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setWBSObjectId

public void setWBSObjectId(ObjectId o)
                    throws BusinessObjectException
Sets the unique ID of the associated WBS. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getWBSCode

public java.lang.String getWBSCode()
                            throws BusinessObjectException
Gets the short code assigned to each WBS element for identification.

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

getWBSName

public java.lang.String getWBSName()
                            throws BusinessObjectException
Gets the name of the WBS element associated with this note.

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

getNotebookTopicObjectId

public ObjectId getNotebookTopicObjectId()
                                  throws BusinessObjectException
Gets the unique ID of the associated notebook topic. This field is automatically loaded by default whenever this type of business object is loaded from the database. 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 NotebookTopicObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setNotebookTopicObjectId

public void setNotebookTopicObjectId(ObjectId o)
                              throws BusinessObjectException
Sets the unique ID of the associated notebook topic. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getNote

public java.lang.String getNote()
                         throws BusinessObjectException
Gets the information that is associated with the notebook topic. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setNote

public void setNote(java.lang.String s)
             throws BusinessObjectException
Sets the information that is associated with the notebook topic. This field may not be included in the where clause or order by clause specified when loading business objects.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRawTextNote

public java.lang.String getRawTextNote()
                                throws BusinessObjectException
Gets the information that is associated with the notebook topic, without any HTML. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getNotebookTopicName

public java.lang.String getNotebookTopicName()
                                      throws BusinessObjectException
Gets the name of the associated notebook topic.

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

getAvailableForEPS

public boolean getAvailableForEPS()
                           throws BusinessObjectException
Gets the flag indicating whether this note is available for EPS objects.

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

getAvailableForProject

public boolean getAvailableForProject()
                               throws BusinessObjectException
Gets the flag indicating whether this note is available for Project objects.

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

getAvailableForWBS

public boolean getAvailableForWBS()
                           throws BusinessObjectException
Gets the flag indicating whether this note is available for WBS objects.

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

getAvailableForActivity

public boolean getAvailableForActivity()
                                throws BusinessObjectException
Gets the flag indicating whether this note is available for Activity objects.

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

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this note was created.

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

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws BusinessObjectException
Gets the date this note was last updated.

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

getCreateUser

public java.lang.String getCreateUser()
                               throws BusinessObjectException
Gets the name of the user that created this note.

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

getLastUpdateUser

public java.lang.String getLastUpdateUser()
                                   throws BusinessObjectException
Gets the name of the user that last updated this note.

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

getIsBaseline

public boolean getIsBaseline()
                      throws BusinessObjectException
Gets the boolean value indicating if this business object is related to a Project or Baseline.

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

getRequiredCreateFields

public static java.lang.String[] getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.

Returns:
String[] an array of required create fields

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.