|
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.NotebookTopic
public class NotebookTopic
Notebook topics are used to categorize notes on EPS, project, WBS, and activity objects. Notebook topics are defined globally, and are usually specified by an administrator.
See Also: Quick reference of NotebookTopic fields
Constructor Summary | |
---|---|
NotebookTopic(Session session)
Class constructor specifying the Session. |
|
NotebookTopic(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
NotebookTopic(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 NotebookTopic object in the database. |
static ObjectId[] |
create(Session session,
NotebookTopic[] notebooktopics)
Creates multiple NotebookTopic objects in the database. |
void |
delete()
Deletes this NotebookTopic object from the database. |
static void |
delete(Session session,
NotebookTopic[] notebooktopics)
Deletes multiple NotebookTopic objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
boolean |
getAvailableForActivity()
Gets the flag indicating that the topic will be available to assign to activities. |
boolean |
getAvailableForEPS()
Gets the flag indicating that the topic will be available to assign to EPS. |
boolean |
getAvailableForProject()
Gets the flag indicating that the topic will be available to assign to projects. |
boolean |
getAvailableForWBS()
Gets the flag indicating that the topic will be available to assign to WBS. |
java.util.Date |
getCreateDate()
Gets the date this notebook topic was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this notebook topic. |
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. |
java.util.Date |
getLastUpdateDate()
Gets the date this notebook topic was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this notebook topic. |
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 notebook topic. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
int |
getSequenceNumber()
Gets the sequence number for sorting. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static NotebookTopic |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single NotebookTopic object from the database. |
static BOIterator<NotebookTopic> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple NotebookTopic objects from the database. |
BOIterator<ActivityNote> |
loadActivityNotes(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ActivityNote objects from the database. |
BOIterator<EPSNote> |
loadEPSNotes(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated EPSNote objects from the database. |
BOIterator<ProjectNote> |
loadProjectNotes(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ProjectNote objects from the database. |
void |
setAvailableForActivity(boolean b)
Sets the flag indicating that the topic will be available to assign to activities. |
void |
setAvailableForEPS(boolean b)
Sets the flag indicating that the topic will be available to assign to EPS. |
void |
setAvailableForProject(boolean b)
Sets the flag indicating that the topic will be available to assign to projects. |
void |
setAvailableForWBS(boolean b)
Sets the flag indicating that the topic will be available to assign to WBS. |
void |
setName(java.lang.String s)
Sets the name of the notebook topic. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setSequenceNumber(int i)
Sets the sequence number for sorting. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this NotebookTopic object in the database. |
static void |
update(Session session,
NotebookTopic[] notebooktopics)
Updates multiple NotebookTopic 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 NotebookTopic(Session session)
session
- the Sessionpublic NotebookTopic(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic NotebookTopic(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, NotebookTopic[] notebooktopics) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectnotebooktopics
- array of NotebookTopic 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 NotebookTopic load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the NotebookTopic 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<NotebookTopic> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the NotebookTopic 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, NotebookTopic[] notebooktopics) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectnotebooktopics
- array of NotebookTopic 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, NotebookTopic[] notebooktopics) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectnotebooktopics
- array of NotebookTopic 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 BOIterator<ActivityNote> loadActivityNotes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 BOIterator<ProjectNote> loadProjectNotes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 BOIterator<EPSNote> loadEPSNotes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 java.lang.String getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(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 int getSequenceNumber() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSequenceNumber(int i) throws BusinessObjectException
i
- the value to set this field to
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 void setAvailableForEPS(boolean b) throws BusinessObjectException
b
- the value to set this field to
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 void setAvailableForProject(boolean b) throws BusinessObjectException
b
- the value to set this field to
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 void setAvailableForWBS(boolean b) throws BusinessObjectException
b
- the value to set this field to
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 void setAvailableForActivity(boolean b) throws BusinessObjectException
b
- the value to set this field to
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 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 |