wt.vc.sessioniteration
Class SessionIterationServiceFwd

java.lang.Object
  wt.vc.sessioniteration.SessionIterationServiceFwd

All Implemented Interfaces:

RemoteAccess, Serializable, SessionIterationService

public class SessionIterationServiceFwd

extends Object

implements RemoteAccess, SessionIterationService, Serializable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private static String	FC_RESOURCE
(package private) static boolean	SERVER

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary

SessionIterationServiceFwd()

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.
private static Manager	getManager()
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.
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 java.lang.Object

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

Field Detail

SERVER

static final boolean SERVER

FC_RESOURCE

private static final String FC_RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Constructor Detail

SessionIterationServiceFwd

public SessionIterationServiceFwd()

Method Detail

getManager

private static Manager getManager()
                           throws WTException

Returns:

Manager

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