Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
joniles committed Oct 14, 2024
1 parent 07bc191 commit b471a0c
Show file tree
Hide file tree
Showing 34 changed files with 3,361 additions and 2,399 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Changelog

## 13.4.3 (unreleased)
## 13.5.0 (unreleased)
* Added support for reading and writing Resource Role Assignments for Primavera schedules. The `Resource.getRoleAssignments()` method retrieves a map representing the roles a resource is assigned to, along with the skill level for each assignment. The `Resource.addRoleAssignment()` and `Resource.removeRoleAssignment()` methods allow role assignments to be added and removed.
* Added support for the Resource Primary Role attribute, which is read from and written to Primavera schedules.

## 13.4.2 (2024-10-08)
* Added the `ProjectCalendarDays.getCalendarHours()` method to allow direct access to the `ProjectCalendarHours` instances for each day of the week.
Expand Down
14 changes: 9 additions & 5 deletions docs/CHANGELOG/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,9 +291,9 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1343-unreleased" class="md-nav__link">
<a href="#1350-unreleased" class="md-nav__link">
<span class="md-ellipsis">
13.4.3 (unreleased)
13.5.0 (unreleased)
</span>
</a>

Expand Down Expand Up @@ -3966,9 +3966,9 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#1343-unreleased" class="md-nav__link">
<a href="#1350-unreleased" class="md-nav__link">
<span class="md-ellipsis">
13.4.3 (unreleased)
13.5.0 (unreleased)
</span>
</a>

Expand Down Expand Up @@ -6285,7 +6285,11 @@


