Mailing-List: contact dev-help@myfaces.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "MyFaces Development" <dev@myfaces.apache.org>
Received-SPF: pass (athena.apache.org: domain of simon.lessard.3@gmail.com
 designates 64.233.162.237 as permitted sender)
DomainKey-Signature: a=rsa-sha1; c=nofws;
        d=gmail.com; s=beta;
        h=received:message-id:date:from:to:subject:mime-version:content-type;
        b=GxyYoAije7YxIoEc5B0He7N95vB8MQYI3gfxWuARlFQZBgN4bJIDJDdXrXK5nzNH86MJofhsoPa1Hi20g+6eida9dfUZyIesLQI44gaCGcfkdqRgqniOeC1vSO6M632mxdL2E4TvMKnLqOD5mxUWigNmzhSgJa1IEwBcCTprgrA=
Message-ID: <254acf980708101010v5132f336k95fa2844177706ef@mail.gmail.com>
Date: Fri, 10 Aug 2007 13:10:28 -0400
From: "Simon Lessard" <simon.lessard.3@gmail.com>
To: MyFaces-Devs <dev@myfaces.apache.org>
Subject: [TRINIDAD] ProcessMenuModel changes
MIME-Version: 1.0
Content-Type: multipart/alternative;
	boundary="----=_Part_164647_31618410.1186765828186"

------=_Part_164647_31618410.1186765828186
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

Hello everybody,

Currently Trinidad includes a ProcessMenuModel class that contains
undesirable methods. The complete method list (not including inherited ones)
is:

   - public boolean isImmediate()
   - public boolean isReadOnly()
   - public boolean isVisited()
   - public void clearMaxPath()
   - public void setMaxPathKey(Object maxPathKey)
   - public Object getMaxPathKey()

The methods involving maxPathKey are the ones annoying me the most. However,
as it's part of the public API we have to keep backward compatibility as
much as possible. Note also that isReadOnly should not named that way as
readOnly support was removed from process classes in favor of disabled since
a readOnly link did not make much sense.

Anyway, I would rather have the following class structure and method
signatures:

public abstract class ProcessModel

   - public abstract boolean isDisabled();
   - public abstract boolean isImmediate();
   - public abstract boolean isVisited();
   - public abstract boolean isNextStepAvailable(); /* Could be optional
   or maybe in a subclass, this would check if there's a step before the
   current one */
   - public abstract boolean isPreviousStepAvailable(); /* As above */
   - public abstract Object getNextStep(); /* As above */
   - public abstract Object getPreviousStep(); /* As above */

public class MaxPathKeyProcessModel extends ProcessModel /* Or a better name
*/

   - Implements all methods using the old ProcessMenuModel code.

@Deprecated
public class ProcessMenuModel extends MaxPathKeyProcessModel

   - Empty class except for isReadOnly() that should return
   super.isDisabled()


The structure above would clean up the Model class that really shouldn't
contain very implementation specific code like the max path key algorithm
and would allow us to add new ProcessModel classes with more
functionalities. For example I had one using a mode for step access right
like: MAX_PLUS_NEXT, MAX, ANY, NEXT_ONLY, etc.

The previous/next step methods could be useful for page templates since it
would be possible to include the train in the header as well as a previous
and next step buttons in the page footer in a generic way using the very
same process model. Note that we might have to also include methods like
isPreviousVisited(), isPreviousDisabled() and such to fully support that.

Opinions, suggestions?


Regards,

~ Simon

------=_Part_164647_31618410.1186765828186
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

Hello everybody,<br><br>Currently Trinidad includes a ProcessMenuModel class that contains undesirable methods. The complete method list (not including inherited ones) is:<br><ul><li><span style="font-family: courier new,monospace;">
public boolean isImmediate()</span></li><li><span style="font-family: courier new,monospace;">public boolean isReadOnly()</span></li><li><span style="font-family: courier new,monospace;">public boolean isVisited()</span></li>
<li><span style="font-family: courier new,monospace;">public void clearMaxPath()</span></li><li><span style="font-family: courier new,monospace;">public void setMaxPathKey(Object maxPathKey)</span></li><li><span style="font-family: courier new,monospace;">
public Object getMaxPathKey()</span></li></ul>The methods involving maxPathKey are the ones annoying me the most. However, as it&#39;s part of the public API we have to keep backward compatibility as much as possible. Note also that isReadOnly should not named that way as readOnly support was removed from process classes in favor of disabled since a readOnly link did not make much sense.
<br><br>Anyway, I would rather have the following class structure and method signatures:<br><br><span style="font-family: courier new,monospace;">public abstract class ProcessModel</span><span style="font-family: courier new,monospace;">
<br></span><ul><li><span style="font-family: courier new,monospace;">public abstract boolean isDisabled();</span></li><li><span style="font-family: courier new,monospace;">public abstract boolean isImmediate();</span></li>
<li><span style="font-family: courier new,monospace;">public abstract boolean isVisited();</span></li><li><span style="font-family: courier new,monospace;">public abstract boolean isNextStepAvailable(); /* Could be optional or maybe in a subclass, this would check if there&#39;s a step before the current one */
</span></li><li><span style="font-family: courier new,monospace;">public abstract boolean isPreviousStepAvailable(); /* As above */</span></li><li><span style="font-family: courier new,monospace;">public abstract Object getNextStep(); /* As above */
</span></li><li><span style="font-family: courier new,monospace;">public abstract Object getPreviousStep(); /* As above */</span></li></ul><span style="font-family: courier new,monospace;">public class MaxPathKeyProcessModel extends ProcessModel /* Or a better name */
<br></span><ul><li><span style="font-family: courier new,monospace;">Implements all methods using the old ProcessMenuModel code.</span></li></ul><span style="font-family: courier new,monospace;">@Deprecated<br>public class ProcessMenuModel extends MaxPathKeyProcessModel
<br></span><ul><li><span style="font-family: courier new,monospace;">Empty class except for isReadOnly() that should return super.isDisabled()</span></li></ul><br>The structure above would clean up the Model class that really shouldn&#39;t contain very implementation specific code like the max path key algorithm and would allow us to add new ProcessModel classes with more functionalities. For example I had one using a mode for step access right like: MAX_PLUS_NEXT, MAX, ANY, NEXT_ONLY, etc.
<br><br>The previous/next step methods could be useful for page templates since it would be possible to include the train in the header as well as a previous and next step buttons in the page footer in a generic way using the very same process model. Note that we might have to also include methods like isPreviousVisited(), isPreviousDisabled() and such to fully support that.
<br><br>Opinions, suggestions?<br><br><br>Regards,<br><br>~ Simon<br><br><br><br><span style="font-family: courier new,monospace;"></span>

------=_Part_164647_31618410.1186765828186--