com.plumtree.uiinfrastructure.errordisplay
Class ErrorModel

java.lang.Object
  com.plumtree.uiinfrastructure.errordisplay.AErrorModel
      com.plumtree.uiinfrastructure.errordisplay.ErrorModel

All Implemented Interfaces:

IManagedObject, IModel, IModelRO, IMVCObject, IErrorModelRO

Direct Known Subclasses:

SinglePageErrorModel

public class ErrorModel
extends AErrorModel

Author:

Ben Geislinger This concrete model extends AErrorModel, and provides basic functionality for displaying error messages.

This model makes use of the base UIErrorHandler class. This class can not make use of any plumtree-specific functionality, and for this reason, this error model class is somewhat limited. Portal display pages should use instead the PTErrorModel class found in the portalinfrastructure package.

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME

Fields inherited from class com.plumtree.uiinfrastructure.errordisplay.AErrorModel

m_asOwner

Constructor Summary

ErrorModel()

Method Summary

void	ClearError(java.lang.String sKey, ISessionManager mySessionManager, IApplication myApplication) Implement to remove the specified error.
void	ClearErrors(ISessionManager mySessionManager, IApplication myApplication) Implement to remove all errors available to the current user.
void	ClearErrorsForASChange(java.lang.String sASName, ISessionManager mySessionManager, IApplication myApplication) Implement to clear those errors that need to be cleared when the user changes activity space.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
boolean	GetDisplaySeparatePageErrors() Returns false.
IXPEnumerator	GetErrors(ISessionManager session, IApplication myApplication, AActivitySpace activitySpace, boolean bGetErrorsAssociatedWithAnAS) Implement to obtain an enumeration of errors appropriate for the current user.
boolean	GetErrorsAssociatedWithAnAS() Returns true.
java.lang.String	GetName() Return the name of the MVC object.
void	Init(AActivitySpace parent) Inits the Model with the Activity Space.

Methods inherited from class com.plumtree.uiinfrastructure.errordisplay.AErrorModel

CleanupAllData, CleanupTempData, ClearError, ClearErrors, GetErrors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

ErrorModel

public ErrorModel()

Method Detail

ClearError

public void ClearError(java.lang.String sKey,
                       ISessionManager mySessionManager,
                       IApplication myApplication)

Description copied from class: AErrorModel

Implement to remove the specified error. Concrete implementations should differ to the UIErrorHandler class, or one of its subclasses.

Specified by:

ClearError in class AErrorModel

Parameters:

sKey - String key used to store the error to be removed.

mySessionManager - ISessionManager

myApplication - IApplication

See Also:

com.plumtree.uiinfrastructure.errordisplay.AErrorModel#ClearError()

ClearErrors

public void ClearErrors(ISessionManager mySessionManager,
                        IApplication myApplication)

Description copied from class: AErrorModel

Implement to remove all errors available to the current user. Concrete implementations should differ to the UIErrorHandler class, or one of its subclasses.

Specified by:

ClearErrors in class AErrorModel

Parameters:

mySessionManager - ISessionManager

myApplication - IApplication

See Also:

AErrorModel.ClearErrors()

ClearErrorsForASChange

public void ClearErrorsForASChange(java.lang.String sASName,
                                   ISessionManager mySessionManager,
                                   IApplication myApplication)

Description copied from class: AErrorModel

Implement to clear those errors that need to be cleared when the user changes activity space. Concrete implementations should differ to the UIErrorHandler class, or one of its subclasses.

Specified by:

ClearErrorsForASChange in class AErrorModel

Parameters:

sASName - String name of the new activity space.

mySessionManager - ISessionManager

myApplication - IApplication

See Also:

com.plumtree.uiinfrastructure.errordisplay.AErrorModel#ClearErrorsForASChange()

Create

public java.lang.Object Create()

Description copied from class: AErrorModel

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Specified by:

Create in class AErrorModel

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

GetDisplaySeparatePageErrors

public boolean GetDisplaySeparatePageErrors()

Returns false. Only errors not requiring a spearate page will be displayed. This fact makes this model suitable for MVCs embedded within other display pages.

Specified by:

GetDisplaySeparatePageErrors in interface IErrorModelRO

Specified by:

GetDisplaySeparatePageErrors in class AErrorModel

Returns:

boolean false

GetErrors

public IXPEnumerator GetErrors(ISessionManager session,
                               IApplication myApplication,
                               AActivitySpace activitySpace,
                               boolean bGetErrorsAssociatedWithAnAS)

Description copied from class: AErrorModel

Implement to obtain an enumeration of errors appropriate for the current user. Concrete implementations should differ to the UIErrorHandler class, or one of its subclasses.

Specified by:

GetErrors in class AErrorModel

Parameters:

session - ISessionManager

myApplication - IApplication

bGetErrorsAssociatedWithAnAS - boolean value

Returns:

IXPEnumerator of UIError objects

See Also:

AErrorModel.GetErrors()

GetErrorsAssociatedWithAnAS

public boolean GetErrorsAssociatedWithAnAS()

Returns true. Only errors associated with the current activity space will be returned by the GetErrors methods.

Specified by:

GetErrorsAssociatedWithAnAS in interface IErrorModelRO

Specified by:

GetErrorsAssociatedWithAnAS in class AErrorModel

Returns:

boolean true

GetName

public java.lang.String GetName()

Description copied from class: AErrorModel

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class AErrorModel

Returns:

the name of the object.

See Also:

com.plumtree.xpshared.activityspace.IModel#GetName()

Init

public void Init(AActivitySpace parent)

Inits the Model with the Activity Space.

Specified by:

Init in interface IModel

Specified by:

Init in class AErrorModel

Parameters:

parent -