wt.vc.sessioniteration
Class StandardSessionIterationService

java.lang.Object
  wt.services.StandardManager
      wt.vc.sessioniteration.StandardSessionIterationService

All Implemented Interfaces:

Manager, NetFactor, Serializable, SessionIterationServerService, SessionIterationService

public class StandardSessionIterationService

extends StandardManager

implements SessionIterationService, SessionIterationServerService, Serializable

Use the newStandardSessionIterationService static factory method(s), not the StandardSessionIterationService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private static Boolean	NULL
private static String	RESOURCE
private static String	SESSION_DELETE_KEY
private static String	SESSION_ITERATION_DOMAIN_PATH
private static String	SESSIONITERATION_KEY

Fields inherited from class wt.services.StandardManager

Fields inherited from interface wt.services.Manager

MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE

Constructor Summary

StandardSessionIterationService()

Method Summary

SessionEditedIteration	commitSessionIteration(SessionEditedIteration sessionIteration, String comment) Commits the session iteration.
SessionEditedIteration	createSessionIteration(SessionEditedIteration iteration, WTPrincipal principal, String comment) Creates a session iteration for the specified principal from the given iteration.
SessionEditedIteration	deleteSessionIteration(SessionEditedIteration sessionIteration) Deletes the session iteration.
String	getConceptualClassname() Deprecated.
SessionEditedIteration	getSessionIteration(SessionEditedIteration iteration, WTPrincipal principal) Returns a session iteration for the principal specified (or the current principal if null is passed in) -- if one exists -- that was created from the iteration provided.
QueryResult	getSessionIterations(SessionEditedIteration iteration) Supported API: false
static StandardSessionIterationService	newStandardSessionIterationService() Default factory for the class.
protected void	performStartupProcess() Dummy method to be overridden by subclasses.
void	registerEvents(ManagerService managerService) Register events with the passed ManagerService.
void	validateCommitSessionIteration(SessionEditedIteration sessionIteration) Returns true if the session iteration can be commited.
void	validateCreateSessionIteration(SessionEditedIteration iteration, WTPrincipal principal) Returns true if the principal can create a session iteration from the specified iteration.
void	validateDeleteSessionIteration(SessionEditedIteration sessionIteration) Validates that the session iteration can be deleted.

Methods inherited from class wt.services.StandardManager

emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

SESSION_ITERATION_DOMAIN_PATH

private static final String SESSION_ITERATION_DOMAIN_PATH

See Also:

Constant Field Values

SESSION_DELETE_KEY

private static final String SESSION_DELETE_KEY

See Also:

Constant Field Values

NULL

private static final Boolean NULL

SESSIONITERATION_KEY

private static String SESSIONITERATION_KEY

Constructor Detail

StandardSessionIterationService

public StandardSessionIterationService()

Method Detail

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Overrides:

getConceptualClassname in class StandardManager

Returns:

String

registerEvents

public void registerEvents(ManagerService managerService)

Register events with the passed ManagerService. The default method does nothing, subclasses should provide an overriding implementation.

Supported API: false

Specified by:

registerEvents in interface Manager

Overrides:

registerEvents in class StandardManager

Parameters:

managerService - the ManagerService with which to register events.

performStartupProcess

protected void performStartupProcess()
                              throws ManagerException

Dummy method to be overridden by subclasses. Subclasses should override this method and provide startup processing.

Supported API: false

Overrides:

performStartupProcess in class StandardManager

Throws:

ManagerException

newStandardSessionIterationService

public static StandardSessionIterationService newStandardSessionIterationService()
                                                                          throws WTException

Default factory for the class.

Supported API: false

Returns:

StandardSessionIterationService

Throws:

WTException

getSessionIteration

public SessionEditedIteration getSessionIteration(SessionEditedIteration iteration,
                                                  WTPrincipal principal)
                                           throws WTException

Returns a session iteration for the principal specified (or the current principal if null is passed in) -- if one exists -- that was created from the iteration provided.

Supported API: false

Specified by:

getSessionIteration in interface SessionIterationService

Parameters:

iteration -

principal -

Returns:

SessionEditedIteration

Throws:

WTException

validateCreateSessionIteration

public void validateCreateSessionIteration(SessionEditedIteration iteration,
                                           WTPrincipal principal)
                                    throws WTException

Returns true if the principal can create a session iteration from the specified iteration. Creating a session iteration is analogous to a checkout, except that the "check out" is not reserved.

Supported API: false

Specified by:

validateCreateSessionIteration in interface SessionIterationService

Parameters:

iteration -

principal -

Throws:

WTException

createSessionIteration

public SessionEditedIteration createSessionIteration(SessionEditedIteration iteration,
                                                     WTPrincipal principal,
                                                     String comment)
                                              throws WTException

Creates a session iteration for the specified principal from the given iteration. This is analogous to a check out, except that the "check out" is not reserved.

Supported API: false

Specified by:

createSessionIteration in interface SessionIterationService

Parameters:

iteration -

principal -

comment -

Returns:

SessionEditedIteration

Throws:

WTException

validateCommitSessionIteration

public void validateCommitSessionIteration(SessionEditedIteration sessionIteration)
                                    throws WTException

Returns true if the session iteration can be commited. Among the validations is a check to verify that the iteration the session iteration was created from hasn't already been superseded by another user. Committing a session iteration is analogous to a check in.

Supported API: false

Specified by:

validateCommitSessionIteration in interface SessionIterationService

Parameters:

sessionIteration -

Throws:

WTException

commitSessionIteration

public SessionEditedIteration commitSessionIteration(SessionEditedIteration sessionIteration,
                                                     String comment)
                                              throws WTException

Commits the session iteration. This is analogous to a check in.

Supported API: false

Specified by:

commitSessionIteration in interface SessionIterationService

Parameters:

sessionIteration -

comment -

Returns:

SessionEditedIteration

Throws:

WTException

validateDeleteSessionIteration

public void validateDeleteSessionIteration(SessionEditedIteration sessionIteration)
                                    throws WTException

Validates that the session iteration can be deleted. Deleting a session iteration is analogous to an undo checkout.

Supported API: false

Specified by:

validateDeleteSessionIteration in interface SessionIterationService

Parameters:

sessionIteration -

Throws:

WTException

deleteSessionIteration

public SessionEditedIteration deleteSessionIteration(SessionEditedIteration sessionIteration)
                                              throws WTException

Deletes the session iteration. This is analogous to an undo checkout.

Supported API: false

Specified by:

deleteSessionIteration in interface SessionIterationService

Parameters:

sessionIteration -

Returns:

SessionEditedIteration

Throws:

WTException

getSessionIterations

public QueryResult getSessionIterations(SessionEditedIteration iteration)
                                 throws WTException

Supported API: false

Specified by:

getSessionIterations in interface SessionIterationServerService

Parameters:

iteration -

Returns:

QueryResult

Throws:

WTException