<h1 id="changelog">Changelog</h1>
<h2 id="1343-unreleased">13.4.3 (unreleased)</h2>
<h2 id="1350-unreleased">13.5.0 (unreleased)</h2>
<ul>
<li>Added support for reading and writing Resource Role Assignments for Primavera schedules. The <code>Resource.getRoleAssignments()</code> method retrieves a map representing the roles a resource is assigned to, along with the skill level for each assignment. The <code>Resource.addRoleAssignment()</code> and <code>Resource.removeRoleAssignment()</code> methods allow role assignments to be added and removed.</li>
<li>Added support for the Resource Primary Role attribute, which is read from and written to Primavera schedules.</li>
</ul>
<h2 id="1342-2024-10-08">13.4.2 (2024-10-08)</h2>
<ul>
<li>Added the <code>ProjectCalendarDays.getCalendarHours()</code> method to allow direct access to the <code>ProjectCalendarHours</code> instances for each day of the week.</li>
Expand Down
1 change: 1 addition & 0 deletions docs/apidocs/allclasses-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -767,6 +767,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/primavera/schema/ShiftPeriodType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">ShiftPeriodType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ShiftType.html" title="class in net.sf.mpxj.primavera.schema" target="classFrame">ShiftType</a></li>
<li><a href="net/sf/mpxj/primavera/common/ShortColumn.html" title="class in net.sf.mpxj.primavera.common" target="classFrame">ShortColumn</a></li>
<li><a href="net/sf/mpxj/SkillLevel.html" title="enum in net.sf.mpxj" target="classFrame">SkillLevel</a></li>
<li><a href="net/sf/mpxj/phoenix/SkipNulInputStream.html" title="class in net.sf.mpxj.phoenix" target="classFrame">SkipNulInputStream</a></li>
<li><a href="net/sf/mpxj/common/SlackHelper.html" title="class in net.sf.mpxj.common" target="classFrame">SlackHelper</a></li>
<li><a href="net/sf/mpxj/common/SplitTaskFactory.html" title="class in net.sf.mpxj.common" target="classFrame">SplitTaskFactory</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/apidocs/allclasses-noframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -767,6 +767,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="net/sf/mpxj/primavera/schema/ShiftPeriodType.html" title="class in net.sf.mpxj.primavera.schema">ShiftPeriodType</a></li>
<li><a href="net/sf/mpxj/primavera/schema/ShiftType.html" title="class in net.sf.mpxj.primavera.schema">ShiftType</a></li>
<li><a href="net/sf/mpxj/primavera/common/ShortColumn.html" title="class in net.sf.mpxj.primavera.common">ShortColumn</a></li>
<li><a href="net/sf/mpxj/SkillLevel.html" title="enum in net.sf.mpxj">SkillLevel</a></li>
<li><a href="net/sf/mpxj/phoenix/SkipNulInputStream.html" title="class in net.sf.mpxj.phoenix">SkipNulInputStream</a></li>
<li><a href="net/sf/mpxj/common/SlackHelper.html" title="class in net.sf.mpxj.common">SlackHelper</a></li>
<li><a href="net/sf/mpxj/common/SplitTaskFactory.html" title="class in net.sf.mpxj.common">SplitTaskFactory</a></li>
Expand Down
44 changes: 44 additions & 0 deletions docs/apidocs/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -1549,6 +1549,10 @@ <h2 class="title">A</h2>
<dd>
<div class="block">Add an address line.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Resource.html#addRoleAssignment-net.sf.mpxj.Resource-net.sf.mpxj.SkillLevel-">addRoleAssignment(Resource, SkillLevel)</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Resource.html" title="class in net.sf.mpxj">Resource</a></dt>
<dd>
<div class="block">Add a role assignment, and a skill level for the role, to this resource.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/primavera/schema/GlobalPrivilegesType.html#addRoleCodes">addRoleCodes</a></span> - Variable in class net.sf.mpxj.primavera.schema.<a href="net/sf/mpxj/primavera/schema/GlobalPrivilegesType.html" title="class in net.sf.mpxj.primavera.schema">GlobalPrivilegesType</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/primavera/common/Table.html#addRow-java.lang.String-java.util.Map-">addRow(String, Map&lt;String, Object&gt;)</a></span> - Method in class net.sf.mpxj.primavera.common.<a href="net/sf/mpxj/primavera/common/Table.html" title="class in net.sf.mpxj.primavera.common">Table</a></dt>
Expand Down Expand Up @@ -26583,6 +26587,10 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Gets the value of the primaryResourceObjectId property.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Resource.html#getPrimaryRole--">getPrimaryRole()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Resource.html" title="class in net.sf.mpxj">Resource</a></dt>
<dd>
<div class="block">Retrieves the primary role.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/primavera/schema/ResourceType.html#getPrimaryRoleId--">getPrimaryRoleId()</a></span> - Method in class net.sf.mpxj.primavera.schema.<a href="net/sf/mpxj/primavera/schema/ResourceType.html" title="class in net.sf.mpxj.primavera.schema">ResourceType</a></dt>
<dd>
<div class="block">Gets the value of the primaryRoleId property.</div>
Expand All @@ -26595,6 +26603,10 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Gets the value of the primaryRoleObjectId property.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Resource.html#getPrimaryRoleUniqueID--">getPrimaryRoleUniqueID()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Resource.html" title="class in net.sf.mpxj">Resource</a></dt>
<dd>
<div class="block">Retrieves the primary role unique ID.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/conceptdraw/schema/TimeScale.html#getPrimaryUnits--">getPrimaryUnits()</a></span> - Method in class net.sf.mpxj.conceptdraw.schema.<a href="net/sf/mpxj/conceptdraw/schema/TimeScale.html" title="class in net.sf.mpxj.conceptdraw.schema">TimeScale</a></dt>
<dd>
<div class="block">Gets the value of the primaryUnits property.</div>
Expand Down Expand Up @@ -29617,6 +29629,10 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Retrieve the role in which this resource assignment is being performed.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Resource.html#getRoleAssignments--">getRoleAssignments()</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Resource.html" title="class in net.sf.mpxj">Resource</a></dt>
<dd>
<div class="block">Retrieve a map of the roles assigned to this resource.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/primavera/schema/APIBusinessObjects.html#getRoleCode--">getRoleCode()</a></span> - Method in class net.sf.mpxj.primavera.schema.<a href="net/sf/mpxj/primavera/schema/APIBusinessObjects.html" title="class in net.sf.mpxj.primavera.schema">APIBusinessObjects</a></dt>
<dd>
<div class="block">Gets the value of the roleCode property.</div>
Expand Down Expand Up @@ -29749,6 +29765,8 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Gets the value of the rolesetName property.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/primavera/PrimaveraXERFileWriter.html#getRoleShortName-net.sf.mpxj.Resource-">getRoleShortName(Resource)</a></span> - Static method in class net.sf.mpxj.primavera.<a href="net/sf/mpxj/primavera/PrimaveraXERFileWriter.html" title="class in net.sf.mpxj.primavera">PrimaveraXERFileWriter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/primavera/schema/ResourceAssignmentType.html#getRoleShortName--">getRoleShortName()</a></span> - Method in class net.sf.mpxj.primavera.schema.<a href="net/sf/mpxj/primavera/schema/ResourceAssignmentType.html" title="class in net.sf.mpxj.primavera.schema">ResourceAssignmentType</a></dt>
<dd>
<div class="block">Gets the value of the roleShortName property.</div>
Expand Down Expand Up @@ -47238,6 +47256,10 @@ <h2 class="title">R</h2>
<dd>
<div class="block">This method is used to remove a resource from the project.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Resource.html#removeRoleAssignment-net.sf.mpxj.Resource-">removeRoleAssignment(Resource)</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Resource.html" title="class in net.sf.mpxj">Resource</a></dt>
<dd>
<div class="block">Remove a role assignment from this resource.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/ProjectFile.html#removeTask-net.sf.mpxj.Task-">removeTask(Task)</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/ProjectFile.html" title="class in net.sf.mpxj">ProjectFile</a></dt>
<dd>
<div class="block">This method is used to remove a task from the project.</div>
Expand Down Expand Up @@ -65018,6 +65040,10 @@ <h2 class="title">S</h2>
<dd>
<div class="block">Sets the value of the primaryResourcesCanUpdateActivityDates property.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Resource.html#setPrimaryRole-net.sf.mpxj.Resource-">setPrimaryRole(Resource)</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Resource.html" title="class in net.sf.mpxj">Resource</a></dt>
<dd>
<div class="block">Sets the primary role.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/primavera/schema/ResourceType.html#setPrimaryRoleId-java.lang.String-">setPrimaryRoleId(String)</a></span> - Method in class net.sf.mpxj.primavera.schema.<a href="net/sf/mpxj/primavera/schema/ResourceType.html" title="class in net.sf.mpxj.primavera.schema">ResourceType</a></dt>
<dd>
<div class="block">Sets the value of the primaryRoleId property.</div>
Expand All @@ -65030,6 +65056,10 @@ <h2 class="title">S</h2>
<dd>
<div class="block">Sets the value of the primaryRoleObjectId property.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/Resource.html#setPrimaryRoleUniqueID-java.lang.Integer-">setPrimaryRoleUniqueID(Integer)</a></span> - Method in class net.sf.mpxj.<a href="net/sf/mpxj/Resource.html" title="class in net.sf.mpxj">Resource</a></dt>
<dd>
<div class="block">Sets the primary role unique ID.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/conceptdraw/schema/TimeScale.html#setPrimaryUnits-java.lang.Integer-">setPrimaryUnits(Integer)</a></span> - Method in class net.sf.mpxj.conceptdraw.schema.<a href="net/sf/mpxj/conceptdraw/schema/TimeScale.html" title="class in net.sf.mpxj.conceptdraw.schema">TimeScale</a></dt>
<dd>
<div class="block">Sets the value of the primaryUnits property.</div>
Expand Down Expand Up @@ -73983,6 +74013,11 @@ <h2 class="title">S</h2>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/conceptdraw/schema/Callouts.Callout.html#sizeDY">sizeDY</a></span> - Variable in class net.sf.mpxj.conceptdraw.schema.<a href="net/sf/mpxj/conceptdraw/schema/Callouts.Callout.html" title="class in net.sf.mpxj.conceptdraw.schema">Callouts.Callout</a></dt>
<dd>&nbsp;</dd>
<dt><a href="net/sf/mpxj/SkillLevel.html" title="enum in net.sf.mpxj"><span class="typeNameLink">SkillLevel</span></a> - Enum in <a href="net/sf/mpxj/package-summary.html">net.sf.mpxj</a></dt>
<dd>
<div class="block">Represents the skill level of a resource
when assigned to a role.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/common/FixedLengthInputStream.html#skip-long-">skip(long)</a></span> - Method in class net.sf.mpxj.common.<a href="net/sf/mpxj/common/FixedLengthInputStream.html" title="class in net.sf.mpxj.common">FixedLengthInputStream</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/common/InputStreamHelper.html#skip-java.io.InputStream-long-">skip(InputStream, long)</a></span> - Static method in class net.sf.mpxj.common.<a href="net/sf/mpxj/common/InputStreamHelper.html" title="class in net.sf.mpxj.common">InputStreamHelper</a></dt>
Expand Down Expand Up @@ -77775,6 +77810,10 @@ <h2 class="title">V</h2>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/SkillLevel.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum net.sf.mpxj.<a href="net/sf/mpxj/SkillLevel.html" title="enum in net.sf.mpxj">SkillLevel</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/TaskField.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum net.sf.mpxj.<a href="net/sf/mpxj/TaskField.html" title="enum in net.sf.mpxj">TaskField</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
Expand Down Expand Up @@ -78062,6 +78101,11 @@ <h2 class="title">V</h2>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/SkillLevel.html#values--">values()</a></span> - Static method in enum net.sf.mpxj.<a href="net/sf/mpxj/SkillLevel.html" title="enum in net.sf.mpxj">SkillLevel</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</dd>
<dt><span class="memberNameLink"><a href="net/sf/mpxj/TaskField.html#values--">values()</a></span> - Static method in enum net.sf.mpxj.<a href="net/sf/mpxj/TaskField.html" title="enum in net.sf.mpxj">TaskField</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
Expand Down
Loading

0 comments on commit b471a0c

Please sign in to comment.