|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ProjectNote
public class ProjectNote
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 |
---|
public ProjectNote(Session session)
session
- the Sessionpublic ProjectNote(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectNote(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
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 objectspublic static ObjectId[] create(Session session, ProjectNote[] projectnotes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectnotes
- array of ProjectNote objects to create
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 objectspublic static ProjectNote load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ProjectNote object
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 objectspublic static BOIterator<ProjectNote> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ProjectNote objects
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 objectspublic void update() throws ServerException, NetworkException, BusinessObjectException
update
in class BOBase
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 objectspublic static void update(Session session, ProjectNote[] projectnotes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectnotes
- array of ProjectNote objects to update
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 objectspublic void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class BOBase
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 objectspublic static void delete(Session session, ProjectNote[] projectnotes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectnotes
- array of ProjectNote objects to delete
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 objectspublic Project loadProject(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic WBS loadWBS(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic NotebookTopic loadNotebookTopic(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getWBSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setWBSObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getWBSCode() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getWBSName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getNotebookTopicObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setNotebookTopicObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getNote() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setNote(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getRawTextNote() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getNotebookTopicName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getAvailableForEPS() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getAvailableForProject() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getAvailableForWBS() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getAvailableForActivity() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static java.lang.String[] getRequiredCreateFields()
public static java.lang.String[] getFilterableFields()
public static java.lang.String[] getInternalDefaultLoadFields()
public static java.lang.String[] getAllFields()
public static java.lang.String[] getInternalAllFields()
public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
public static java.lang.String[] getWritableFields()
public static java.lang.String[] getDefaultXMLExportFields()
public static java.lang.String[] getMinimumXMLExportFields()
public java.lang.String toString()
toString
in class java.lang.Object
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |